com.github.dockerjava.api

Class DockerClientDelegate

java.lang.Object

com.github.dockerjava.api.DockerClientDelegate

All Implemented Interfaces:

DockerClient, Closeable, AutoCloseable

public class DockerClientDelegate
extends Object
implements DockerClient

Constructor Summary

Constructors

Constructor and Description
DockerClientDelegate()

Method Summary

Modifier and Type	Method and Description
AttachContainerCmd	attachContainerCmd(String containerId)
AuthCmd	authCmd() Authenticate with the server, useful for checking authentication.
AuthConfig	authConfig()
BuildImageCmd	buildImageCmd()
BuildImageCmd	buildImageCmd(File dockerFileOrFolder)
BuildImageCmd	buildImageCmd(InputStream tarInputStream)
void	close()
CommitCmd	commitCmd(String containerId)
ConnectToNetworkCmd	connectToNetworkCmd()
ContainerDiffCmd	containerDiffCmd(String containerId)
CopyArchiveFromContainerCmd	copyArchiveFromContainerCmd(String containerId, String resource) Copy resource from container to local machine.
CopyArchiveToContainerCmd	copyArchiveToContainerCmd(String containerId) Copy archive from local machine to remote container
CopyFileFromContainerCmd	copyFileFromContainerCmd(String containerId, String resource) Deprecated.
CreateConfigCmd	createConfigCmd() Command to create a config in a docker swarm.
CreateContainerCmd	createContainerCmd(String image)
CreateImageCmd	createImageCmd(String repository, InputStream imageStream)
CreateNetworkCmd	createNetworkCmd()
CreateSecretCmd	createSecretCmd(SecretSpec secretSpec) Command to create a secret in a docker swarm.
CreateServiceCmd	createServiceCmd(ServiceSpec serviceSpec) Command to create a service in a docker swarm.
CreateVolumeCmd	createVolumeCmd()
DisconnectFromNetworkCmd	disconnectFromNetworkCmd()
EventsCmd	eventsCmd()
ExecCreateCmd	execCreateCmd(String containerId)
ExecStartCmd	execStartCmd(String execId)
protected DockerClient	getDockerClient()
InfoCmd	infoCmd()
InitializeSwarmCmd	initializeSwarmCmd(SwarmSpec swarmSpec) Enables swarm mode for the docker engine and creates a new swarm cluster
InspectConfigCmd	inspectConfigCmd(String configId) Command to inspect a service
InspectContainerCmd	inspectContainerCmd(String containerId)
InspectExecCmd	inspectExecCmd(String execId)
InspectImageCmd	inspectImageCmd(String imageId)
InspectNetworkCmd	inspectNetworkCmd()
InspectServiceCmd	inspectServiceCmd(String serviceId) Command to inspect a service
InspectSwarmCmd	inspectSwarmCmd() Gets information about the swarm the docker engine is currently in
InspectVolumeCmd	inspectVolumeCmd(String name)
JoinSwarmCmd	joinSwarmCmd() Enables swarm mode for the docker engine and joins an existing swarm cluster
KillContainerCmd	killContainerCmd(String containerId)
LeaveSwarmCmd	leaveSwarmCmd() Disables swarm node for the docker engine and leaves the swarm cluster
ListConfigsCmd	listConfigsCmd() Command to list all configs.
ListContainersCmd	listContainersCmd() * CONTAINER API *
ListImagesCmd	listImagesCmd()
ListNetworksCmd	listNetworksCmd()
ListSecretsCmd	listSecretsCmd() Command to list all secrets.
ListServicesCmd	listServicesCmd() Command to list all services in a docker swarm.
ListSwarmNodesCmd	listSwarmNodesCmd() List nodes in swarm
ListTasksCmd	listTasksCmd() List tasks in the swarm cluster
ListVolumesCmd	listVolumesCmd()
LoadImageCmd	loadImageCmd(InputStream imageStream) Loads a tarball with a set of images and tags into a Docker repository.
LogContainerCmd	logContainerCmd(String containerId)
LogSwarmObjectCmd	logServiceCmd(String serviceId) Command to get service log
LogSwarmObjectCmd	logTaskCmd(String taskId) Command to get task log
PauseContainerCmd	pauseContainerCmd(String containerId)
PingCmd	pingCmd()
PruneCmd	pruneCmd(PruneType pruneType) Command to delete unused containers/images/networks/volumes
PullImageCmd	pullImageCmd(String repository) * IMAGE API *
PushImageCmd	pushImageCmd(Identifier identifier)
PushImageCmd	pushImageCmd(String name)
RemoveConfigCmd	removeConfigCmd(String configId) Command to remove a config
RemoveContainerCmd	removeContainerCmd(String containerId)
RemoveImageCmd	removeImageCmd(String imageId)
RemoveNetworkCmd	removeNetworkCmd(String networkId)
RemoveSecretCmd	removeSecretCmd(String secretId) Command to remove a secret
RemoveServiceCmd	removeServiceCmd(String serviceId) Command to remove a service
RemoveVolumeCmd	removeVolumeCmd(String name)
RenameContainerCmd	renameContainerCmd(String containerId) Rename container.
ResizeContainerCmd	resizeContainerCmd(String containerId)
ResizeExecCmd	resizeExecCmd(String execId)
RestartContainerCmd	restartContainerCmd(String containerId)
SaveImageCmd	saveImageCmd(String name)
SaveImagesCmd	saveImagesCmd() Command to download multiple images at once.
SearchImagesCmd	searchImagesCmd(String term)
StartContainerCmd	startContainerCmd(String containerId) Creates a new StartContainerCmd for the container with the given ID.
StatsCmd	statsCmd(String containerId)
StopContainerCmd	stopContainerCmd(String containerId)
TagImageCmd	tagImageCmd(String imageId, String imageNameWithRepository, String tag)
TopContainerCmd	topContainerCmd(String containerId)
UnpauseContainerCmd	unpauseContainerCmd(String containerId)
UpdateContainerCmd	updateContainerCmd(String containerId) Update container settings
UpdateServiceCmd	updateServiceCmd(String serviceId, ServiceSpec serviceSpec) Command to update a service specification
UpdateSwarmCmd	updateSwarmCmd(SwarmSpec swarmSpec) Updates the swarm specification
UpdateSwarmNodeCmd	updateSwarmNodeCmd() Updates the swarm node
VersionCmd	versionCmd()
WaitContainerCmd	waitContainerCmd(String containerId)

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerClientDelegate

