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

Class DockerCredentialHelper

java.lang.Object

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

public class DockerCredentialHelper
extends java.lang.Object

Retrieves Docker credentials with a Docker credential helper.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
DockerCredentialHelper(java.lang.String serverUrl, java.nio.file.Path credentialHelper)	Constructs a new DockerCredentialHelper.
DockerCredentialHelper(java.lang.String serverUrl, java.nio.file.Path credentialHelper, java.util.Map<java.lang.String,java.lang.String> environment)	Constructs a new DockerCredentialHelper.

Method Summary

Modifier and Type	Method	Description
Credential	retrieve()	Calls the credential helper CLI.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerCredentialHelper

public DockerCredentialHelper(java.lang.String serverUrl,
                              java.nio.file.Path credentialHelper)

Constructs a new DockerCredentialHelper.

Parameters:

serverUrl - the server URL to pass into the credential helper

credentialHelper - the path to the credential helper executable

DockerCredentialHelper

public DockerCredentialHelper(java.lang.String serverUrl,
                              java.nio.file.Path credentialHelper,
                              java.util.Map<java.lang.String,java.lang.String> environment)

Constructs a new DockerCredentialHelper.

Parameters:

serverUrl - the server URL to pass into the credential helper

credentialHelper - the path to the credential helper executable

environment - environment variables used in configuring the credential helper

Method Detail

retrieve

public Credential retrieve()
                    throws java.io.IOException,
                           CredentialHelperUnhandledServerUrlException,
                           CredentialHelperNotFoundException

Calls the credential helper CLI.

Calls occur in the form:

 echo -n <server URL> | docker-credential-<credential helper suffix> get
 

Returns:

the Docker credentials by calling the corresponding CLI

Throws:

java.io.IOException - if writing/reading process input/output fails

CredentialHelperUnhandledServerUrlException - if no credentials could be found for the corresponding server

CredentialHelperNotFoundException - if the credential helper CLI doesn't exist