Package com.spotify.docker.client.auth
Class ConfigFileRegistryAuthSupplier
java.lang.Object
com.spotify.docker.client.auth.ConfigFileRegistryAuthSupplier
- All Implemented Interfaces:
RegistryAuthSupplier
RegistryAuthSupplier that returns data from the docker-cli config file. The config file is
re-read on each method call, to handle cases where a process is updating the file out-of-band
during the lifecycle of a DockerClient instance.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final org.slf4j.Logger
private final Path
private final DockerConfigReader
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a RegistryAuth object that works with a given registry's API [e.g.Authentication info to pass in the X-Registry-Config header when building an image.Returns a RegistryAuth object that is valid for a Docker Swarm context [i.e.private boolean
-
Field Details
-
log
private static final org.slf4j.Logger log -
reader
-
path
-
-
Constructor Details
-
ConfigFileRegistryAuthSupplier
public ConfigFileRegistryAuthSupplier() -
ConfigFileRegistryAuthSupplier
-
ConfigFileRegistryAuthSupplier
-
-
Method Details
-
configFileExists
private boolean configFileExists() -
authFor
Description copied from interface:RegistryAuthSupplier
Returns a RegistryAuth object that works with a given registry's API [e.g. GCR].- Specified by:
authFor
in interfaceRegistryAuthSupplier
- Returns:
- the RegistryAuth to use when working with the image, or else
null
if no authentication info applies for this image - Throws:
DockerException
-
authForSwarm
Description copied from interface:RegistryAuthSupplier
Returns a RegistryAuth object that is valid for a Docker Swarm context [i.e. not tied to specific image]. It's unnecessary if it's not planned to use this AuthSupplier to pull images for Swarm.- Specified by:
authForSwarm
in interfaceRegistryAuthSupplier
- Returns:
- the RegistryAuth to use in Swarn, or else
null
for no authentication info - Throws:
DockerException
-
authForBuild
Description copied from interface:RegistryAuthSupplier
Authentication info to pass in the X-Registry-Config header when building an image.- Specified by:
authForBuild
in interfaceRegistryAuthSupplier
- Throws:
DockerException
-