com.spotify.docker.client

Class DockerConfigReader

java.lang.Object

com.spotify.docker.client.DockerConfigReader

public class DockerConfigReader
extends Object

Constructor Summary

Constructors

Constructor and Description
DockerConfigReader()

Method Summary

Modifier and Type	Method and Description
RegistryAuth	anyRegistryAuth() Return a single RegistryAuth from the default config file.
RegistryConfigs	authForAllRegistries(Path configPath) Parse the contents of the config file and generate all possible RegistryAuths, which are bundled into a RegistryConfigs instance.
RegistryAuth	authForRegistry(Path configPath, String registry) Generate RegistryAuth for the registry.
Path	defaultConfigPath()
RegistryConfigs	fromConfig(Path configPath) Deprecated. Use authForAllRegistries(Path) instead.
RegistryAuth	fromConfig(Path configPath, String serverAddress) Deprecated. In favor of authForRegistry(Path, String)

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerConfigReader

public DockerConfigReader()

Method Detail

fromConfig

@Deprecated
public RegistryConfigs fromConfig(Path configPath)
                                       throws IOException

Deprecated. Use authForAllRegistries(Path) instead.

Parse the contents of the config file and generate all possible RegistryAuths, which are bundled into a RegistryConfigs instance.

Parameters:

configPath - Path to config file.

Returns:

All registry configs that can be generated from the config file

Throws:

IOException - If the file cannot be read, or its JSON cannot be parsed

fromConfig

@Deprecated
public RegistryAuth fromConfig(Path configPath,
                                           String serverAddress)
                                    throws IOException

Deprecated. In favor of authForRegistry(Path, String)

Returns the RegistryAuth for the config file for the given registry server name.

Throws:

IllegalArgumentException - if the config file does not contain registry auth info for the registry

IOException

anyRegistryAuth

public RegistryAuth anyRegistryAuth()
                             throws IOException

Return a single RegistryAuth from the default config file. If there is only one, it'll be that one.

Returns:

Some registry auth value.

Throws:

IOException

authForAllRegistries

public RegistryConfigs authForAllRegistries(Path configPath)
                                     throws IOException

Parse the contents of the config file and generate all possible RegistryAuths, which are bundled into a RegistryConfigs instance.

Parameters:

configPath - Path to config file.

Returns:

All registry auths that can be generated from the config file

Throws:

IOException - If the file cannot be read, or its JSON cannot be parsed

authForRegistry

public RegistryAuth authForRegistry(Path configPath,
                                    String registry)
                             throws IOException

Generate RegistryAuth for the registry.

Parameters:

configPath - Path to the docker config file

registry - Docker registry for which to generate auth

Returns:

The generated authentication object

Throws:

IOException

defaultConfigPath

public Path defaultConfigPath()