com.spotify.docker.client

Class DefaultDockerClient

java.lang.Object

com.spotify.docker.client.DefaultDockerClient

All Implemented Interfaces:

DockerClient, Closeable, AutoCloseable

public class DefaultDockerClient
extends Object
implements DockerClient, Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultDockerClient.Builder
static interface	DefaultDockerClient.ExceptionPropagator

Nested classes/interfaces inherited from interface com.spotify.docker.client.DockerClient

DockerClient.BuildParameter, DockerClient.ListContainersParam, DockerClient.LogsParameter

Field Summary

Fields

Modifier and Type	Field and Description
private com.sun.jersey.api.client.Client	client
private static com.sun.jersey.api.client.config.DefaultClientConfig	CLIENT_CONFIG
private static AtomicInteger	CLIENT_COUNTER
private InterruptibleURLConnectionClientHandler	clientHandler
private static com.sun.jersey.api.client.GenericType<List<Container>>	CONTAINER_LIST
private static Pattern	CONTAINER_NAME_PATTERN
private static long	DEFAULT_CONNECT_TIMEOUT_MILLIS
private static long	DEFAULT_READ_TIMEOUT_MILLIS
private ExecutorService	executor
private static org.slf4j.Logger	log
static long	NO_TIMEOUT
private static com.sun.jersey.api.client.GenericType<List<RemovedImage>>	REMOVED_IMAGE_LIST
private URI	uri
private static String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DefaultDockerClient(DefaultDockerClient.Builder builder) Create a new client using the configuration of the builder.
	DefaultDockerClient(String uri) Create a new client with default configuration.
	DefaultDockerClient(URI uri) Create a new client with default configuration.

Method Summary

Methods

Modifier and Type	Method and Description
String	build(Path directory, DockerClient.BuildParameter... params) Build a docker image.
String	build(Path directory, ProgressHandler handler, DockerClient.BuildParameter... params) Build a docker image.
String	build(Path directory, String name, DockerClient.BuildParameter... params) Build a docker image.
String	build(Path directory, String name, ProgressHandler handler, DockerClient.BuildParameter... params) Build a docker image.
static DefaultDockerClient.Builder	builder() Create a new DefaultDockerClient builder.
void	close()
ContainerCreation	createContainer(ContainerConfig config) Create a docker container.
ContainerCreation	createContainer(ContainerConfig config, String name) Create a docker container.
Info	info() Get docker instance information.
ContainerInfo	inspectContainer(String containerId) Inspect a docker container.
ImageInfo	inspectImage(String image) Inspect a docker container image.
void	killContainer(String containerId) Kill a docker container.
List<Container>	listContainers(DockerClient.ListContainersParam... params) List docker containers.
LogStream	logs(String containerId, DockerClient.LogsParameter... params) Get docker container logs.
private String	message(com.sun.jersey.api.client.ClientResponse response)
private javax.ws.rs.core.MultivaluedMap<String,String>	multivaluedMap(com.google.common.collect.Multimap<String,String> map)
private RuntimeException	propagate(String method, com.sun.jersey.api.client.WebResource resource, com.sun.jersey.api.client.ClientHandlerException e)
private DockerRequestException	propagate(String method, com.sun.jersey.api.client.WebResource resource, com.sun.jersey.api.client.UniformInterfaceException e)
void	pull(String image) Pull a docker container image.
void	pull(String image, ProgressHandler handler) Pull a docker container image, using a custom ProgressMessageHandler
void	push(String image) Push a docker container image.
void	push(String image, ProgressHandler handler) Push a docker container image, using a custom ProgressHandler
void	removeContainer(String containerId) Remove a docker container.
void	removeContainer(String containerId, boolean removeVolumes) Remove a docker container.
List<RemovedImage>	removeImage(String image) Remove a docker image.
List<RemovedImage>	removeImage(String image, boolean force, boolean noPrune) Remove a docker image.
private <T> T	request(String method, Class<T> clazz, com.sun.jersey.api.client.WebResource resource, com.sun.jersey.api.client.UniformInterface request)
private <T> T	request(String method, com.sun.jersey.api.client.GenericType<T> type, com.sun.jersey.api.client.WebResource resource, com.sun.jersey.api.client.WebResource.Builder request)
private void	request(String method, com.sun.jersey.api.client.WebResource resource, com.sun.jersey.api.client.UniformInterface request)
private com.sun.jersey.api.client.WebResource	resource()
void	startContainer(String containerId) Start a docker container.
void	startContainer(String containerId, HostConfig hostConfig) Start a docker container.
void	tag(String image, String name) Tag a docker image.
Version	version() Get the docker version.
ContainerExit	waitContainer(String containerId) Wait for a docker container to exit.

