com.spotify.docker.client.messages

Class AuthConfig

java.lang.Object

com.spotify.docker.client.messages.AuthConfig

public class AuthConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthConfig.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private String	email
private static org.slf4j.Logger	log
private static com.fasterxml.jackson.databind.ObjectMapper	MAPPER
private String	password
private String	serverAddress
private String	username

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AuthConfig()
private	AuthConfig(AuthConfig.Builder builder)

Method Summary

Modifier and Type	Method and Description
static AuthConfig.Builder	builder()
private static Path	defaultConfigPath()
String	email()
boolean	equals(Object o)
private static com.fasterxml.jackson.databind.JsonNode	extractAuthJson(Path configPath)
static AuthConfig.Builder	fromDockerConfig() This function looks for and parses credentials for logging into Docker registries.
(package private) static AuthConfig.Builder	fromDockerConfig(Path configPath) Returns the first credential from the specified path to the docker file.
(package private) static AuthConfig.Builder	fromDockerConfig(Path configPath, String serverAddress) Returns the specified credential from the specified path to the docker file.
static AuthConfig.Builder	fromDockerConfig(String serverAddress) This function looks for and parses credentials for logging into the Docker registry specified by serverAddress.
int	hashCode()
private static AuthConfig.Builder	parseDockerConfig(Path configPath, String serverAddress)
String	password()
String	serverAddress()
AuthConfig.Builder	toBuilder()
String	toString()
String	username()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

private static final org.slf4j.Logger log

MAPPER

private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

username

private String username

password

private String password

email

private String email

serverAddress

private String serverAddress

Constructor Detail

AuthConfig

private AuthConfig()

AuthConfig

private AuthConfig(AuthConfig.Builder builder)

Method Detail

username

public String username()

password

public String password()

email

public String email()

serverAddress

public String serverAddress()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public AuthConfig.Builder toBuilder()

fromDockerConfig

public static AuthConfig.Builder fromDockerConfig()
                                           throws IOException

This function looks for and parses credentials for logging into Docker registries. We first look in ~/.docker/config.json and fallback to ~/.dockercfg. We use the first credential in the config file. These files are created from running `docker login`.

Returns:

a AuthConfig.Builder

Throws:

IOException - when we can't parse the docker config file

fromDockerConfig

public static AuthConfig.Builder fromDockerConfig(String serverAddress)
                                           throws IOException

This function looks for and parses credentials for logging into the Docker registry specified by serverAddress. We first look in ~/.docker/config.json and fallback to ~/.dockercfg. These files are created from running `docker login`.

Parameters:

serverAddress - A string representing the server address

Returns:

a AuthConfig.Builder

Throws:

IOException - when we can't parse the docker config file

fromDockerConfig

static AuthConfig.Builder fromDockerConfig(Path configPath)
                                    throws IOException

Returns the first credential from the specified path to the docker file. This method is package-local so we can test it.

Parameters:

configPath - The path to the config file

Returns:

a AuthConfig.Builder

Throws:

IOException - when we can't parse the docker config file

fromDockerConfig

static AuthConfig.Builder fromDockerConfig(Path configPath,
                                           String serverAddress)
                                    throws IOException

Returns the specified credential from the specified path to the docker file. This method is package-local so we can test it.

Parameters:

configPath - The path to the config file

serverAddress - A string representing the server address

Returns:

a AuthConfig.Builder

Throws:

IOException - If an IOException occurred

defaultConfigPath

private static Path defaultConfigPath()

parseDockerConfig

private static AuthConfig.Builder parseDockerConfig(Path configPath,
                                                    String serverAddress)
                                             throws IOException

Throws:

IOException

extractAuthJson

private static com.fasterxml.jackson.databind.JsonNode extractAuthJson(Path configPath)
                                                                throws IOException

Throws:

IOException

builder

public static AuthConfig.Builder builder()