public DockerClientDelegate()

Method Detail

getDockerClient

protected DockerClient getDockerClient()

authConfig

public AuthConfig authConfig()
                      throws DockerException

Specified by:

authConfig in interface DockerClient

Throws:

DockerException

authCmd

public AuthCmd authCmd()

Description copied from interface: DockerClient

Authenticate with the server, useful for checking authentication.

Specified by:

authCmd in interface DockerClient

infoCmd

public InfoCmd infoCmd()

Specified by:

infoCmd in interface DockerClient

pingCmd

public PingCmd pingCmd()

Specified by:

pingCmd in interface DockerClient

versionCmd

public VersionCmd versionCmd()

Specified by:

versionCmd in interface DockerClient

pullImageCmd

public PullImageCmd pullImageCmd(@Nonnull
                                 String repository)

Description copied from interface: DockerClient

* IMAGE API *

Specified by:

pullImageCmd in interface DockerClient

pushImageCmd

public PushImageCmd pushImageCmd(@Nonnull
                                 String name)

Specified by:

pushImageCmd in interface DockerClient

pushImageCmd

public PushImageCmd pushImageCmd(@Nonnull
                                 Identifier identifier)

Specified by:

pushImageCmd in interface DockerClient

createImageCmd

public CreateImageCmd createImageCmd(@Nonnull
                                     String repository,
                                     @Nonnull
                                     InputStream imageStream)

