org.jenkinsci.plugins.docker.commons

Class KeyMaterial

java.lang.Object

org.jenkinsci.plugins.docker.commons.KeyMaterial

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

Direct Known Subclasses:

CompositeKeyMaterial, NullKeyMaterial, ServerKeyMaterialImpl

public abstract class KeyMaterial
extends Object
implements Closeable, Serializable

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.

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

Author:

Kohsuke Kawaguchi

See Also:

DockerServerEndpoint.materialize(AbstractBuild), DockerRegistryEndpoint.materialize(AbstractBuild), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static KeyMaterial	NULL KeyMaterial that does nothing.

Constructor Summary

Constructors

Constructor and Description
KeyMaterial()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() Deletes the key materials from the file system.
abstract hudson.EnvVars	env() Builds the environment variables needed to be passed when docker runs, to access DockerServerCredentials that this object was created from.
KeyMaterial	plus(KeyMaterial rhs) Merge two KeyMaterials 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 KeyMaterial NULL

KeyMaterial that does nothing.

Constructor Detail

KeyMaterial

public KeyMaterial()

Method Detail

env

public abstract hudson.EnvVars env()

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

close

public abstract void close()
                    throws IOException

Deletes the key materials from the file system. As key materials are copied into files every time KeyMaterial is created, it must be also cleaned up each time.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

plus

public KeyMaterial plus(@Nullable
               KeyMaterial rhs)

Merge two KeyMaterials into one.