Package org.jenkinsci.plugins.docker.commons.impl

Class NullKeyMaterialFactory

java.lang.Object

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

org.jenkinsci.plugins.docker.commons.impl.NullKeyMaterialFactory

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public final class NullKeyMaterialFactory
extends KeyMaterialFactory

KeyMaterialFactory that does nothing.

Author:

Kohsuke Kawaguchi

See Also:

KeyMaterial.NULL

Field Summary

Fields inherited from class org.jenkinsci.plugins.docker.commons.credentials.KeyMaterialFactory

NULL

Constructor Summary

Constructors

Constructor	Description
NullKeyMaterialFactory()

Method Summary

Modifier and Type	Method	Description
KeyMaterialFactory	contextualize(KeyMaterialContext context)	Sets the KeyMaterialContext within which this KeyMaterialFactory can KeyMaterialFactory.materialize() KeyMaterial instances.
KeyMaterial	materialize()	Builds the key material environment variables needed to be passed when docker runs, to access DockerServerCredentials that this object was created from.

Methods inherited from class org.jenkinsci.plugins.docker.commons.credentials.KeyMaterialFactory

checkContextualized, createSecretsDirectory, getContext, plus

Methods inherited from class java.lang.Object

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

Constructor Detail

NullKeyMaterialFactory

public NullKeyMaterialFactory()

Method Detail

materialize

public KeyMaterial materialize()
                        throws IOException,
                               InterruptedException

Description copied from class: KeyMaterialFactory

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.

Specified by:

materialize in class KeyMaterialFactory

Throws:

IOException

InterruptedException

contextualize

public KeyMaterialFactory contextualize(@NonNull
                                        KeyMaterialContext context)

Description copied from class: KeyMaterialFactory

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

Overrides:

contextualize in class KeyMaterialFactory

Parameters:

context - the KeyMaterialContext.

Returns:

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