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

Class DockerConfigCredentialRetriever

java.lang.Object

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

public class DockerConfigCredentialRetriever
extends java.lang.Object

Retrieves registry credentials from the Docker config.

The credentials are searched in the following order (stopping when credentials are found):

1. The credential helper from credHelpers defined for a registry, if available.
2. The credsStore credential helper, if available.
3. If there is an auth defined for a registry.

See Also:

https://docs.docker.com/engine/reference/commandline/login/

Method Summary

Modifier and Type	Method	Description
static DockerConfigCredentialRetriever	create(java.lang.String registry, java.nio.file.Path dockerConfigFile)
static DockerConfigCredentialRetriever	createForLegacyFormat(java.lang.String registry, java.nio.file.Path dockerConfigFile)
java.nio.file.Path	getDockerConfigFile()
java.util.Optional<Credential>	retrieve(java.util.function.Consumer<LogEvent> logger)	Retrieves credentials for a registry.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DockerConfigCredentialRetriever create(java.lang.String registry,
                                                     java.nio.file.Path dockerConfigFile)

createForLegacyFormat

public static DockerConfigCredentialRetriever createForLegacyFormat(java.lang.String registry,
                                                                    java.nio.file.Path dockerConfigFile)

getDockerConfigFile

public java.nio.file.Path getDockerConfigFile()

retrieve

public java.util.Optional<Credential> retrieve(java.util.function.Consumer<LogEvent> logger)
                                        throws java.io.IOException

Retrieves credentials for a registry. Tries all possible known aliases.

Parameters:

logger - a consumer for handling log events

Returns:

Credential found for registry, or Optional.empty() if not found

Throws:

java.io.IOException - if failed to parse the config JSON