Interface DockerRegistryAuthentication

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface DockerRegistryAuthentication

Docker registry authentication configuration.

Since:

2.4.0

Author:

Scott Frederick

Field Summary

Fields

Modifier and Type	Field	Description
static final DockerRegistryAuthentication	EMPTY_USER	An empty user(String, String, String, String) authentication.

Method Summary

Modifier and Type	Method	Description
static DockerRegistryAuthentication	configuration(@Nullable DockerRegistryAuthentication fallback)	Factory method that returns a new DockerRegistryAuthentication instance that uses the standard docker JSON config (including support for credential helpers) to generate auth headers.
static DockerRegistryAuthentication	configuration(@Nullable DockerRegistryAuthentication fallback, BiConsumer<String, Exception> credentialHelperExceptionHandler)	Factory method that returns a new DockerRegistryAuthentication instance that uses the standard docker JSON config (including support for credential helpers) to generate auth headers.
@Nullable String	getAuthHeader()	Returns the auth header that should be used for docker authentication.
default @Nullable String	getAuthHeader(@Nullable ImageReference imageReference)	Returns the auth header that should be used for docker authentication for the given image reference.
static DockerRegistryAuthentication	token(String identityToken)	Factory method to that returns a new DockerRegistryAuthentication instance that uses a header generated by base64 encoding a JSON payload created from the given parameters.
static DockerRegistryAuthentication	user(String username, String password, @Nullable String serverAddress, @Nullable String email)	Factory method to that returns a new DockerRegistryAuthentication instance that uses a header generated by base64 encoding a JSON payload created from the given parameters.

Field Details

EMPTY_USER

static final DockerRegistryAuthentication EMPTY_USER

An empty user(String, String, String, String) authentication.

Since:

3.5.0

Method Details

getAuthHeader

default @Nullable String getAuthHeader(@Nullable ImageReference imageReference)

Returns the auth header that should be used for docker authentication for the given image reference.

Parameters:

imageReference - the image reference or null

Returns:

the auth header

Since:

3.5.0

getAuthHeader

@Nullable String getAuthHeader()

Returns the auth header that should be used for docker authentication.

Returns:

the auth header

token

static DockerRegistryAuthentication token(String identityToken)

Factory method to that returns a new DockerRegistryAuthentication instance that uses a header generated by base64 encoding a JSON payload created from the given parameters.

Parameters:

identityToken - the identity token JSON field

Returns:

a new DockerRegistryAuthentication instance

Since:

3.5.0

user

static DockerRegistryAuthentication user(String username,
 String password,
 @Nullable String serverAddress,
 @Nullable String email)

Factory method to that returns a new DockerRegistryAuthentication instance that uses a header generated by base64 encoding a JSON payload created from the given parameters.

Parameters:

username - the username JSON field

password - the password JSON field

serverAddress - the server address JSON field

email - the email JSON field

Returns:

a new DockerRegistryAuthentication instance

Since:

3.5.0

configuration

static DockerRegistryAuthentication configuration(@Nullable DockerRegistryAuthentication fallback)

Factory method that returns a new DockerRegistryAuthentication instance that uses the standard docker JSON config (including support for credential helpers) to generate auth headers.

Parameters:

fallback - the fallback authentication to use if no suitable config is found, may be null

Returns:

a new DockerRegistryAuthentication instance

Since:

3.5.0

See Also:

• configuration(DockerRegistryAuthentication, BiConsumer)

configuration

static DockerRegistryAuthentication configuration(@Nullable DockerRegistryAuthentication fallback,
 BiConsumer<String, Exception> credentialHelperExceptionHandler)

Factory method that returns a new DockerRegistryAuthentication instance that uses the standard docker JSON config (including support for credential helpers) to generate auth headers.

Parameters:

fallback - the fallback authentication to use if no suitable config is found, may be null

credentialHelperExceptionHandler - callback that should handle credential helper exceptions, never null

Returns:

a new DockerRegistryAuthentication instance

Since:

3.5.0

See Also:

• configuration(DockerRegistryAuthentication, BiConsumer)