Specified by:

createImageCmd in interface DockerClient

loadImageCmd

public LoadImageCmd loadImageCmd(@Nonnull
                                 InputStream imageStream)

Description copied from interface: DockerClient

Loads a tarball with a set of images and tags into a Docker repository. Corresponds to POST /images/load API endpoint.

Specified by:

loadImageCmd in interface DockerClient

Parameters:

imageStream - stream of the tarball file

Returns:

created command

searchImagesCmd

public SearchImagesCmd searchImagesCmd(@Nonnull
                                       String term)

Specified by:

searchImagesCmd in interface DockerClient

removeImageCmd

public RemoveImageCmd removeImageCmd(@Nonnull
                                     String imageId)

Specified by:

removeImageCmd in interface DockerClient

listImagesCmd

public ListImagesCmd listImagesCmd()

Specified by:

listImagesCmd in interface DockerClient

inspectImageCmd

public InspectImageCmd inspectImageCmd(@Nonnull
                                       String imageId)

Specified by:

inspectImageCmd in interface DockerClient

saveImageCmd

public SaveImageCmd saveImageCmd(@Nonnull
                                 String name)

Specified by:

saveImageCmd in interface DockerClient

Parameters:

name - The name, e.g. "alexec/busybox" or just "busybox" if you want to default. Not null.

saveImagesCmd

public SaveImagesCmd saveImagesCmd()

Description copied from interface: DockerClient

Command to download multiple images at once.

Specified by:

saveImagesCmd in interface DockerClient

Returns:

command (builder)

listContainersCmd

public ListContainersCmd listContainersCmd()

Description copied from interface: DockerClient

* CONTAINER API *

Specified by:

listContainersCmd in interface DockerClient

createContainerCmd

public CreateContainerCmd createContainerCmd(@Nonnull
                                             String image)

Specified by:

createContainerCmd in interface DockerClient

startContainerCmd

public StartContainerCmd startContainerCmd(@Nonnull
                                           String containerId)

Description copied from interface: DockerClient

Creates a new StartContainerCmd for the container with the given ID. The command can then be further customized by using builder methods on it like StartContainerCmd#withDns(String...).

If you customize the command, any existing configuration of the target container will get reset to its default before applying the new configuration. To preserve the existing configuration, use an unconfigured StartContainerCmd.

This command corresponds to the /containers/{id}/start endpoint of the Docker Remote API.

Specified by:

startContainerCmd in interface DockerClient

execCreateCmd

public ExecCreateCmd execCreateCmd(@Nonnull
                                   String containerId)

Specified by:

execCreateCmd in interface DockerClient

resizeExecCmd

public ResizeExecCmd resizeExecCmd(@Nonnull
                                   String execId)

Specified by:

resizeExecCmd in interface DockerClient

inspectContainerCmd

public InspectContainerCmd inspectContainerCmd(@Nonnull
                                               String containerId)

Specified by:

inspectContainerCmd in interface DockerClient

removeContainerCmd

public RemoveContainerCmd removeContainerCmd(@Nonnull
                                             String containerId)

Specified by:

removeContainerCmd in interface DockerClient

waitContainerCmd

public WaitContainerCmd waitContainerCmd(@Nonnull
                                         String containerId)

Specified by:

waitContainerCmd in interface DockerClient

attachContainerCmd

public AttachContainerCmd attachContainerCmd(@Nonnull
                                             String containerId)

Specified by:

attachContainerCmd in interface DockerClient

execStartCmd

public ExecStartCmd execStartCmd(@Nonnull
                                 String execId)

Specified by:

execStartCmd in interface DockerClient

inspectExecCmd

public InspectExecCmd inspectExecCmd(@Nonnull
                                     String execId)

Specified by:

inspectExecCmd in interface DockerClient

logContainerCmd

public LogContainerCmd logContainerCmd(@Nonnull
                                       String containerId)

Specified by:

logContainerCmd in interface DockerClient