Methods inherited from class java.lang.Object

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

Field Detail

NO_TIMEOUT

public static final long NO_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CONNECT_TIMEOUT_MILLIS

private static final long DEFAULT_CONNECT_TIMEOUT_MILLIS

DEFAULT_READ_TIMEOUT_MILLIS

private static final long DEFAULT_READ_TIMEOUT_MILLIS

log

private static final org.slf4j.Logger log

VERSION

private static final String VERSION

See Also:

Constant Field Values

CLIENT_CONFIG

private static final com.sun.jersey.api.client.config.DefaultClientConfig CLIENT_CONFIG

CONTAINER_NAME_PATTERN

private static final Pattern CONTAINER_NAME_PATTERN

CONTAINER_LIST

private static final com.sun.jersey.api.client.GenericType<List<Container>> CONTAINER_LIST

REMOVED_IMAGE_LIST

private static final com.sun.jersey.api.client.GenericType<List<RemovedImage>> REMOVED_IMAGE_LIST

CLIENT_COUNTER

private static final AtomicInteger CLIENT_COUNTER

executor

private final ExecutorService executor

clientHandler

private final InterruptibleURLConnectionClientHandler clientHandler

client

private final com.sun.jersey.api.client.Client client

uri

private final URI uri

Constructor Detail

DefaultDockerClient

public DefaultDockerClient(String uri)

Create a new client with default configuration.

Parameters:

uri - The docker rest api uri.

DefaultDockerClient

public DefaultDockerClient(URI uri)

Create a new client with default configuration.

Parameters:

uri - The docker rest api uri.

DefaultDockerClient

private DefaultDockerClient(DefaultDockerClient.Builder builder)

Create a new client using the configuration of the builder.

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

version

public Version version()
                throws DockerException,
                       InterruptedException

Description copied from interface: DockerClient

Get the docker version.

Specified by:

version in interface DockerClient

Throws:

DockerException

InterruptedException

info

public Info info()
          throws DockerException,
                 InterruptedException

Description copied from interface: DockerClient

Get docker instance information.

Specified by:

info in interface DockerClient

Throws:

DockerException

InterruptedException

listContainers

public List<Container> listContainers(DockerClient.ListContainersParam... params)
                               throws DockerException,
                                      InterruptedException

Description copied from interface: DockerClient

List docker containers.

Specified by:

listContainers in interface DockerClient

Parameters:

params - Container listing and filtering options.

Returns:

A list of containers.

Throws:

DockerException

InterruptedException

createContainer

public ContainerCreation createContainer(ContainerConfig config)
                                  throws DockerException,
                                         InterruptedException

Description copied from interface: DockerClient

Create a docker container.

Specified by:

createContainer in interface DockerClient

Parameters:

config - The container configuration.

Returns:

Container creation result with container id and eventual warnings from docker.

Throws:

ImageNotFoundException - if the image was not found (404).

DockerException

InterruptedException

createContainer

public ContainerCreation createContainer(ContainerConfig config,
                                String name)
                                  throws DockerException,
                                         InterruptedException

Description copied from interface: DockerClient

Create a docker container.

Specified by:

createContainer in interface DockerClient

Parameters:

config - The container configuration.

name - The container name.

Returns:

Container creation result with container id and eventual warnings from docker.

Throws:

ImageNotFoundException - if the image was not found (404).

DockerException

InterruptedException

startContainer

public void startContainer(String containerId)
                    throws DockerException,
                           InterruptedException

Description copied from interface: DockerClient

Start a docker container.

Specified by:

startContainer in interface DockerClient

Parameters:

containerId - The id of the container to start.

Throws:

ContainerNotFoundException - if the container was not found (404).

DockerException

InterruptedException

startContainer

public void startContainer(String containerId,
                  HostConfig hostConfig)
                    throws DockerException,
                           InterruptedException

Description copied from interface: DockerClient

Start a docker container.

Specified by:

startContainer in interface DockerClient

Parameters:

containerId - The id of the container to start.

hostConfig - The docker host configuration to use when starting the container.

Throws:

ContainerNotFoundException - if the container was not found (404).

DockerException

InterruptedException

killContainer

