Package com.google.cloud.tools.jib.frontend

Class CredentialRetrieverFactory

java.lang.Object

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

public class CredentialRetrieverFactory
extends java.lang.Object

Static factories for various CredentialRetrievers.

Method Summary

Modifier and Type	Method	Description
CredentialRetriever	dockerConfig()	Creates a new CredentialRetriever that tries to retrieve credentials from Docker config (located at System.getProperty("user.home")/.docker/config.json).
CredentialRetriever	dockerConfig(java.nio.file.Path dockerConfigFile)	Creates a new CredentialRetriever that tries to retrieve credentials from a custom path to a Docker config.
CredentialRetriever	dockerCredentialHelper(java.lang.String credentialHelper)	Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.
CredentialRetriever	dockerCredentialHelper(java.nio.file.Path credentialHelper)	Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.
static CredentialRetrieverFactory	forImage(ImageReference imageReference, java.util.function.Consumer<LogEvent> logger)	Creates a new CredentialRetrieverFactory for an image.
static CredentialRetrieverFactory	forImage(ImageReference imageReference, java.util.function.Consumer<LogEvent> logger, java.util.Map<java.lang.String,java.lang.String> environment)	Creates a new CredentialRetrieverFactory for an image.
CredentialRetriever	googleApplicationDefaultCredentials()	Creates a new CredentialRetriever that tries to retrieve credentials from Google Application Default Credentials.
CredentialRetriever	known(Credential credential, java.lang.String credentialSource)	Creates a new CredentialRetriever that returns a known Credential.
CredentialRetriever	legacyDockerConfig(java.nio.file.Path dockerConfigFile)	Creates a new CredentialRetriever that tries to retrieve credentials from a legacy Docker config file.
CredentialRetriever	wellKnownCredentialHelpers()	Creates a new CredentialRetriever that tries well-known Docker credential helpers to retrieve credentials based on the registry of the image, such as docker-credential-gcr for images with the registry ending with gcr.io.

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,
                                                  java.util.function.Consumer<LogEvent> logger)

Creates a new CredentialRetrieverFactory for an image.

Parameters:

imageReference - the image the credential are for

logger - a consumer for handling log events

Returns:

a new CredentialRetrieverFactory

forImage

public static CredentialRetrieverFactory forImage(ImageReference imageReference,
                                                  java.util.function.Consumer<LogEvent> logger,
                                                  java.util.Map<java.lang.String,java.lang.String> environment)

Creates a new CredentialRetrieverFactory for an image.

Parameters:

imageReference - the image the credential are for

logger - a consumer for handling log events

environment - environment variables for credential helper

Returns:

a new CredentialRetrieverFactory

known

public CredentialRetriever known(Credential credential,
                                 java.lang.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(java.lang.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(java.nio.file.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

wellKnownCredentialHelpers

public CredentialRetriever wellKnownCredentialHelpers()

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

Returns:

a new CredentialRetriever

dockerConfig

public CredentialRetriever dockerConfig()

Creates a new CredentialRetriever that tries to retrieve credentials from Docker config (located at System.getProperty("user.home")/.docker/config.json).

Returns:

a new CredentialRetriever

See Also:

DockerConfigCredentialRetriever

dockerConfig

public CredentialRetriever dockerConfig(java.nio.file.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

legacyDockerConfig

public CredentialRetriever legacyDockerConfig(java.nio.file.Path dockerConfigFile)

Creates a new CredentialRetriever that tries to retrieve credentials from a legacy Docker config file.

Parameters:

dockerConfigFile - the path to a legacy docker configuration file

Returns:

a new CredentialRetriever

See Also:

DockerConfigCredentialRetriever

googleApplicationDefaultCredentials

public CredentialRetriever googleApplicationDefaultCredentials()

Creates a new CredentialRetriever that tries to retrieve credentials from Google Application Default Credentials.

Returns:

a new CredentialRetriever

See Also:

https://cloud.google.com/docs/authentication/production