copyArchiveFromContainerCmd

public CopyArchiveFromContainerCmd copyArchiveFromContainerCmd(@Nonnull
                                                               String containerId,
                                                               @Nonnull
                                                               String resource)

Description copied from interface: DockerClient

Copy resource from container to local machine.

Specified by:

copyArchiveFromContainerCmd in interface DockerClient

Parameters:

containerId - id of the container

resource - path to container's resource

Returns:

created command

copyFileFromContainerCmd

@Deprecated
public CopyFileFromContainerCmd copyFileFromContainerCmd(@Nonnull
                                                                     String containerId,
                                                                     @Nonnull
                                                                     String resource)

Deprecated.

Description copied from interface: DockerClient

Copy resource from container to local machine.

Specified by:

copyFileFromContainerCmd in interface DockerClient

Parameters:

containerId - id of the container

resource - path to container's resource

Returns:

created command

See Also:

DockerClient.copyArchiveFromContainerCmd(String, String)

copyArchiveToContainerCmd

public CopyArchiveToContainerCmd copyArchiveToContainerCmd(@Nonnull
                                                           String containerId)

Description copied from interface: DockerClient

Copy archive from local machine to remote container

Specified by:

copyArchiveToContainerCmd in interface DockerClient

Parameters:

containerId - id of the container

Returns:

created command

containerDiffCmd

public ContainerDiffCmd containerDiffCmd(@Nonnull
                                         String containerId)

Specified by:

containerDiffCmd in interface DockerClient

stopContainerCmd

public StopContainerCmd stopContainerCmd(@Nonnull
                                         String containerId)

Specified by:

stopContainerCmd in interface DockerClient

killContainerCmd

public KillContainerCmd killContainerCmd(@Nonnull
                                         String containerId)

Specified by:

killContainerCmd in interface DockerClient

updateContainerCmd

public UpdateContainerCmd updateContainerCmd(@Nonnull
                                             String containerId)

Description copied from interface: DockerClient

Update container settings

Specified by:

updateContainerCmd in interface DockerClient

Parameters:

containerId - id of the container

Returns:

command

renameContainerCmd

public RenameContainerCmd renameContainerCmd(@Nonnull
                                             String containerId)

Description copied from interface: DockerClient

Rename container.

Specified by:

renameContainerCmd in interface DockerClient

Parameters:

containerId - id of the container

Returns:

command

restartContainerCmd

public RestartContainerCmd restartContainerCmd(@Nonnull
                                               String containerId)

Specified by:

restartContainerCmd in interface DockerClient

resizeContainerCmd

public ResizeContainerCmd resizeContainerCmd(@Nonnull
                                             String containerId)

Specified by:

resizeContainerCmd in interface DockerClient

commitCmd

public CommitCmd commitCmd(@Nonnull
                           String containerId)

Specified by:

commitCmd in interface DockerClient

buildImageCmd

public BuildImageCmd buildImageCmd()

Specified by:

buildImageCmd in interface DockerClient

buildImageCmd

public BuildImageCmd buildImageCmd(File dockerFileOrFolder)

Specified by:

buildImageCmd in interface DockerClient

buildImageCmd

public BuildImageCmd buildImageCmd(InputStream tarInputStream)

Specified by:

buildImageCmd in interface DockerClient

topContainerCmd

public TopContainerCmd topContainerCmd(String containerId)

Specified by:

topContainerCmd in interface DockerClient

tagImageCmd

public TagImageCmd tagImageCmd(String imageId,
                               String imageNameWithRepository,
                               String tag)

Specified by:

tagImageCmd in interface DockerClient

pauseContainerCmd

public PauseContainerCmd pauseContainerCmd(String containerId)

Specified by:

pauseContainerCmd in interface DockerClient

unpauseContainerCmd

public UnpauseContainerCmd unpauseContainerCmd(String containerId)

Specified by:

unpauseContainerCmd in interface DockerClient

eventsCmd

public EventsCmd eventsCmd()

Specified by:

