org.jenkinsci.plugins.credentialsbinding

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

java.lang.Object

hudson.model.AbstractDescribableImpl<MultiBinding<C>>

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

Type Parameters:

C - a kind of credentials

All Implemented Interfaces:

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

Direct Known Subclasses:

Binding, UsernamePasswordMultiBinding

public abstract class MultiBinding<C extends com.cloudbees.plugins.credentials.common.StandardCredentials>
extends hudson.model.AbstractDescribableImpl<MultiBinding<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 class	MultiBinding.MultiEnvironment Result of bind(hudson.model.Run<?, ?>, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener).
protected static class	MultiBinding.NullUnbinder No-op callback.
static interface	MultiBinding.Unbinder Callback run at the end of a build.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiBinding(String credentialsId) For use with DataBoundConstructor.

Method Summary

Methods

Modifier and Type	Method and Description
abstract MultiBinding.MultiEnvironment	bind(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Sets up bindings for a build.
protected C	getCredentials(hudson.model.Run<?,?> build) Looks up the actual credentials.
String	getCredentialsId() Identifier of the credentials to be bound.
BindingDescriptor<C>	getDescriptor()
protected abstract Class<C>	type() Type token.
abstract Set<String>	variables() Defines keys expected to be set in MultiBinding.MultiEnvironment.getValues(), particularly any that might be sensitive.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiBinding

protected MultiBinding(String credentialsId)

For use with DataBoundConstructor.

Method Detail

type

protected abstract Class<C> type()

Type token.

getCredentialsId

public final String getCredentialsId()

Identifier of the credentials to be bound.

bind

public abstract MultiBinding.MultiEnvironment bind(@Nonnull
                                 hudson.model.Run<?,?> build,
                                 hudson.FilePath workspace,
                                 hudson.Launcher launcher,
                                 hudson.model.TaskListener listener)
                                            throws IOException,
                                                   InterruptedException

Sets up bindings for a build.

Throws:

IOException

InterruptedException

variables

public abstract Set<String> variables()

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

getCredentials

@Nonnull
protected final C getCredentials(@Nonnull
                       hudson.model.Run<?,?> build)
                                                                                               throws IOException

Looks up the actual credentials.

Parameters:

build - the build.

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<MultiBinding<C extends com.cloudbees.plugins.credentials.common.StandardCredentials>>

Overrides:

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