com.spotify.docker.client

Class DockerHost

java.lang.Object

com.spotify.docker.client.DockerHost

public class DockerHost
extends Object

Represents a dockerd endpoint. A codified DOCKER_HOST.

Field Summary

Fields

Modifier and Type	Field and Description
private String	address
private URI	bindURI
static String	DEFAULT_HOST
static int	DEFAULT_PORT
static String	DEFAULT_UNIX_ENDPOINT
private String	dockerCertPath
private String	host
private int	port
private URI	uri

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DockerHost(String endpoint, String dockerCertPath)

Method Summary

Modifier and Type	Method and Description
String	address() Get the Docker ip address or hostname.
URI	bindURI() Get the Docker rest bind uri.
private static int	defaultPort()
String	dockerCertPath() Get the path to certificate and key for connecting to Docker via HTTPS.
static DockerHost	from(String endpoint, String dockerCertPath) Create a DockerHost from an explicit address or uri.
static DockerHost	fromEnv() Create a DockerHost from DOCKER_HOST and DOCKER_PORT env vars.
String	host() Get a Docker endpoint usable for instantiating a new DockerHost with DockerHost.from(endpoint).
int	port() Get the Docker endpoint port.
String	toString()
URI	uri() Get the Docker rest uri.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_UNIX_ENDPOINT

public static final String DEFAULT_UNIX_ENDPOINT

See Also:

Constant Field Values

host

private final String host

uri

private final URI uri

bindURI

private final URI bindURI

address

private final String address

port

private final int port

dockerCertPath

private final String dockerCertPath

Constructor Detail

DockerHost

private DockerHost(String endpoint,
                   String dockerCertPath)

Method Detail

host

public 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 URI uri()

Get the Docker rest uri.

Returns:

The uri of the Docker endpoint.

bindURI

public 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 String address()

Get the Docker ip address or hostname.

Returns:

The ip address or hostname.

dockerCertPath

public String dockerCertPath()

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

Returns:

The path to the certificate.

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(String endpoint,
                              String dockerCertPath)

Create a DockerHost from an explicit address or uri.

Parameters:

endpoint - The Docker endpoint.

dockerCertPath - The certificate path.

Returns:

The DockerHost object.

defaultPort

private static int defaultPort()

toString

public String toString()

Overrides:

toString in class Object