Package org.mandas.docker.client

Class DefaultDockerClient

java.lang.Object

org.mandas.docker.client.DefaultDockerClient

All Implemented Interfaces:

Closeable, AutoCloseable, DockerClient

public class DefaultDockerClient
extends Object
implements DockerClient, Closeable

Nested Class Summary

Nested classes/interfaces inherited from interface org.mandas.docker.client.DockerClient

DockerClient.AttachParameter, DockerClient.BuildParam, DockerClient.EventsFilterParam, DockerClient.EventsParam, DockerClient.ExecCreateParam, DockerClient.ExecStartParameter, DockerClient.FilterParam, DockerClient.ListContainersFilterParam, DockerClient.ListContainersParam, DockerClient.ListImagesFilterParam, DockerClient.ListImagesParam, DockerClient.ListNetworksFilterParam, DockerClient.ListNetworksParam, DockerClient.ListVolumesFilterParam, DockerClient.ListVolumesParam, DockerClient.LogsParam, DockerClient.Param, DockerClient.RemoveContainerParam, DockerClient.Signal

Constructor Summary

Constructors

Constructor	Description
DefaultDockerClient(String apiVersion, RegistryAuthSupplier authSupplier, URI uri, jakarta.ws.rs.client.Client client, jakarta.ws.rs.client.Client notimeoutClient, Map<String,Object> headers)	Create a new client using the configuration of the builder.

Method Summary

