com.google.cloud.tools.jib.registry.credentials

Class RegistryCredentials

java.lang.Object

com.google.cloud.tools.jib.registry.credentials.RegistryCredentials

public class RegistryCredentials
extends Object

Stores retrieved registry credentials.

The credentials are referred to by the registry they are used for.

Method Summary

Modifier and Type	Method and Description
static RegistryCredentials	from(List<String> credentialHelperSuffixes, List<String> registries) Retrieves credentials for registries using the credential helpers referred to by credentialHelperSuffixes.
static RegistryCredentials	from(String credentialSource, Map<String,Authorization> registryCredentialMap) Instantiates from a credential source and a map of registry credentials.
Authorization	getAuthorization(String registry)
String	getCredentialSource(String registry)
boolean	has(String registry)
static RegistryCredentials	none() Instantiates with no credentials.
static RegistryCredentials	of(String registry, String credentialSource, Authorization authorization) Instantiates with credentials for a single registry.

Methods inherited from class java.lang.Object

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

Method Detail

none

public static RegistryCredentials none()

Instantiates with no credentials.

of

public static RegistryCredentials of(String registry,
                                     String credentialSource,
                                     Authorization authorization)

Instantiates with credentials for a single registry.

from

public static RegistryCredentials from(List<String> credentialHelperSuffixes,
                                       List<String> registries)
                                throws IOException,
                                       NonexistentDockerCredentialHelperException

Retrieves credentials for registries using the credential helpers referred to by credentialHelperSuffixes.

This obtains the registry credentials, not the Docker authentication token.

Throws:

IOException

NonexistentDockerCredentialHelperException

from

public static RegistryCredentials from(String credentialSource,
                                       Map<String,Authorization> registryCredentialMap)

Instantiates from a credential source and a map of registry credentials.

Parameters:

credentialSource - the source of the credentials, useful for informing users where the credentials came from

registryCredentialMap - a map from registries to their respective credentials

has

public boolean has(String registry)

Returns:

true if there are credentials for registry; false otherwise

getAuthorization

@Nullable
public Authorization getAuthorization(String registry)

Returns:

the Authorization retrieved for the registry, or null if none exists

getCredentialSource

@Nullable
public String getCredentialSource(String registry)

Returns:

the name of the credential helper used to retrieve authorization for the registry, or null if none exists