eventsCmd in interface DockerClient

statsCmd

public StatsCmd statsCmd(String containerId)

Specified by:

statsCmd in interface DockerClient

createVolumeCmd

public CreateVolumeCmd createVolumeCmd()

Specified by:

createVolumeCmd in interface DockerClient

inspectVolumeCmd

public InspectVolumeCmd inspectVolumeCmd(String name)

Specified by:

inspectVolumeCmd in interface DockerClient

removeVolumeCmd

public RemoveVolumeCmd removeVolumeCmd(String name)

Specified by:

removeVolumeCmd in interface DockerClient

listVolumesCmd

public ListVolumesCmd listVolumesCmd()

Specified by:

listVolumesCmd in interface DockerClient

listNetworksCmd

public ListNetworksCmd listNetworksCmd()

Specified by:

listNetworksCmd in interface DockerClient

inspectNetworkCmd

public InspectNetworkCmd inspectNetworkCmd()

Specified by:

inspectNetworkCmd in interface DockerClient

createNetworkCmd

public CreateNetworkCmd createNetworkCmd()

Specified by:

createNetworkCmd in interface DockerClient

removeNetworkCmd

public RemoveNetworkCmd removeNetworkCmd(@Nonnull
                                         String networkId)

Specified by:

removeNetworkCmd in interface DockerClient

connectToNetworkCmd

public ConnectToNetworkCmd connectToNetworkCmd()

Specified by:

connectToNetworkCmd in interface DockerClient

disconnectFromNetworkCmd

public DisconnectFromNetworkCmd disconnectFromNetworkCmd()

Specified by:

disconnectFromNetworkCmd in interface DockerClient

initializeSwarmCmd

public InitializeSwarmCmd initializeSwarmCmd(SwarmSpec swarmSpec)

Description copied from interface: DockerClient

Enables swarm mode for the docker engine and creates a new swarm cluster

Specified by:

initializeSwarmCmd in interface DockerClient

Parameters:

swarmSpec - the specification for the swarm

Returns:

the command

inspectSwarmCmd

public InspectSwarmCmd inspectSwarmCmd()

Description copied from interface: DockerClient

Gets information about the swarm the docker engine is currently in

Specified by:

inspectSwarmCmd in interface DockerClient

Returns:

the command

joinSwarmCmd

public JoinSwarmCmd joinSwarmCmd()

Description copied from interface: DockerClient

Enables swarm mode for the docker engine and joins an existing swarm cluster

Specified by:

joinSwarmCmd in interface DockerClient

Returns:

the command

leaveSwarmCmd

public LeaveSwarmCmd leaveSwarmCmd()

Description copied from interface: DockerClient

Disables swarm node for the docker engine and leaves the swarm cluster

Specified by:

leaveSwarmCmd in interface DockerClient

Returns:

the command

updateSwarmCmd

public UpdateSwarmCmd updateSwarmCmd(SwarmSpec swarmSpec)

Description copied from interface: DockerClient

Updates the swarm specification

Specified by:

updateSwarmCmd in interface DockerClient

Parameters:

swarmSpec - the specification for the swarm

Returns:

the command

updateSwarmNodeCmd

public UpdateSwarmNodeCmd updateSwarmNodeCmd()

Description copied from interface: DockerClient

Updates the swarm node

Specified by:

updateSwarmNodeCmd in interface DockerClient

Returns:

the command

listSwarmNodesCmd

public ListSwarmNodesCmd listSwarmNodesCmd()

Description copied from interface: DockerClient

List nodes in swarm

Specified by:

listSwarmNodesCmd in interface DockerClient

Returns:

the command

listServicesCmd

public ListServicesCmd listServicesCmd()

Description copied from interface: DockerClient

Command to list all services in a docker swarm. Only applicable if docker runs in swarm mode.

Specified by:

listServicesCmd in interface DockerClient

Returns:

command

createServiceCmd

public CreateServiceCmd createServiceCmd(ServiceSpec serviceSpec)

