Package org.jenkinsci.plugins.credentialsbinding.impl

Class UsernamePasswordMultiBinding

java.lang.Object

hudson.model.AbstractDescribableImpl<MultiBinding<C>>

org.jenkinsci.plugins.credentialsbinding.MultiBinding<com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials>

org.jenkinsci.plugins.credentialsbinding.impl.UsernamePasswordMultiBinding

All Implemented Interfaces:

ExtensionPoint, Describable<MultiBinding<com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials>>

public class UsernamePasswordMultiBinding
extends MultiBinding<com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsernamePasswordMultiBinding.DescriptorImpl

Nested classes/interfaces inherited from class org.jenkinsci.plugins.credentialsbinding.MultiBinding

MultiBinding.MultiEnvironment, MultiBinding.NullUnbinder, MultiBinding.Unbinder

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
UsernamePasswordMultiBinding(String usernameVariable, String passwordVariable, String credentialsId)

Method Summary

Modifier and Type	Method	Description
MultiBinding.MultiEnvironment	bind(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)	Sets up bindings for a build.
String	getPasswordVariable()
String	getUsernameVariable()
protected Class<com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials>	type()	Type token.
Set<String>	variables(Run<?,?> build)	Defines keys expected to be set in MultiBinding.MultiEnvironment.getSecretValues(), particularly any that might be sensitive.

Methods inherited from class org.jenkinsci.plugins.credentialsbinding.MultiBinding

getCredentials, getCredentialsId, getDescriptor, variables

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsernamePasswordMultiBinding

@DataBoundConstructor
public UsernamePasswordMultiBinding(String usernameVariable,
                                    String passwordVariable,
                                    String credentialsId)

Method Detail

getUsernameVariable

public String getUsernameVariable()

getPasswordVariable

public String getPasswordVariable()

type

protected Class<com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials> type()

Description copied from class: MultiBinding

Type token.

Specified by:

type in class MultiBinding<com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials>

bind

public MultiBinding.MultiEnvironment bind(@NonNull
                                          Run<?,?> build,
                                          @Nullable
                                          FilePath workspace,
                                          @Nullable
                                          Launcher launcher,
                                          @NonNull
                                          TaskListener listener)
                                   throws IOException,
                                          InterruptedException

Description copied from class: MultiBinding

Sets up bindings for a build.

Specified by:

bind in class MultiBinding<com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials>

Parameters:

build - The build. Cannot be null

workspace - The workspace - can be null if BindingDescriptor.requiresWorkspace() is false.

launcher - The launcher - can be null if BindingDescriptor.requiresWorkspace() is false.

listener - The task listener. Cannot be null.

Returns:

The configured MultiBinding.MultiEnvironment

Throws:

IOException

InterruptedException

variables

public Set<String> variables(@NonNull
                             Run<?,?> build)
                      throws CredentialNotFoundException

Description copied from class: MultiBinding

Defines keys expected to be set in MultiBinding.MultiEnvironment.getSecretValues(), particularly any that might be sensitive.

Overrides:

variables in class MultiBinding<com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials>

Throws:

CredentialNotFoundException