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

Class KeyMaterial2

java.lang.Object

org.jenkinsci.plugins.docker.commons.credentials.KeyMaterial2

All Implemented Interfaces:

Serializable

public abstract class KeyMaterial2
extends Object
implements Serializable

Represents a locally extracted credentials information.

Implementations of this class are created by their corresponding KeyMaterialFactory implementations. Be sure to call close(hudson.remoting.VirtualChannel) when finished.

Author:

Kohsuke Kawaguchi

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyMaterial2(EnvVars envVars)

Method Summary

Modifier and Type	Method	Description
abstract void	close(hudson.remoting.VirtualChannel channel)	Deletes the key materials from the file system.
final EnvVars	env()	Get the environment variables needed to be passed when docker runs, to access DockerServerCredentials that this object was created from.

Methods inherited from class java.lang.Object

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

Field Details

NULL

public static final KeyMaterial2 NULL

KeyMaterial that does nothing.

Constructor Details

KeyMaterial2

protected KeyMaterial2(EnvVars envVars)

Method Details

env

public final EnvVars env()

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

close

public abstract void close(hudson.remoting.VirtualChannel channel)
                    throws IOException,
InterruptedException

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

Parameters:

channel - to restore pathnames

Throws:

IOException

InterruptedException