Description copied from interface: DockerClient

Command to create a service in a docker swarm. Only applicable if docker runs in swarm mode.

Specified by:

createServiceCmd in interface DockerClient

Parameters:

serviceSpec - the service specification

Returns:

command

inspectServiceCmd

public InspectServiceCmd inspectServiceCmd(String serviceId)

Description copied from interface: DockerClient

Command to inspect a service

Specified by:

inspectServiceCmd in interface DockerClient

Parameters:

serviceId - service id or service name

Returns:

command

updateServiceCmd

public UpdateServiceCmd updateServiceCmd(String serviceId,
                                         ServiceSpec serviceSpec)

Description copied from interface: DockerClient

Command to update a service specification

Specified by:

updateServiceCmd in interface DockerClient

Parameters:

serviceId - service id

serviceSpec - the new service specification

Returns:

command

removeServiceCmd

public RemoveServiceCmd removeServiceCmd(String serviceId)

Description copied from interface: DockerClient

Command to remove a service

Specified by:

removeServiceCmd in interface DockerClient

Parameters:

serviceId - service id or service name

Returns:

command

listTasksCmd

public ListTasksCmd listTasksCmd()

Description copied from interface: DockerClient

List tasks in the swarm cluster

Specified by:

listTasksCmd in interface DockerClient

Returns:

the command

logServiceCmd

public LogSwarmObjectCmd logServiceCmd(String serviceId)

Description copied from interface: DockerClient

Command to get service log

Specified by:

logServiceCmd in interface DockerClient

Returns:

the command

logTaskCmd

public LogSwarmObjectCmd logTaskCmd(String taskId)

Description copied from interface: DockerClient

Command to get task log

Specified by:

logTaskCmd in interface DockerClient

Returns:

the command

pruneCmd

public PruneCmd pruneCmd(PruneType pruneType)

Description copied from interface: DockerClient

Command to delete unused containers/images/networks/volumes

Specified by:

pruneCmd in interface DockerClient

listSecretsCmd

public ListSecretsCmd listSecretsCmd()

Description copied from interface: DockerClient

Command to list all secrets. Only applicable if docker runs in swarm mode.

Specified by:

listSecretsCmd in interface DockerClient

Returns:

command

createSecretCmd

public CreateSecretCmd createSecretCmd(SecretSpec secretSpec)

Description copied from interface: DockerClient

Command to create a secret in a docker swarm. Only applicable if docker runs in swarm mode.

Specified by:

createSecretCmd in interface DockerClient

Parameters:

secretSpec - the secret specification

Returns:

command

removeSecretCmd

public RemoveSecretCmd removeSecretCmd(String secretId)

Description copied from interface: DockerClient

Command to remove a secret

Specified by:

removeSecretCmd in interface DockerClient

Parameters:

secretId - secret id or secret name

Returns:

command

listConfigsCmd

public ListConfigsCmd listConfigsCmd()

Description copied from interface: DockerClient

Command to list all configs. Only applicable if docker runs in swarm mode.

Specified by:

listConfigsCmd in interface DockerClient

Returns:

command

createConfigCmd

public CreateConfigCmd createConfigCmd()

Description copied from interface: DockerClient

Command to create a config in a docker swarm. Only applicable if docker runs in swarm mode.

Specified by:

createConfigCmd in interface DockerClient

Returns:

command

inspectConfigCmd

public InspectConfigCmd inspectConfigCmd(String configId)

Description copied from interface: DockerClient

Command to inspect a service

Specified by:

inspectConfigCmd in interface DockerClient

Parameters:

configId - config id or config name

Returns:

command

removeConfigCmd

public RemoveConfigCmd removeConfigCmd(String configId)

Description copied from interface: DockerClient

Command to remove a config

Specified by:

removeConfigCmd in interface DockerClient

Parameters:

configId - config id or config name

Returns:

command

close

public void close()
           throws IOException

Specified by:

close in interface DockerClient

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException