Package org.jenkinsci.plugins.docker.commons.credentials

Class KeyMaterialFactory

java.lang.Object

org.jenkinsci.plugins.docker.commons.credentials.KeyMaterialFactory

Direct Known Subclasses:

CompositeKeyMaterialFactory, NullKeyMaterialFactory, RegistryKeyMaterialFactory, ServerHostKeyMaterialFactory, ServerKeyMaterialFactory

public abstract class KeyMaterialFactory
extends Object

Represents a locally extracted credentials information.

Whenever you want to fork off docker directly or indirectly, use this object to set up environment variables so that docker will talk to the right daemon.

Author:

Kohsuke Kawaguchi

See Also:

DockerServerEndpoint.newKeyMaterialFactory(AbstractBuild), DockerRegistryEndpoint.newKeyMaterialFactory(AbstractBuild)

Field Summary

Fields

Modifier and Type	Field	Description
static KeyMaterialFactory	NULL

Constructor Summary

Constructors

Constructor	Description
KeyMaterialFactory()

Method Summary

Modifier and Type	Method	Description
protected void	checkContextualized()
KeyMaterialFactory	contextualize(KeyMaterialContext context)	Sets the KeyMaterialContext within which this KeyMaterialFactory can materialize() KeyMaterial instances.
protected FilePath	createSecretsDirectory()	Creates a read-protected directory inside KeyMaterialContext.getBaseDir() suitable for storing secret files.
protected KeyMaterialContext	getContext()
abstract KeyMaterial	materialize()	Builds the key material environment variables needed to be passed when docker runs, to access DockerServerCredentials that this object was created from.
KeyMaterialFactory	plus(KeyMaterialFactory... factories)	Merge additional KeyMaterialFactorys into one.

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final KeyMaterialFactory NULL

Constructor Detail

KeyMaterialFactory

public KeyMaterialFactory()

Method Detail

checkContextualized

protected void checkContextualized()

contextualize

public KeyMaterialFactory contextualize(@NonNull
                                        KeyMaterialContext context)

Sets the KeyMaterialContext within which this KeyMaterialFactory can materialize() KeyMaterial instances. Can only be called once.

Parameters:

context - the KeyMaterialContext.

Returns:

must return this (which is only returned to simplify use via method chaining)

getContext

@NonNull
protected KeyMaterialContext getContext()

materialize

public abstract KeyMaterial materialize()
                                 throws IOException,
                                        InterruptedException

Builds the key material environment variables needed to be passed when docker runs, to access DockerServerCredentials that this object was created from.

When you are done using the credentials, call KeyMaterial.close() to allow sensitive information to be removed from the disk.

Throws:

IOException

InterruptedException

createSecretsDirectory

protected final FilePath createSecretsDirectory()
                                         throws IOException,
                                                InterruptedException

Creates a read-protected directory inside KeyMaterialContext.getBaseDir() suitable for storing secret files. Be sure to FilePath.deleteRecursive() this in KeyMaterial.close().

Throws:

IOException

InterruptedException

plus

public KeyMaterialFactory plus(@Nullable
                               KeyMaterialFactory... factories)

Merge additional KeyMaterialFactorys into one.