public void killContainer(String containerId)
                   throws DockerException,
                          InterruptedException

Description copied from interface: DockerClient

Kill a docker container.

Specified by:

killContainer in interface DockerClient

Parameters:

containerId - The id of the container to kill.

Throws:

ContainerNotFoundException - if the container was not found (404).

DockerException

InterruptedException

waitContainer

public ContainerExit waitContainer(String containerId)
                            throws DockerException,
                                   InterruptedException

Description copied from interface: DockerClient

Wait for a docker container to exit.

Specified by:

waitContainer in interface DockerClient

Parameters:

containerId - The id of the container to wait for.

Returns:

Exit response with status code.

Throws:

ContainerNotFoundException - if the container was not found (404).

DockerException

InterruptedException

removeContainer

public void removeContainer(String containerId)
                     throws DockerException,
                            InterruptedException

Description copied from interface: DockerClient

Remove a docker container.

Specified by:

removeContainer in interface DockerClient

Parameters:

containerId - The id of the container to remove.

Throws:

ContainerNotFoundException - if the container was not found (404).

DockerException

InterruptedException

removeContainer

public void removeContainer(String containerId,
                   boolean removeVolumes)
                     throws DockerException,
                            InterruptedException

Description copied from interface: DockerClient

Remove a docker container.

Specified by:

removeContainer in interface DockerClient

Parameters:

containerId - The id of the container to remove.

removeVolumes - Whether to remove volumes as well.

Throws:

ContainerNotFoundException - if the container was not found (404).

DockerException

InterruptedException

inspectContainer

public ContainerInfo inspectContainer(String containerId)
                               throws DockerException,
                                      InterruptedException

Description copied from interface: DockerClient

Inspect a docker container.

Specified by:

inspectContainer in interface DockerClient

Parameters:

containerId - The id of the container to inspect.

Returns:

Info about the container.

Throws:

ContainerNotFoundException - if the container was not found (404).

DockerException

InterruptedException

pull

public void pull(String image)
          throws DockerException,
                 InterruptedException

Description copied from interface: DockerClient

Pull a docker container image.

Specified by:

pull in interface DockerClient

Parameters:

image - The image to pull.

Throws:

DockerException

InterruptedException

pull

public void pull(String image,
        ProgressHandler handler)
          throws DockerException,
                 InterruptedException

Description copied from interface: DockerClient

Pull a docker container image, using a custom ProgressMessageHandler

Specified by:

pull in interface DockerClient

Parameters:

image - The image to pull.

handler - The handler to use for processing each progress message received from Docker.

Throws:

DockerException

InterruptedException

push

public void push(String image)
          throws DockerException,
                 InterruptedException

Description copied from interface: DockerClient

Push a docker container image.

Specified by:

push in interface DockerClient

Parameters:

image - The image to push.

Throws:

DockerException

InterruptedException

push

public void push(String image,
        ProgressHandler handler)
          throws DockerException,
                 InterruptedException

Description copied from interface: DockerClient

Push a docker container image, using a custom ProgressHandler

Specified by:

push in interface DockerClient

Parameters:

image - The image to push.

handler - The handler to use for processing each progress message received from Docker.

Throws:

DockerException

InterruptedException

tag

public void tag(String image,
       String name)
         throws DockerException,
                InterruptedException

Description copied from interface: DockerClient

Tag a docker image.

Specified by:

tag in interface DockerClient

Parameters:

image - The image to tag.

name - The new name that will be applied to the image.

Throws:

DockerException

InterruptedException

build

public String build(Path directory,
           DockerClient.BuildParameter... params)
             throws DockerException,
                    InterruptedException,
                    IOException

Description copied from interface: DockerClient

Build a docker image.

Specified by:

build in interface DockerClient

Parameters:

directory - The directory containing the dockerfile.

params - Additional flags to use during build.

Returns:

The id of the built image if successful, otherwise null.

Throws:

DockerException

InterruptedException

IOException

build

public String build(Path directory,
           String name,
           DockerClient.BuildParameter... params)
             throws DockerException,
                    InterruptedException,
                    IOException

Description copied from interface: DockerClient

Build a docker image.

Specified by:

build in interface DockerClient

Parameters:

directory - The directory containing the dockerfile.

name - The repository name and optional tag to apply to the built image.

params - Additional flags to use during build.

Returns:

The id of the built image if successful, otherwise null.

Throws:

DockerException

InterruptedException

IOException

build

public String build(Path directory,
           ProgressHandler handler,
           DockerClient.BuildParameter... params)
             throws DockerException,
                    InterruptedException,
                    IOException

Description copied from interface: DockerClient

Build a docker image.

Specified by:

build in interface DockerClient

Parameters:

directory - The directory containing the dockerfile.

handler - The handler to use for processing each progress message received from Docker.

params - Additional flags to use during build.

Returns:

The id of the built image if successful, otherwise null.

Throws:

DockerException

InterruptedException

IOException

build

public String build(Path directory,
           String name,
           ProgressHandler handler,
           DockerClient.BuildParameter... params)
             throws DockerException,
                    InterruptedException,
                    IOException

Description copied from interface: DockerClient

Build a docker image.

Specified by:

build in interface DockerClient

Parameters:

directory - The directory containing the dockerfile.

name - The repository name and optional tag to apply to the built image.

handler - The handler to use for processing each progress message received from Docker.

params - Additional flags to use during build.

Returns:

The id of the built image if successful, otherwise null.

Throws:

DockerException

InterruptedException

IOException

inspectImage

public ImageInfo inspectImage(String image)
                       throws DockerException,
                              InterruptedException

Description copied from interface: DockerClient

Inspect a docker container image.

Specified by:

inspectImage in interface DockerClient

Parameters:

image - The image to inspect.

Returns:

Info about the image.

Throws:

ImageNotFoundException - if the image was not found (404).

DockerException

InterruptedException

removeImage

public List<RemovedImage> removeImage(String image)
                               throws DockerException,
                                      InterruptedException

Description copied from interface: DockerClient

Remove a docker image.

Specified by:

removeImage in interface DockerClient

Parameters:

image - The image to remove.

Returns:

A list describing each image which was removed.

Throws:

ImageNotFoundException - if the image was not found (404).

DockerException

InterruptedException

removeImage

public List<RemovedImage> removeImage(String image,
                             boolean force,
                             boolean noPrune)
                               throws DockerException,
                                      InterruptedException

Description copied from interface: DockerClient

Remove a docker image.

Specified by:

removeImage in interface DockerClient

Parameters:

image - The image to remove.

force - Force image removal.

noPrune - Do not delete untagged parents.

Returns:

A list describing each image which was removed.

Throws:

ImageNotFoundException - if the image was not found (404).

DockerException

InterruptedException

logs

public LogStream logs(String containerId,
             DockerClient.LogsParameter... params)
               throws DockerException,
                      InterruptedException

Description copied from interface: DockerClient

Get docker container logs.

Specified by:

logs in interface DockerClient

Parameters:

containerId - The id of the container to get logs for.

params - Params for controlling what streams to get and whether to tail or not.

Returns:

A log message stream.

Throws:

ContainerNotFoundException - if the container was not found (404).

DockerException

InterruptedException

resource

private com.sun.jersey.api.client.WebResource resource()

request

private <T> T request(String method,
            com.sun.jersey.api.client.GenericType<T> type,
            com.sun.jersey.api.client.WebResource resource,
            com.sun.jersey.api.client.WebResource.Builder request)
           throws DockerException,
                  InterruptedException

Throws:

DockerException

InterruptedException

request

private <T> T request(String method,
            Class<T> clazz,
            com.sun.jersey.api.client.WebResource resource,
            com.sun.jersey.api.client.UniformInterface request)
           throws DockerException,
                  InterruptedException

Throws:

DockerException

InterruptedException

request

private void request(String method,
           com.sun.jersey.api.client.WebResource resource,
           com.sun.jersey.api.client.UniformInterface request)
              throws DockerException,
                     InterruptedException

Throws:

DockerException

InterruptedException

propagate

private DockerRequestException propagate(String method,
                               com.sun.jersey.api.client.WebResource resource,
                               com.sun.jersey.api.client.UniformInterfaceException e)

propagate

private RuntimeException propagate(String method,
                         com.sun.jersey.api.client.WebResource resource,
                         com.sun.jersey.api.client.ClientHandlerException e)
                            throws DockerException,
                                   InterruptedException

Throws:

DockerException

InterruptedException

message

private String message(com.sun.jersey.api.client.ClientResponse response)

multivaluedMap

private javax.ws.rs.core.MultivaluedMap<String,String> multivaluedMap(com.google.common.collect.Multimap<String,String> map)

builder

public static DefaultDockerClient.Builder builder()

Create a new DefaultDockerClient builder.