com.cloudbees.plugins.credentials.builds

Class CredentialsParameterBinder

java.lang.Object

hudson.model.InvisibleAction

com.cloudbees.plugins.credentials.builds.CredentialsParameterBinder

All Implemented Interfaces:

Action, ModelObject

public final class CredentialsParameterBinder
extends InvisibleAction

Tracks credentials being bound and unbound to a build. An instance is created and attached to a build when it is first looked up via getOrCreate(Run). This binds any existing CredentialsParameterValues using the Cause.UserIdCause if available. Other plugins may bind and unbind parameters during a build.

Since:

2.3.0

Constructor Summary

Constructors

Constructor and Description
CredentialsParameterBinder()

Method Summary

Modifier and Type	Method and Description
void	bindCredentialsParameter(String userId, CredentialsParameterValue parameterValue) Binds a credentials parameter with an optional user ID.
CredentialsParameterBinding	forParameterName(String parameterName)
static CredentialsParameterBinder	getOrCreate(Run<?,?> run) Gets or creates a CredentialsParameterBinder for the given run.
void	unbindCredentialsParameter(String parameterName) Unbinds a credentials parameter.

Methods inherited from class hudson.model.InvisibleAction

getDisplayName, getIconFileName, getUrlName

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialsParameterBinder

public CredentialsParameterBinder()

Method Detail

getOrCreate

@Nonnull
public static CredentialsParameterBinder getOrCreate(@Nonnull
                                                              Run<?,?> run)

Gets or creates a CredentialsParameterBinder for the given run. This automatically imports credentials parameters provided in a ParametersAction.

bindCredentialsParameter

public void bindCredentialsParameter(@CheckForNull
                                     String userId,
                                     @Nonnull
                                     CredentialsParameterValue parameterValue)

Binds a credentials parameter with an optional user ID. User credentials require a user ID.

unbindCredentialsParameter

public void unbindCredentialsParameter(@Nonnull
                                       String parameterName)

Unbinds a credentials parameter.

forParameterName

@CheckForNull
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public CredentialsParameterBinding forParameterName(@Nonnull
                                                                                                                                          String parameterName)