com.spotify.docker.client

Interface DockerClient

All Known Implementing Classes:

DefaultDockerClient

public interface DockerClient

A client for interacting with dockerd. Note: All methods throw DockerException on unexpected docker response status codes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DockerClient.ListContainersParam Parameters for listContainers(ListContainersParam...)
static class	DockerClient.LogsParameter Parameters for logs(String, LogsParameter...)

Method Summary

Methods

Modifier and Type	Method and Description
ContainerCreation	createContainer(ContainerConfig config) Create a docker container.
ContainerCreation	createContainer(ContainerConfig config, String name) Create a docker container.
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.
void	pull(String image) Pull a docker container image.
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.
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.

Method Detail

version

Version version()
                throws DockerException,
                       InterruptedException

Get the docker version.

Throws:

DockerException

InterruptedException

listContainers

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

List docker containers.

Parameters:

params - Container listing and filtering options.

Returns:

A list of containers.

Throws:

DockerException

InterruptedException

inspectContainer

ContainerInfo inspectContainer(String containerId)
                               throws DockerException,
                                      InterruptedException

Inspect a docker container.

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

inspectImage

ImageInfo inspectImage(String image)
                       throws DockerException,
                              InterruptedException

Inspect a docker container image.

Parameters:

image - The image to inspect.

Returns:

Info about the image.

Throws:

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

DockerException

InterruptedException

removeImage

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

Remove a docker image.

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

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

Remove a docker image.

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

pull

void pull(String image)
          throws DockerException,
                 InterruptedException

Pull a docker container image.

Parameters:

image - The image to pull.

Throws:

DockerException

InterruptedException

tag

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

Tag a docker image.

Parameters:

image - The image to tag.

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

Throws:

DockerException

InterruptedException

createContainer

ContainerCreation createContainer(ContainerConfig config)
                                  throws DockerException,
                                         InterruptedException

Create a docker container.

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

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

Create a docker container.

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

void startContainer(String containerId)
                    throws DockerException,
                           InterruptedException

Start a docker container.

Parameters:

containerId - The id of the container to start.

Throws:

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

DockerException

InterruptedException

startContainer

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

Start a docker container.

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

waitContainer

ContainerExit waitContainer(String containerId)
                            throws DockerException,
                                   InterruptedException

Wait for a docker container to exit.

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

killContainer

void killContainer(String containerId)
                   throws DockerException,
                          InterruptedException

Kill a docker container.

Parameters:

containerId - The id of the container to kill.

Throws:

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

DockerException

InterruptedException

removeContainer

void removeContainer(String containerId)
                     throws DockerException,
                            InterruptedException

Remove a docker container.

Parameters:

containerId - The id of the container to remove.

Throws:

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

DockerException

InterruptedException

removeContainer

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

Remove a docker container.

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

logs

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

Get docker container logs.

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