Package com.spotify.docker.client

Class DockerHost

java.lang.Object

com.spotify.docker.client.DockerHost

public class DockerHost
extends java.lang.Object

Represents a dockerd endpoint. A codified DOCKER_HOST.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	DockerHost.SystemDelegate	An interface to be mocked during testing.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	address
private java.net.URI	bindUri
private java.lang.String	certPath
private static java.lang.String	DEFAULT_ADDRESS
private static int	DEFAULT_PORT
private static java.lang.String	DEFAULT_UNIX_ENDPOINT
private static DockerHost.SystemDelegate	defaultSystemDelegate
private java.lang.String	host
private int	port
private static DockerHost.SystemDelegate	systemDelegate
private java.net.URI	uri

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DockerHost(java.lang.String endpoint, java.lang.String certPath)

Method Summary

Modifier and Type	Method	Description
java.lang.String	address()	Get the Docker ip address or hostname.
java.net.URI	bindUri()	Get the Docker rest bind uri.
(package private) static java.lang.String	certPathFromEnv()
static java.lang.String	defaultAddress()
(package private) static java.lang.String	defaultCertPath()
(package private) static java.lang.String	defaultDockerEndpoint()
static int	defaultPort()
static java.lang.String	defaultUnixEndpoint()
java.lang.String	dockerCertPath()	Get the path to certificate and key for connecting to Docker via HTTPS.
(package private) static java.lang.String	endpointFromEnv()
boolean	equals(java.lang.Object obj)
static DockerHost	from(java.lang.String endpoint, java.lang.String certPath)	Create a DockerHost from an explicit address or uri.
static DockerHost	fromEnv()	Create a DockerHost from DOCKER_HOST and DOCKER_PORT env vars.
int	hashCode()
java.lang.String	host()	Get a Docker endpoint usable for instantiating a new DockerHost with DockerHost.from(endpoint).
int	port()	Get the Docker endpoint port.
(package private) static int	portFromEnv()
(package private) static void	restoreSystemDelegate()
(package private) static void	setSystemDelegate(DockerHost.SystemDelegate delegate)
java.lang.String	toString()
java.net.URI	uri()	Get the Docker rest uri.

Methods inherited from class java.lang.Object

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

Field Detail

defaultSystemDelegate

private static final DockerHost.SystemDelegate defaultSystemDelegate

systemDelegate

private static DockerHost.SystemDelegate systemDelegate

DEFAULT_UNIX_ENDPOINT

private static final java.lang.String DEFAULT_UNIX_ENDPOINT

See Also:

Constant Field Values

DEFAULT_ADDRESS

private static final java.lang.String DEFAULT_ADDRESS

See Also:

Constant Field Values

DEFAULT_PORT

private static final int DEFAULT_PORT

See Also:

Constant Field Values

host

private final java.lang.String host

uri

private final java.net.URI uri

bindUri

private final java.net.URI bindUri

address

private final java.lang.String address

port

private final int port

certPath

private final java.lang.String certPath

Constructor Detail

DockerHost

private DockerHost(java.lang.String endpoint,
                   java.lang.String certPath)

Method Detail

host

public java.lang.String host()

Get a Docker endpoint usable for instantiating a new DockerHost with DockerHost.from(endpoint).

Returns:

A unix socket path or, in the case of a TCP socket, the hostname and port which represents a Docker endpoint.

uri

public java.net.URI uri()

Get the Docker rest uri.

Returns:

The uri of the Docker endpoint.

bindUri

public java.net.URI bindUri()

Get the Docker rest bind uri.

Returns:

The uri of the host for binding ports (or setting $DOCKER_HOST).

port

public int port()

Get the Docker endpoint port.

Returns:

The port.

address

public java.lang.String address()

Get the Docker ip address or hostname.

Returns:

The ip address or hostname.

dockerCertPath

public java.lang.String dockerCertPath()

Get the path to certificate and key for connecting to Docker via HTTPS.

Returns:

The path to the certificate.

setSystemDelegate

static void setSystemDelegate(DockerHost.SystemDelegate delegate)

restoreSystemDelegate

static void restoreSystemDelegate()

fromEnv

public static DockerHost fromEnv()

Create a DockerHost from DOCKER_HOST and DOCKER_PORT env vars.

Returns:

The DockerHost object.

from

public static DockerHost from(java.lang.String endpoint,
                              java.lang.String certPath)

Create a DockerHost from an explicit address or uri.

Parameters:

endpoint - The Docker endpoint.

certPath - The certificate path.

Returns:

The DockerHost object.

defaultDockerEndpoint

static java.lang.String defaultDockerEndpoint()

endpointFromEnv

static java.lang.String endpointFromEnv()

defaultUnixEndpoint

public static java.lang.String defaultUnixEndpoint()

defaultAddress

public static java.lang.String defaultAddress()

defaultPort

public static int defaultPort()

portFromEnv

static int portFromEnv()

defaultCertPath

static java.lang.String defaultCertPath()

certPathFromEnv

static java.lang.String certPathFromEnv()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object