Modifier and Type	Method	Description
InputStream	archiveContainer(String containerId, String path)	Copies an archive out of a container.
LogStream	attachContainer(String containerId, DockerClient.AttachParameter... params)	Attach to the container id.
int	auth(RegistryAuth registryAuth)	Check auth configuration.
String	build(Path directory, String name, String dockerfile, ProgressHandler handler, DockerClient.BuildParam... params)	Build a docker image.
String	build(Path directory, String name, DockerClient.BuildParam... params)	Build a docker image.
String	build(Path directory, String name, ProgressHandler handler, DockerClient.BuildParam... params)	Build a docker image.
String	build(Path directory, DockerClient.BuildParam... params)	Build a docker image.
String	build(Path directory, ProgressHandler handler, DockerClient.BuildParam... params)	Build a docker image.
void	close()	Closes any and all underlying connections to docker, and release resources.
ContainerCreation	commitContainer(String containerId, String repo, String tag, ContainerConfig config, String comment, String author)	Create a new image from a container's changes.
void	connectToNetwork(String containerId, String networkId)	Connects a docker container to a network.
void	connectToNetwork(String networkId, NetworkConnection networkConnection)	Connects a docker container to a network, with extended configuration.
void	copyToContainer(InputStream tarStream, String containerId, String path)
void	copyToContainer(Path directory, String containerId, String path)	Copies some files from host to container.
void	create(String image, InputStream imagePayload)	Creates a single image from a tarball.
void	create(String image, InputStream imagePayload, ProgressHandler handler)	Creates a single image from a tarball.
ConfigCreateResponse	createConfig(ConfigSpec config)	Create a config.
ContainerCreation	createContainer(ContainerConfig config)	Create a docker container.
ContainerCreation	createContainer(ContainerConfig config, String name)	Create a docker container.
NetworkCreation	createNetwork(NetworkConfig networkConfig)	Create a new network.
SecretCreateResponse	createSecret(SecretSpec secret)	Create a secret.
ServiceCreateResponse	createService(ServiceSpec spec)	Create a new service.
ServiceCreateResponse	createService(ServiceSpec spec, RegistryAuth config)	Create a new service.
Volume	createVolume()
Volume	createVolume(Volume volume)
void	deleteConfig(String configId)	Delete a config.
void	deleteNode(String nodeId)	Remove a node from the swarm.
void	deleteNode(String nodeId, boolean force)	Remove a node from the swarm.
void	deleteSecret(String secretId)	Delete a secret.
void	disconnectFromNetwork(String containerId, String networkId)	Disconnects a docker container to a network.
void	disconnectFromNetwork(String containerId, String networkId, boolean force)	Disconnects a docker container to a network.
EventStream	events(DockerClient.EventsParam... params)	Watches the docker API for events.
ExecCreation	execCreate(String containerId, String[] cmd, DockerClient.ExecCreateParam... params)	Sets up an exec instance in a running container id.
ExecState	execInspect(String execId)	Inspects a running or previously run exec instance id.
void	execResizeTty(String execId, Integer height, Integer width)	Resizes the tty session used by an exec command.
LogStream	execStart(String execId, DockerClient.ExecStartParameter... params)	Starts a previously set up exec instance id.
InputStream	exportContainer(String containerId)	Export a docker container as a tar archive.
Distribution	getDistribution(String imageName)	Get the distribution of a container.
String	getHost()	Get the Docker host address.
List<ImageHistory>	history(String image)	Return the history of the image.
Info	info()	Get docker instance information.
String	initSwarm(SwarmInit swarmInit)	Initialize a new swarm.
Config	inspectConfig(String configId)	Inspect a config.
ContainerInfo	inspectContainer(String containerId)	Inspect a docker container.
List<ContainerChange>	inspectContainerChanges(String containerId)	Inspect changes on a container's filesystem.
ImageInfo	inspectImage(String image)	Inspect a docker container image.
Network	inspectNetwork(String networkId)	Inspect a specific network.
NodeInfo	inspectNode(String nodeId)	Inspects a swarm node.
Secret	inspectSecret(String secretId)	Inspect a secret.
Service	inspectService(String serviceId)	Inspect an existing service.
Swarm	inspectSwarm()	Inspect the swarm.
Task	inspectTask(String taskId)	Inspect an existing task.
Volume	inspectVolume(String volumeName)
void	joinSwarm(SwarmJoin swarmJoin)	Join an existing swarm.
void	killContainer(String containerId)	Kill a docker container.
void	killContainer(String containerId, DockerClient.Signal signal)	Kill a docker container.
void	leaveSwarm()	Leave a swarm.
void	leaveSwarm(boolean force)	Leave a swarm forcefully.
List<Config>	listConfigs()	List swarm configs.
List<Config>	listConfigs(Config.Criteria criteria)	List swarm configs.
List<Container>	listContainers(DockerClient.ListContainersParam... params)	List docker containers.
List<Image>	listImages(DockerClient.ListImagesParam... params)	List docker images.
List<Network>	listNetworks(DockerClient.ListNetworksParam... params)	List all or a subset of the networks.
List<Node>	listNodes()	List swarm nodes.
List<Node>	listNodes(Node.Criteria criteria)	List swarm nodes that match the given criteria.
List<Secret>	listSecrets()	List secrets.
List<Secret>	listSecrets(Secret.Criteria criteria)	List secrets with criteria.
List<Service>	listServices()	List all services.
List<Service>	listServices(Service.Criteria criteria)	List services that match the given criteria.
List<Task>	listTasks()	List all tasks.
List<Task>	listTasks(Task.Criteria criteria)	List tasks that match the given criteria.
VolumeList	listVolumes(DockerClient.ListVolumesParam... params)
Set<String>	load(InputStream imagePayload)	Load a set of images and tags from a tarball.
Set<String>	load(InputStream imagePayload, ProgressHandler handler)	Load a set of images and tags from a tarball, using a custom ProgressMessageHandler.
LogStream	logs(String containerId, DockerClient.LogsParam... params)	Get docker container logs.
void	pauseContainer(String containerId)	Pause a docker container.
String	ping()	Ping the docker daemon.
void	pull(String image)	Pull a docker container image.
void	pull(String image, RegistryAuth registryAuth)	Pull a private docker container image.
void	pull(String image, RegistryAuth registryAuth, ProgressHandler handler)	Pull a private docker container image, using a custom ProgressMessageHandler.
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, RegistryAuth registryAuth)
void	push(String image, ProgressHandler handler)	Push a docker container image, using a custom ProgressHandler
void	push(String image, ProgressHandler handler, RegistryAuth registryAuth)
void	removeContainer(String containerId)	Remove a docker container.
void	removeContainer(String containerId, DockerClient.RemoveContainerParam... params)	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	removeNetwork(String networkId)	Remove a docker network.
void	removeService(String serviceId)	Remove an existing service.
void	removeVolume(String volumeName)
void	removeVolume(Volume volume)
void	renameContainer(String containerId, String name)	Rename a docker container.
void	resizeTty(String containerId, Integer height, Integer width)	Resize container TTY This API is valid only if tty was specified as part of creating the container.
void	restartContainer(String containerId)	Restart a docker container.
void	restartContainer(String containerId, int secondsToWaitBeforeRestart)	Restart a docker container.
InputStream	save(String... images)	Get a tarball containing all images and metadata for the repository specified.
InputStream	saveMultiple(String... images)	Get a tarball containing all images and metadata for one or more repositories.
List<ImageSearchResult>	searchImages(String term)	Search for images on Docker Hub
LogStream	serviceLogs(String serviceId, DockerClient.LogsParam... params)	Get docker service logs.
void	startContainer(String containerId)	Start a docker container.
ContainerStats	stats(String containerId)	Retrieves one-time stats (stream=0) for the container with the specified id.
void	stopContainer(String containerId, int secondsToWaitBeforeKilling)	Stop a docker container by sending a SIGTERM, and following up with a SIGKILL if the container doesn't exit gracefully and in a timely manner.
void	tag(String image, String name)	Tag a docker image.
void	tag(String image, String name, boolean force)	Tag a docker image.
TopResults	topContainer(String containerId)	List processes running inside the container by using ps.
TopResults	topContainer(String containerId, String psArgs)	List processes running inside the container using ps and the given arguments.
void	unlock(UnlockKey unlockKey)	Unlock a swarm.
UnlockKey	unlockKey()	Get an unlock key for unlocking a swarm.
void	unpauseContainer(String containerId)	Unpause a docker container.
void	updateConfig(String configId, Long version, ConfigSpec nodeSpec)	Update a swarm config.
ContainerUpdate	updateContainer(String containerId, HostConfig config)	Update an existing container.
void	updateNode(String nodeId, Long version, NodeSpec nodeSpec)	Update a swarm node.
void	updateService(String serviceId, Long version, ServiceSpec spec)	Update an existing service.
void	updateService(String serviceId, Long version, ServiceSpec spec, RegistryAuth config)	Update an existing service.
void	updateSwarm(Long version, boolean rotateWorkerToken, boolean rotateManagerToken, boolean rotateManagerUnlockKey, SwarmSpec spec)	Update a swarm.
void	updateSwarm(Long version, boolean rotateWorkerToken, boolean rotateManagerToken, SwarmSpec spec)	Update a swarm.
void	updateSwarm(Long version, boolean rotateWorkerToken, SwarmSpec spec)	Update a swarm.
void	updateSwarm(Long version, SwarmSpec spec)	Update a swarm.
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

Constructor Details

DefaultDockerClient

public DefaultDockerClient(String apiVersion,
 RegistryAuthSupplier authSupplier,
 URI uri,
 jakarta.ws.rs.client.Client client,
 jakarta.ws.rs.client.Client notimeoutClient,
 Map<String,Object> headers)

Create a new client using the configuration of the builder.

Parameters:

apiVersion - the specific API version of the Docker engine

authSupplier - credentials supplier for the docker registry

uri - the Docker engine URI

client - the JAX-RS client for issuing the calls to the docker engine

notimeoutClient - the JAX-RS client for issuing the calls to the docker engine (without timeout)

headers - a custom set of HTTP headers

Method Details

getHost

public String getHost()

Description copied from interface: DockerClient

Get the Docker host address.

Specified by:

getHost in interface DockerClient

Returns:

the docker host name or IP

close

public void close()

Description copied from interface: DockerClient

Closes any and all underlying connections to docker, and release resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface DockerClient

ping

public String ping()
            throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Ping the docker daemon. Returns "OK" if all is well, though that it simply returns a 200 status is probably sufficient information.

Specified by:

ping in interface DockerClient

Returns:

String "OK"

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

version

public Version version()
                throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Get the docker version.

Specified by:

version in interface DockerClient

Returns:

docker version

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

auth

public int auth(RegistryAuth registryAuth)
         throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Check auth configuration.

Specified by:

auth in interface DockerClient

Parameters:

registryAuth - The RegistryAuth needed to pull the image.

Returns:

status code of auth request

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

info

public Info info()
          throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Get docker instance information.

Specified by:

info in interface DockerClient

Returns:

docker info

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

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:

BadParamException - if one or more params were bad (400)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

listImages

public List<Image> listImages(DockerClient.ListImagesParam... params)
                       throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List docker images.

Specified by:

listImages in interface DockerClient

Parameters:

params - Image listing and filtering options.

Returns:

A list of images.

Throws:

BadParamException - if one or more params were bad (400)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

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 requested parent image was not found (404)

DockerException - if logs cannot be attached, because container is not running (406), or if a server error occurred (500)

InterruptedException - If the thread is interrupted

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 requested parent image was not found (404)

DockerException - if logs cannot be attached, because container is not running (406), or if a server error occurred (500)

InterruptedException - If the thread is interrupted

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 container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

pauseContainer

public void pauseContainer(String containerId)
                    throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Pause a docker container.

Specified by:

pauseContainer in interface DockerClient

Parameters:

containerId - The id of the container to pause.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

unpauseContainer

public void unpauseContainer(String containerId)
                      throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Unpause a docker container.

Specified by:

unpauseContainer in interface DockerClient

Parameters:

containerId - The id of the container to pause.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

restartContainer

public void restartContainer(String containerId)
                      throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Restart a docker container. with a 10 second default wait

Specified by:

restartContainer in interface DockerClient

Parameters:

containerId - The id of the container to restart.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

restartContainer

public void restartContainer(String containerId,
 int secondsToWaitBeforeRestart)
                      throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Restart a docker container.

Specified by:

restartContainer in interface DockerClient

Parameters:

containerId - The id of the container to restart.

secondsToWaitBeforeRestart - number of seconds to wait before killing the container.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

killContainer

public void killContainer(String containerId)
                   throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Kill a docker container. Note: by default SIGKILL is sent.

Specified by:

killContainer in interface DockerClient

Parameters:

containerId - The id of the container to kill.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

killContainer

public void killContainer(String containerId,
 DockerClient.Signal signal)
                   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.

signal - Signal used to kill the process.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

getDistribution

public Distribution getDistribution(String imageName)
                             throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Get the distribution of a container.

Specified by:

getDistribution in interface DockerClient

Parameters:

imageName - The name of the container.

Returns:

the container's distribution

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

stopContainer

public void stopContainer(String containerId,
 int secondsToWaitBeforeKilling)
                   throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Stop a docker container by sending a SIGTERM, and following up with a SIGKILL if the container doesn't exit gracefully and in a timely manner.

Specified by:

stopContainer in interface DockerClient

Parameters:

containerId - The id of the container to stop.

secondsToWaitBeforeKilling - Time to wait after SIGTERM before sending SIGKILL.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

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 container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

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:

BadParamException - if one or more params were bad (400)

ContainerNotFoundException - if container is not found (404)

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

removeContainer

public void removeContainer(String containerId,
 DockerClient.RemoveContainerParam... params)
                     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.

params - DockerClient.RemoveContainerParam

Throws:

BadParamException - if one or more params were bad (400)

ContainerNotFoundException - if container is not found (404)

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

exportContainer

public InputStream exportContainer(String containerId)
                            throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Export a docker container as a tar archive.

Specified by:

exportContainer in interface DockerClient

Parameters:

containerId - The id of the container to export.

Returns:

A stream in tar format that contains the contents of the container file system.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

archiveContainer

public InputStream archiveContainer(String containerId,
 String path)
                             throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Copies an archive out of a container. (API version 1.20+)

Specified by:

archiveContainer in interface DockerClient

Parameters:

containerId - The id of the container to copy files from.

path - The path inside of the container to copy. If this is a directory, it will be copied recursively. If this is a file, only that file will be copied.

Returns:

A stream in tar format that contains the copied files. If a directory was copied, the directory will be at the root of the tar archive (so copy(..., "/usr/share") will result in a directory called share in the tar archive). The directory name is completely resolved, so copying "/usr/share/././." will still create a directory called "share" in the tar archive. If a single file was copied, that file will be the sole entry in the tar archive. Copying "." or equivalently "/" will result in the tar archive containing a single folder named after the container ID.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

topContainer

public TopResults topContainer(String containerId)
                        throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List processes running inside the container by using ps.

Specified by:

topContainer in interface DockerClient

Parameters:

containerId - the id of the container to examine

Returns:

the titles and process list for the container

Throws:

DockerException - if a server error occurred (500).

InterruptedException - if the thread is interrupted.

