org.jenkinsci.plugins.credentialsbinding

Class Binding<C extends com.cloudbees.plugins.credentials.common.StandardCredentials>

java.lang.Object

hudson.model.AbstractDescribableImpl<Binding<C>>

org.jenkinsci.plugins.credentialsbinding.Binding<C>

Type Parameters:

C - a kind of credentials

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<Binding<C>>

Direct Known Subclasses:

FileBinding, StringBinding, UsernamePasswordBinding, ZipFileBinding

public abstract class Binding<C extends com.cloudbees.plugins.credentials.common.StandardCredentials>
extends hudson.model.AbstractDescribableImpl<Binding<C>>
implements hudson.ExtensionPoint

A way of binding a kind of credentials to an environment variable during a build.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Binding.Environment Callback for processing during a build.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Binding(String variable, String credentialsId) For use with DataBoundConstructor.

Method Summary

Methods

Modifier and Type	Method and Description
abstract Binding.Environment	bind(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) Sets up bindings for a build.
protected C	getCredentials(hudson.model.Item owner) Looks up the actual credentials.
String	getCredentialsId() Identifier of the credentials to be bound.
BindingDescriptor<C>	getDescriptor()
String	getVariable() Environment variable name.
protected abstract Class<C>	type() Type token.

Methods inherited from class java.lang.Object

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

Constructor Detail

Binding

protected Binding(String variable,
       String credentialsId)

For use with DataBoundConstructor.

Method Detail

type

protected abstract Class<C> type()

Type token.

getVariable

public String getVariable()

Environment variable name.

getCredentialsId

public String getCredentialsId()

Identifier of the credentials to be bound.

bind

public abstract Binding.Environment bind(@Nonnull
                       hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                                  throws IOException,
                                         InterruptedException

Sets up bindings for a build.

Throws:

IOException

InterruptedException

getCredentials

@Nonnull
protected final C getCredentials(@Nonnull
                       hudson.model.Item owner)
                                                                                               throws IOException

Looks up the actual credentials.

Parameters:

owner - the owning item, such as AbstractBuild.getProject()

Returns:

the credentials

Throws:

FileNotFoundException - if the credentials could not be found (for convenience, rather than returning null)

IOException

getDescriptor

public BindingDescriptor<C> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<Binding<C extends com.cloudbees.plugins.credentials.common.StandardCredentials>>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<Binding<C extends com.cloudbees.plugins.credentials.common.StandardCredentials>>