com.google.cloud.tools.jib.plugins.common

Class DefaultCredentialRetrievers

java.lang.Object

com.google.cloud.tools.jib.plugins.common.DefaultCredentialRetrievers

public class DefaultCredentialRetrievers
extends Object

Generates a list of default CredentialRetrievers.

The retrievers are, in order of first-checked to last-checked:

1. CredentialRetrieverFactory.known(com.google.cloud.tools.jib.api.Credential, java.lang.String) for known credential, if set
2. CredentialRetrieverFactory.dockerCredentialHelper(java.lang.String) for a known credential helper, if set
3. CredentialRetrieverFactory.known(com.google.cloud.tools.jib.api.Credential, java.lang.String) for known inferred credential, if set
4. CredentialRetrieverFactory.dockerConfig()
5. CredentialRetrieverFactory.wellKnownCredentialHelpers() for well-known credential helper-registry pairs
6. CredentialRetrieverFactory.googleApplicationDefaultCredentials() for GCR registry

Method Summary

Modifier and Type	Method and Description
List<CredentialRetriever>	asList() Makes a list of CredentialRetrievers.
static DefaultCredentialRetrievers	init(CredentialRetrieverFactory credentialRetrieverFactory) Creates a new DefaultCredentialRetrievers with a given CredentialRetrieverFactory.
DefaultCredentialRetrievers	setCredentialHelper(String credentialHelper) Sets the known credential helper.
DefaultCredentialRetrievers	setInferredCredential(Credential inferredCredential, String credentialSource) Sets the inferred Credential to use in the default credential retrievers.
DefaultCredentialRetrievers	setKnownCredential(Credential knownCredential, String credentialSource) Sets the known Credential to use in the default credential retrievers.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static DefaultCredentialRetrievers init(CredentialRetrieverFactory credentialRetrieverFactory)

Creates a new DefaultCredentialRetrievers with a given CredentialRetrieverFactory.

Parameters:

credentialRetrieverFactory - the CredentialRetrieverFactory to generate the CredentialRetrievers

Returns:

a new DefaultCredentialRetrievers

setKnownCredential

public DefaultCredentialRetrievers setKnownCredential(Credential knownCredential,
                                                      String credentialSource)

Sets the known Credential to use in the default credential retrievers.

Parameters:

knownCredential - the known credential

credentialSource - the source of the known credential (for logging)

Returns:

this

setInferredCredential

public DefaultCredentialRetrievers setInferredCredential(Credential inferredCredential,
                                                         String credentialSource)

Sets the inferred Credential to use in the default credential retrievers.

Parameters:

inferredCredential - the inferred credential

credentialSource - the source of the inferred credential (for logging)

Returns:

this

setCredentialHelper

public DefaultCredentialRetrievers setCredentialHelper(@Nullable
                                                       String credentialHelper)

Sets the known credential helper. May either be a path to a credential helper executable, or a credential helper suffix (following docker-credential-).

Parameters:

credentialHelper - the path to a credential helper, or a credential helper suffix (following docker-credential-).

Returns:

this

asList

public List<CredentialRetriever> asList()
                                 throws FileNotFoundException

Makes a list of CredentialRetrievers.

Returns:

the list of CredentialRetrievers

Throws:

FileNotFoundException - if a credential helper path is specified, but the file doesn't exist