topContainer

public TopResults topContainer(String containerId,
 String psArgs)
                        throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List processes running inside the container using ps and the given arguments.

Specified by:

topContainer in interface DockerClient

Parameters:

containerId - the id of the container to examine

psArgs - the arguments to pass to ps inside the container, e.g., "-ef"

Returns:

the titles and process list for the container

Throws:

DockerException - if a server error occurred (500).

InterruptedException - if the thread is interrupted.

copyToContainer

public void copyToContainer(Path directory,
 String containerId,
 String path)
                     throws DockerException,
InterruptedException,
IOException

Description copied from interface: DockerClient

Copies some files from host to container. (API version 1.20+)

Specified by:

copyToContainer in interface DockerClient

Parameters:

directory - The path to sent to container

containerId - The id of the container to sent files.

path - The path inside of the container to put files.

Throws:

BadParamException - if one or more params were bad (400)

PermissionException - if the volume or container root file system is marked "read only"

ContainerNotFoundException - if container is not found (404)

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

IOException - If IOException

copyToContainer

public void copyToContainer(InputStream tarStream,
 String containerId,
 String path)
                     throws DockerException,
InterruptedException

Specified by:

copyToContainer in interface DockerClient

Throws:

DockerException

InterruptedException

inspectContainerChanges

public List<ContainerChange> inspectContainerChanges(String containerId)
                                              throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Inspect changes on a container's filesystem.

Specified by:

inspectContainerChanges in interface DockerClient

Parameters:

containerId - The id of the container.

Returns:

A list of the changes to the container file system.

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

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 container was not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

commitContainer

public ContainerCreation commitContainer(String containerId,
 String repo,
 String tag,
 ContainerConfig config,
 String comment,
 String author)
                                  throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Create a new image from a container's changes.

Specified by:

commitContainer in interface DockerClient

Parameters:

containerId - The id of the container to commit.

repo - repository to commit to.

tag - image tag.

config - ContainerConfig to commit.

comment - commit message.

author - image author.

Returns:

ContainerCreation reply.

Throws:

ContainerNotFoundException - if container was not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

renameContainer

public void renameContainer(String containerId,
 String name)
                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Rename a docker container.

Specified by:

renameContainer in interface DockerClient

Parameters:

containerId - The id of the container to rename.

name - The new name the container will have

Throws:

ContainerNotFoundException - if container cannot be found (404)

ContainerRenameConflictException - if name is already assigned (409)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

updateContainer

public ContainerUpdate updateContainer(String containerId,
 HostConfig config)
                                throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Update an existing container. Only available in Docker API >= 1.22.

Specified by:

updateContainer in interface DockerClient

Parameters:

containerId - the identifier of the container

config - the new container host config

Returns:

the updated container

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

searchImages

public List<ImageSearchResult> searchImages(String term)
                                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Search for images on Docker Hub

This method is broken for Docker 1.7.x because of a Docker bug. See https://github.com/docker/docker/pull/14850.

Specified by:

searchImages in interface DockerClient

Parameters:

term - the search term

Returns:

a list of matches for the given search term

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

load

public Set<String> load(InputStream imagePayload)
                 throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Load a set of images and tags from a tarball.

Specified by:

load in interface DockerClient

Parameters:

imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).

Returns:

a set of all loaded images

Throws:

DockerException - if a server error occurred (500).

InterruptedException - if the thread is interrupted.

load

public Set<String> load(InputStream imagePayload,
 ProgressHandler handler)
                 throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Load a set of images and tags from a tarball, using a custom ProgressMessageHandler.

Specified by:

load in interface DockerClient

Parameters:

imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).

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

Returns:

a set of all loaded images

Throws:

DockerException - if a server error occurred (500).

InterruptedException - if the thread is interrupted.

create

public void create(String image,
 InputStream imagePayload)
            throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Creates a single image from a tarball. This method also tags the image with the given image name upon loading completion.

Specified by:

create in interface DockerClient

Parameters:

image - the name to assign to the image.

imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).

Throws:

DockerException - if a server error occurred (500).

InterruptedException - if the thread is interrupted.

create

public void create(String image,
 InputStream imagePayload,
 ProgressHandler handler)
            throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Creates a single image from a tarball. This method also tags the image with the given image name upon loading completion.

Specified by:

create in interface DockerClient

Parameters:

image - the name to assign to the image.

imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).

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

Throws:

DockerException - if a server error occurred (500).

InterruptedException - if the thread is interrupted.

save

public InputStream save(String... images)
                 throws DockerException,
IOException,
InterruptedException

Description copied from interface: DockerClient

Get a tarball containing all images and metadata for the repository specified.

Specified by:

save in interface DockerClient

Parameters:

images - the name(s) of one or more images to save. If a specific name and tag (e.g. ubuntu:latest), then only that image (and its parents) are returned. If an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the 'repositories' file in the tarball, as there were no image names referenced.

Returns:

the images' .tar streams.

Throws:

DockerException - if a server error occurred (500).

IOException - if the server started returning, but an I/O error occurred in the context of processing it on the client-side.

InterruptedException - if the thread is interrupted.

saveMultiple

public InputStream saveMultiple(String... images)
                         throws DockerException,
IOException,
InterruptedException

Description copied from interface: DockerClient

Get a tarball containing all images and metadata for one or more repositories.

Specified by:

saveMultiple in interface DockerClient

Parameters:

images - the name or id of the image to save. if it is a specific name and tag (e.g. ubuntu:latest), then only that image (and its parents) are returned; if it is an image ID, similarly only that image (and its parents) are returned and there would be no names referenced in the 'repositories' file for this image ID.

Returns:

a tar stream containing the image(s)

Throws:

DockerException - if a server error occurred (500).

IOException - if the server started returning, but an I/O error occurred in the context of processing it on the client-side.

InterruptedException - if the thread is interrupted.

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:

ImageNotFoundException - if image was not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

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:

ImageNotFoundException - if image was not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

pull

public void pull(String image,
 RegistryAuth registryAuth)
          throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Pull a private docker container image.

Specified by:

pull in interface DockerClient

Parameters:

image - The image to pull.

registryAuth - The RegistryAuth needed to pull the image.

Throws:

ImageNotFoundException - if image was not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

pull

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

Description copied from interface: DockerClient

Pull a private docker container image, using a custom ProgressMessageHandler.

Specified by:

pull in interface DockerClient

Parameters:

image - The image to pull.

registryAuth - The RegistryAuth needed to pull the image.

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

Throws:

ImageNotFoundException - if image was not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

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:

ImageNotFoundException - if image was not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

push

public void push(String image,
 RegistryAuth registryAuth)
          throws DockerException,
InterruptedException

Specified by:

push in interface DockerClient

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:

ImageNotFoundException - if image was not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

push

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

Specified by:

push in interface DockerClient

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:

BadParamException - if one or more params were bad (400)

ImageNotFoundException - if image was not found (404)

ConflictException - conflict (409)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

tag

public void tag(String image,
 String name,
 boolean force)
         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.

force - Whether to force the tagging even if the tag is already assigned to another image.

Throws:

BadParamException - if one or more params were bad (400)

ImageNotFoundException - if image was not found (404)

ConflictException - conflict (409)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

build

public String build(Path directory,
 DockerClient.BuildParam... 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 - if a server error occurred (500)

InterruptedException - If the thread is interrupted

IOException - If some IO shit happened.

build

public String build(Path directory,
 String name,
 DockerClient.BuildParam... 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 - if a server error occurred (500)

InterruptedException - If the thread is interrupted

IOException - If some IO shit happened.

build

public String build(Path directory,
 ProgressHandler handler,
 DockerClient.BuildParam... 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 - if a server error occurred (500)

InterruptedException - If the thread is interrupted

IOException - If some IO shit happened.

build

public String build(Path directory,
 String name,
 ProgressHandler handler,
 DockerClient.BuildParam... 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 - if a server error occurred (500)

InterruptedException - If the thread is interrupted

IOException - If some IO shit happened.

build

public String build(Path directory,
 String name,
 String dockerfile,
 ProgressHandler handler,
 DockerClient.BuildParam... 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.

dockerfile - The path within the build context to 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 - if a server error occurred (500)

InterruptedException - If the thread is interrupted

IOException - If some IO shit happened.

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 image was not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

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 image was not found (404)

ConflictException - conflict (409)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

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 image was not found (404)

ConflictException - conflict (409)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

history

public List<ImageHistory> history(String image)
                           throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Return the history of the image.

Specified by:

history in interface DockerClient

Parameters:

image - An image name or ID.

Returns:

A List of ImageHistory

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

logs

public LogStream logs(String containerId,
 DockerClient.LogsParam... 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:

BadParamException - if one or more params were bad (400)

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

events

public EventStream events(DockerClient.EventsParam... params)
                   throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Watches the docker API for events.

This method is broken for Docker 1.7.x because of a Docker bug. See https://github.com/docker/docker/issues/14354.

Specified by:

events in interface DockerClient

Parameters:

params - The parameters to apply to the events request

Returns:

An event stream

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

attachContainer

public LogStream attachContainer(String containerId,
 DockerClient.AttachParameter... params)
                          throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Attach to the container id.

Specified by:

attachContainer 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:

BadParamException - if one or more params were bad (400)

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

execCreate

public ExecCreation execCreate(String containerId,
 String[] cmd,
 DockerClient.ExecCreateParam... params)
                        throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Sets up an exec instance in a running container id.

Specified by:

execCreate in interface DockerClient

Parameters:

containerId - The id of the container

cmd - shell command

params - Exec params

Returns:

ExecCreation

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

execStart

public LogStream execStart(String execId,
 DockerClient.ExecStartParameter... params)
                    throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Starts a previously set up exec instance id. If detach is true, this API returns after starting the exec command. Otherwise, this API sets up an interactive session with the exec command.

Specified by:

execStart in interface DockerClient

Parameters:

execId - exec id

params - Exec start params

Returns:

exec output

Throws:

ExecNotFoundException - if exec instance is not found (404)

ExecStartConflictException - if container is paused (409)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

inspectSwarm

public Swarm inspectSwarm()
                   throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Inspect the swarm. Only available in Docker API >= 1.24.

Specified by:

inspectSwarm in interface DockerClient

Returns:

Info about a swarm

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

initSwarm

public String initSwarm(SwarmInit swarmInit)
                 throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Initialize a new swarm. Only available in Docker API >= 1.24.

Specified by:

initSwarm in interface DockerClient

Returns:

Node ID

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

joinSwarm

public void joinSwarm(SwarmJoin swarmJoin)
               throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Join an existing swarm. Only available in Docker API >= 1.24.

Specified by:

joinSwarm in interface DockerClient

Parameters:

swarmJoin - the swarm

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

leaveSwarm

public void leaveSwarm()
                throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Leave a swarm. Only available in Docker API >= 1.24.

Specified by:

leaveSwarm in interface DockerClient

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

leaveSwarm

public void leaveSwarm(boolean force)
                throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Leave a swarm forcefully. Only available in Docker API >= 1.24. Force leave swarm, even if this is the last manager or if leaving will break the cluster.

Specified by:

leaveSwarm in interface DockerClient

Parameters:

force - Whether to leave forcefully

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

updateSwarm

public void updateSwarm(Long version,
 boolean rotateWorkerToken,
 boolean rotateManagerToken,
 boolean rotateManagerUnlockKey,
 SwarmSpec spec)
                 throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Update a swarm. Only available in Docker API >= 1.24.

Specified by:

updateSwarm in interface DockerClient

Parameters:

version - The version number of the swarm object being updated. This is required to avoid conflicting writes.

rotateWorkerToken - Set to true to rotate the worker join token.

rotateManagerToken - Set to true to rotate the worker join token.

rotateManagerUnlockKey - Set to true to rotate the manager unlock key.

spec - SwarmSpec

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

updateSwarm

public void updateSwarm(Long version,
 boolean rotateWorkerToken,
 boolean rotateManagerToken,
 SwarmSpec spec)
                 throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Update a swarm. Only available in Docker API >= 1.24.

Specified by:

updateSwarm in interface DockerClient

Parameters:

version - The version number of the swarm object being updated. This is required to avoid conflicting writes.

rotateWorkerToken - Set to true to rotate the worker join token.

rotateManagerToken - Set to true to rotate the worker join token.

spec - SwarmSpec

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

updateSwarm

public void updateSwarm(Long version,
 boolean rotateWorkerToken,
 SwarmSpec spec)
                 throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Update a swarm. Only available in Docker API >= 1.24.

Specified by:

updateSwarm in interface DockerClient

Parameters:

version - The version number of the swarm object being updated. This is required to avoid conflicting writes.

rotateWorkerToken - Set to true to rotate the worker join token.

spec - SwarmSpec

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

updateSwarm

public void updateSwarm(Long version,
 SwarmSpec spec)
                 throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Update a swarm. Only available in Docker API >= 1.24.

Specified by:

updateSwarm in interface DockerClient

Parameters:

version - The version number of the swarm object being updated. This is required to avoid conflicting writes.

spec - SwarmSpec

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

unlockKey

public UnlockKey unlockKey()
                    throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Get an unlock key for unlocking a swarm. Only available in Docker API >= 1.25.

Specified by:

unlockKey in interface DockerClient

Returns:

UnlockKey

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

unlock

public void unlock(UnlockKey unlockKey)
            throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Unlock a swarm. Only available in Docker API >= 1.25.

Specified by:

unlock in interface DockerClient

Parameters:

unlockKey - UnlockKey

Throws:

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

createService

public ServiceCreateResponse createService(ServiceSpec spec)
                                    throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Create a new service. Only available in Docker API >= 1.24.

Specified by:

createService in interface DockerClient

Parameters:

spec - the service spec

Returns:

Service creation result with service id.

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

createService

public ServiceCreateResponse createService(ServiceSpec spec,
 RegistryAuth config)
                                    throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Create a new service. Only available in Docker API >= 1.24.

Specified by:

createService in interface DockerClient

Parameters:

spec - the service spec

config - the registry authentication configuration

Returns:

Service creation result with service id.

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

inspectService

public Service inspectService(String serviceId)
                       throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Inspect an existing service. Only available in Docker API >= 1.24.

Specified by:

inspectService in interface DockerClient

Parameters:

serviceId - the id of the service to inspect

Returns:

Info about the service

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

updateService

public void updateService(String serviceId,
 Long version,
 ServiceSpec spec)
                   throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Update an existing service. Only available in Docker API >= 1.24.

Specified by:

updateService in interface DockerClient

Parameters:

serviceId - the identifier of the service

version - the version of the service

spec - the new service spec

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

updateService

public void updateService(String serviceId,
 Long version,
 ServiceSpec spec,
 RegistryAuth config)
                   throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Update an existing service. Only available in Docker API >= 1.24.

Specified by:

updateService in interface DockerClient

Parameters:

serviceId - the identifier of the service

version - the version of the service

spec - the new service spec

config - the registry authentication configuration

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

listServices

public List<Service> listServices()
                           throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List all services. Only available in Docker API >= 1.24.

Specified by:

listServices in interface DockerClient

Returns:

A list of services.

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

listServices

public List<Service> listServices(Service.Criteria criteria)
                           throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List services that match the given criteria. Only available in Docker API >= 1.24.

Specified by:

listServices in interface DockerClient

Parameters:

criteria - Service listing and filtering options.

Returns:

A list of Services

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

removeService

public void removeService(String serviceId)
                   throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Remove an existing service. Only available in Docker API >= 1.24.

Specified by:

removeService in interface DockerClient

Parameters:

serviceId - the id of the service to remove

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

serviceLogs

public LogStream serviceLogs(String serviceId,
 DockerClient.LogsParam... params)
                      throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Get docker service logs.

Specified by:

serviceLogs in interface DockerClient

Parameters:

serviceId - The id of the service to get logs for.

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

Returns:

A log message stream.

Throws:

BadParamException - if one or more params were bad (400)

ServiceNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

inspectTask

public Task inspectTask(String taskId)
                 throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Inspect an existing task. Only available in Docker API >= 1.24.

Specified by:

inspectTask in interface DockerClient

Parameters:

taskId - the id of the task to inspect

Returns:

Info about the task

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

listTasks

public List<Task> listTasks()
                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List all tasks. Only available in Docker API >= 1.24.

Specified by:

listTasks in interface DockerClient

Returns:

A list of tasks.

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

listTasks

public List<Task> listTasks(Task.Criteria criteria)
                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List tasks that match the given criteria. Only available in Docker API >= 1.24.

Specified by:

listTasks in interface DockerClient

Parameters:

criteria - Task.Criteria

Returns:

A list of tasks.

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

listConfigs

public List<Config> listConfigs()
                         throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List swarm configs. Only available in Docker API >= 1.30.

Specified by:

listConfigs in interface DockerClient

Returns:

a list of configs

Throws:

DockerException - if a server error occurred (500)

InterruptedException - if the thread is interrupted

listConfigs

public List<Config> listConfigs(Config.Criteria criteria)
                         throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List swarm configs. Only available in Docker API >= 1.30.

Specified by:

listConfigs in interface DockerClient

Parameters:

criteria - Config listing and filtering options

Returns:

a list of configs.

Throws:

DockerException - if a server error occurred (500)

InterruptedException - if the thread is interrupted

createConfig

public ConfigCreateResponse createConfig(ConfigSpec config)
                                  throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Create a config. Only available in Docker API >= 1.30.

Specified by:

createConfig in interface DockerClient

Parameters:

config - The spec for the config.

Returns:

ConfigCreateResponse

Throws:

ConflictException - conflict (409)

DockerException - if node is not part of a swarm (503) or a server error occurred (500)

InterruptedException

inspectConfig

public Config inspectConfig(String configId)
                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Inspect a config. Only available in Docker API >= 1.30.

Specified by:

inspectConfig in interface DockerClient

Parameters:

configId - The id of the config.

Returns:

Config

Throws:

NotFoundException - config not found (404)

DockerException - if node is not part of a swarm (503) or a server error occurred (500)

InterruptedException

deleteConfig

public void deleteConfig(String configId)
                  throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Delete a config. Only available in Docker API >= 1.30.

Specified by:

deleteConfig in interface DockerClient

Parameters:

configId - The id of the config.

Throws:

NotFoundException - config not found (404)

DockerException - if node is not part of a swarm (503) or a server error occurred (500)

InterruptedException

updateConfig

public void updateConfig(String configId,
 Long version,
 ConfigSpec nodeSpec)
                  throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Update a swarm config. Only available in Docker API >= 1.30.

Specified by:

updateConfig in interface DockerClient

Parameters:

configId - The id of the config to update

version - The version number of the config object being updated. This is required to avoid conflicting writes

nodeSpec - the config specification

Throws:

NodeNotFoundException - If the config doesn't exist (404)

NonSwarmNodeException - If the config is not part of a swarm (503)

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

listNodes

public List<Node> listNodes()
                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List swarm nodes. Only available in Docker API >= 1.24.

Specified by:

listNodes in interface DockerClient

Returns:

A list of nodes.

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

listNodes

public List<Node> listNodes(Node.Criteria criteria)
                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List swarm nodes that match the given criteria. Only available in Docker API >= 1.24.

Specified by:

listNodes in interface DockerClient

Parameters:

criteria - Node listing and filtering options.

Returns:

A list of nodes.

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

inspectNode

public NodeInfo inspectNode(String nodeId)
                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Inspects a swarm node. Only available in Docker API >= 1.24.

Specified by:

inspectNode in interface DockerClient

Parameters:

nodeId - The id of the swarm node to inspect

Returns:

info about the node

Throws:

NonSwarmNodeException - if the node is not part of a swarm (503)

DockerException - if a server error occurred (500)

InterruptedException - if the thread is interrupted

updateNode

public void updateNode(String nodeId,
 Long version,
 NodeSpec nodeSpec)
                throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Update a swarm node. Only available in Docker API >= 1.24.

Specified by:

updateNode in interface DockerClient

Parameters:

nodeId - The id of the node to update

version - The version number of the node object being updated. This is required to avoid conflicting writes

nodeSpec - the node specification

Throws:

NodeNotFoundException - If the node doesn't exist (404)

NonSwarmNodeException - If the node is not part of a swarm (503)

DockerException - If a server error occurred (500)

InterruptedException - If the thread is interrupted

deleteNode

public void deleteNode(String nodeId)
                throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Remove a node from the swarm.

Specified by:

deleteNode in interface DockerClient

Parameters:

nodeId - The id of the node to remove.

Throws:

DockerException

InterruptedException

deleteNode

public void deleteNode(String nodeId,
 boolean force)
                throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Remove a node from the swarm.

Specified by:

deleteNode in interface DockerClient

Parameters:

nodeId - The id of the node to remove.

force - Forcefully remove the node.

Throws:

DockerException

InterruptedException

execResizeTty

public void execResizeTty(String execId,
 Integer height,
 Integer width)
                   throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Resizes the tty session used by an exec command. This API is valid only if tty was specified as part of creating and starting the exec command.

Specified by:

execResizeTty in interface DockerClient

Parameters:

execId - exec id

height - height of tty session

width - width of tty session

Throws:

BadParamException - if both height and width are null or zero

ExecNotFoundException - if exec instance is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

execInspect

public ExecState execInspect(String execId)
                      throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Inspects a running or previously run exec instance id.

Specified by:

execInspect in interface DockerClient

Parameters:

execId - exec id

Returns:

state of this exec instance.

Throws:

ExecNotFoundException - if exec instance is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

stats

public ContainerStats stats(String containerId)
                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Retrieves one-time stats (stream=0) for the container with the specified id.

Specified by:

stats in interface DockerClient

Parameters:

containerId - The id of the container to retrieve stats for.

Returns:

The container stats

Throws:

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

resizeTty

public void resizeTty(String containerId,
 Integer height,
 Integer width)
               throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Resize container TTY This API is valid only if tty was specified as part of creating the container.

Specified by:

resizeTty in interface DockerClient

Parameters:

containerId - The id of the container whose TTY will be resized.

height - New height of TTY

width - New width of TTY

Throws:

BadParamException - if both height and width are null or zero

ContainerNotFoundException - if container is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

listNetworks

public List<Network> listNetworks(DockerClient.ListNetworksParam... params)
                           throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List all or a subset of the networks. Filters were added in Docker 1.10, API version 1.22.

Specified by:

listNetworks in interface DockerClient

Parameters:

params - the list network parameters

Returns:

networks

Throws:

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

inspectNetwork

public Network inspectNetwork(String networkId)
                       throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Inspect a specific network.

Specified by:

inspectNetwork in interface DockerClient

Parameters:

networkId - The id of the network

Returns:

network information

Throws:

NetworkNotFoundException - if network is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

createNetwork

public NetworkCreation createNetwork(NetworkConfig networkConfig)
                              throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Create a new network.

Specified by:

createNetwork in interface DockerClient

Parameters:

networkConfig - The network creation parameters

Returns:

NetworkCreation

Throws:

NetworkNotFoundException - if network is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

removeNetwork

public void removeNetwork(String networkId)
                   throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Remove a docker network.

Specified by:

removeNetwork in interface DockerClient

Parameters:

networkId - The id of the network to remove.

Throws:

NetworkNotFoundException - if network is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

connectToNetwork

public void connectToNetwork(String containerId,
 String networkId)
                      throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Connects a docker container to a network.

Specified by:

connectToNetwork in interface DockerClient

Parameters:

containerId - The id of the container to connect.

networkId - The id of the network to connect.

Throws:

NotFoundException - if either container or network is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

connectToNetwork

public void connectToNetwork(String networkId,
 NetworkConnection networkConnection)
                      throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Connects a docker container to a network, with extended configuration. This is useful when you want to set specific details (aliases, gateway, etc...) for your container inside the network.

Specified by:

connectToNetwork in interface DockerClient

Parameters:

networkId - The id of the network to connect.

networkConnection - The target connection parameters.

Throws:

NotFoundException - if either container or network is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - if the thread is interrupted

disconnectFromNetwork

public void disconnectFromNetwork(String containerId,
 String networkId)
                           throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Disconnects a docker container to a network.

Specified by:

disconnectFromNetwork in interface DockerClient

Parameters:

containerId - The id of the container to disconnect.

networkId - The id of the network to disconnect.

Throws:

NotFoundException - if either container or network is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

disconnectFromNetwork

public void disconnectFromNetwork(String containerId,
 String networkId,
 boolean force)
                           throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Disconnects a docker container to a network.

Specified by:

disconnectFromNetwork in interface DockerClient

Parameters:

containerId - The id of the container to disconnect.

networkId - The id of the network to disconnect.

force - Force the container to disconnect from the network.

Throws:

NotFoundException - if either container or network is not found (404)

DockerException - if a server error occurred (500)

InterruptedException - If the thread is interrupted

createVolume

public Volume createVolume()
                    throws DockerException,
InterruptedException

Specified by:

createVolume in interface DockerClient

Throws:

DockerException

InterruptedException

createVolume

public Volume createVolume(Volume volume)
                    throws DockerException,
InterruptedException

Specified by:

createVolume in interface DockerClient

Throws:

DockerException

InterruptedException

inspectVolume

public Volume inspectVolume(String volumeName)
                     throws DockerException,
InterruptedException

Specified by:

inspectVolume in interface DockerClient

Throws:

DockerException

InterruptedException

removeVolume

public void removeVolume(Volume volume)
                  throws DockerException,
InterruptedException

Specified by:

removeVolume in interface DockerClient

Throws:

DockerException

InterruptedException

removeVolume

public void removeVolume(String volumeName)
                  throws DockerException,
InterruptedException

Specified by:

removeVolume in interface DockerClient

Throws:

DockerException

InterruptedException

listVolumes

public VolumeList listVolumes(DockerClient.ListVolumesParam... params)
                       throws DockerException,
InterruptedException

Specified by:

listVolumes in interface DockerClient

Throws:

DockerException

InterruptedException

listSecrets

public List<Secret> listSecrets()
                         throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List secrets.

Specified by:

listSecrets in interface DockerClient

Returns:

A list of Secrets

Throws:

DockerException - if a server error occurred (500)

InterruptedException

listSecrets

public List<Secret> listSecrets(Secret.Criteria criteria)
                         throws DockerException,
InterruptedException

Description copied from interface: DockerClient

List secrets with criteria.

Specified by:

listSecrets in interface DockerClient

Parameters:

criteria - Config listing and filtering options

Returns:

A list of Secrets

Throws:

DockerException - if a server error occurred (500)

InterruptedException

createSecret

public SecretCreateResponse createSecret(SecretSpec secret)
                                  throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Create a secret.

Specified by:

createSecret in interface DockerClient

Parameters:

secret - The spec for the secret.

Returns:

SecretCreateResponse

Throws:

ConflictException - conflict (409)

DockerException - if node is not part of a swarm (406) or a server error occurred (500)

InterruptedException

inspectSecret

public Secret inspectSecret(String secretId)
                     throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Inspect a secret.

Specified by:

inspectSecret in interface DockerClient

Parameters:

secretId - The id of the secret.

Returns:

Secret

Throws:

NotFoundException - secret not found (404)

DockerException - if node is not part of a swarm (406) or a server error occurred (500)

InterruptedException

deleteSecret

public void deleteSecret(String secretId)
                  throws DockerException,
InterruptedException

Description copied from interface: DockerClient

Delete a secret.

Specified by:

deleteSecret in interface DockerClient

Parameters:

secretId - The id of the secret.

Throws:

NotFoundException - not found (404)

DockerException - if a server error occurred (500)

InterruptedException