org.testcontainers.utility

Class RegistryAuthLocator

java.lang.Object

org.testcontainers.utility.RegistryAuthLocator

public class RegistryAuthLocator
extends java.lang.Object

Utility to look up registry authentication information for an image.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegistryAuthLocator()

Method Summary

Modifier and Type	Method and Description
static RegistryAuthLocator	instance()
com.github.dockerjava.api.model.AuthConfig	lookupAuthConfig(DockerImageName dockerImageName, com.github.dockerjava.api.model.AuthConfig defaultAuthConfig) Looks up an AuthConfig for a given image name.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryAuthLocator

protected RegistryAuthLocator()

Method Detail

instance

public static RegistryAuthLocator instance()

lookupAuthConfig

public com.github.dockerjava.api.model.AuthConfig lookupAuthConfig(DockerImageName dockerImageName,
                                                                   com.github.dockerjava.api.model.AuthConfig defaultAuthConfig)

Looks up an AuthConfig for a given image name.

Lookup is performed in following order, as per https://docs.docker.com/engine/reference/commandline/cli/:

1. credHelpers
2. credsStore
3. Hard-coded Base64 encoded auth in auths
4. otherwise, if no credentials have been found then behaviour falls back to docker-java's implementation

Parameters:

dockerImageName - image name to be looked up (potentially including a registry URL part)

defaultAuthConfig - an AuthConfig object that should be returned if there is no overriding authentication available for images that are looked up

Returns:

an AuthConfig that is applicable to this specific image OR the defaultAuthConfig.