com.google.cloud.tools.jib.frontend

Class CredentialRetrieverFactory

java.lang.Object

com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

public class CredentialRetrieverFactory
extends Object

Static factories for various CredentialRetrievers.

Method Summary

Modifier and Type	Method and Description
CredentialRetriever	dockerConfig() Creates a new CredentialRetriever that tries to retrieve credentials from Docker config (located at $USER_HOME/.docker/config.json).
CredentialRetriever	dockerConfig(Path dockerConfigFile) Creates a new CredentialRetriever that tries to retrieve credentials from a custom path to a Docker config.
CredentialRetriever	dockerCredentialHelper(Path credentialHelper) Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.
CredentialRetriever	dockerCredentialHelper(String credentialHelper) Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.
static CredentialRetrieverFactory	forImage(ImageReference imageReference) Creates a new CredentialRetrieverFactory for an image.
static CredentialRetrieverFactory	forImage(ImageReference imageReference, EventDispatcher eventDispatcher) Creates a new CredentialRetrieverFactory for an image.
CredentialRetriever	inferCredentialHelper() Creates a new CredentialRetriever that tries common Docker credential helpers to retrieve credentials based on the registry of the image, such as docker-credential-gcr for images with the registry as gcr.io.
CredentialRetriever	known(Credential credential, String credentialSource) Creates a new CredentialRetriever that returns a known Credential.

Methods inherited from class java.lang.Object

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

Method Detail

forImage

public static CredentialRetrieverFactory forImage(ImageReference imageReference,
                                                  EventDispatcher eventDispatcher)

Creates a new CredentialRetrieverFactory for an image.

Parameters:

imageReference - the image the credential are for

eventDispatcher - an event dispatcher for dispatching log events

Returns:

a new CredentialRetrieverFactory

forImage

public static CredentialRetrieverFactory forImage(ImageReference imageReference)

Creates a new CredentialRetrieverFactory for an image.

Parameters:

imageReference - the image the credential are for

Returns:

a new CredentialRetrieverFactory

known

public CredentialRetriever known(Credential credential,
                                 String credentialSource)

Creates a new CredentialRetriever that returns a known Credential.

Parameters:

credential - the known credential

credentialSource - the source of the credentials (for logging)

Returns:

a new CredentialRetriever

dockerCredentialHelper

public CredentialRetriever dockerCredentialHelper(String credentialHelper)

Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.

Parameters:

credentialHelper - the credential helper executable

Returns:

a new CredentialRetriever

dockerCredentialHelper

public CredentialRetriever dockerCredentialHelper(Path credentialHelper)

Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.

Parameters:

credentialHelper - the credential helper executable

Returns:

a new CredentialRetriever

See Also:

https://github.com/docker/docker-credential-helpers#development

inferCredentialHelper

public CredentialRetriever inferCredentialHelper()

Creates a new CredentialRetriever that tries common Docker credential helpers to retrieve credentials based on the registry of the image, such as docker-credential-gcr for images with the registry as gcr.io.

Returns:

a new CredentialRetriever

dockerConfig

public CredentialRetriever dockerConfig()

Creates a new CredentialRetriever that tries to retrieve credentials from Docker config (located at $USER_HOME/.docker/config.json).

Returns:

a new CredentialRetriever

See Also:

DockerConfigCredentialRetriever

dockerConfig

public CredentialRetriever dockerConfig(Path dockerConfigFile)

Creates a new CredentialRetriever that tries to retrieve credentials from a custom path to a Docker config.

Parameters:

dockerConfigFile - the path to the Docker config file

Returns:

a new CredentialRetriever

See Also:

DockerConfigCredentialRetriever