com.github.dockerjava.core

Class DockerClientImpl

java.lang.Object

com.github.dockerjava.core.DockerClientImpl

All Implemented Interfaces:

DockerClient, java.io.Closeable, java.lang.AutoCloseable

public class DockerClientImpl
extends java.lang.Object
implements java.io.Closeable, DockerClient

Author:

Konstantin Pelykh ([email protected])

See Also:

"https://github.com/docker/docker/blob/master/api/client/commands.go"

Method Summary

Modifier and Type	Method and Description
AttachContainerCmd	attachContainerCmd(java.lang.String containerId)
AuthCmd	authCmd() Authenticate with the server, useful for checking authentication.
AuthConfig	authConfig()
BuildImageCmd	buildImageCmd()
BuildImageCmd	buildImageCmd(java.io.File dockerFileOrFolder)
BuildImageCmd	buildImageCmd(java.io.InputStream tarInputStream)
void	close()
CommitCmd	commitCmd(java.lang.String containerId)
ConnectToNetworkCmd	connectToNetworkCmd()
ContainerDiffCmd	containerDiffCmd(java.lang.String containerId)
CopyArchiveFromContainerCmd	copyArchiveFromContainerCmd(java.lang.String containerId, java.lang.String resource) Copy resource from container to local machine.
CopyArchiveToContainerCmd	copyArchiveToContainerCmd(java.lang.String containerId) Copy archive from local machine to remote container
CopyFileFromContainerCmd	copyFileFromContainerCmd(java.lang.String containerId, java.lang.String resource) Copy resource from container to local machine.
CreateContainerCmd	createContainerCmd(java.lang.String image)
CreateImageCmd	createImageCmd(java.lang.String repository, java.io.InputStream imageStream)
CreateNetworkCmd	createNetworkCmd()
CreateServiceCmd	createServiceCmd(ServiceSpec serviceSpec) Command to create a service in a docker swarm.
CreateVolumeCmd	createVolumeCmd()
DisconnectFromNetworkCmd	disconnectFromNetworkCmd()
EventsCmd	eventsCmd()
ExecCreateCmd	execCreateCmd(java.lang.String containerId)
ExecStartCmd	execStartCmd(java.lang.String execId)
static DockerClientImpl	getInstance()
static DockerClientImpl	getInstance(DockerClientConfig dockerClientConfig)
static DockerClientImpl	getInstance(java.lang.String serverUrl)
InfoCmd	infoCmd()
InitializeSwarmCmd	initializeSwarmCmd(SwarmSpec swarmSpec) Enables swarm mode for the docker engine and creates a new swarm cluster
InspectContainerCmd	inspectContainerCmd(java.lang.String containerId)
InspectExecCmd	inspectExecCmd(java.lang.String execId)
InspectImageCmd	inspectImageCmd(java.lang.String imageId)
InspectNetworkCmd	inspectNetworkCmd()
InspectServiceCmd	inspectServiceCmd(java.lang.String serviceId) Command to inspect a service
InspectSwarmCmd	inspectSwarmCmd() Gets information about the swarm the docker engine is currently in
InspectVolumeCmd	inspectVolumeCmd(java.lang.String name)
JoinSwarmCmd	joinSwarmCmd() Enables swarm mode for the docker engine and joins an existing swarm cluster
KillContainerCmd	killContainerCmd(java.lang.String containerId)
LeaveSwarmCmd	leaveSwarmCmd() Disables swarm node for the docker engine and leaves the swarm cluster
ListContainersCmd	listContainersCmd() * CONTAINER API *
ListImagesCmd	listImagesCmd()
ListNetworksCmd	listNetworksCmd()
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(java.io.InputStream imageStream) Loads a tarball with a set of images and tags into a Docker repository.
LogContainerCmd	logContainerCmd(java.lang.String containerId)
LogSwarmObjectCmd	logServiceCmd(java.lang.String serviceId) Command to get service log
LogSwarmObjectCmd	logTaskCmd(java.lang.String taskId) Command to get task log
PauseContainerCmd	pauseContainerCmd(java.lang.String containerId)
PingCmd	pingCmd()
PullImageCmd	pullImageCmd(java.lang.String repository) * IMAGE API *
PushImageCmd	pushImageCmd(Identifier identifier)
PushImageCmd	pushImageCmd(java.lang.String name)
RemoveContainerCmd	removeContainerCmd(java.lang.String containerId)
RemoveImageCmd	removeImageCmd(java.lang.String imageId)
RemoveNetworkCmd	removeNetworkCmd(java.lang.String networkId)
RemoveServiceCmd	removeServiceCmd(java.lang.String serviceId) Command to remove a service
RemoveVolumeCmd	removeVolumeCmd(java.lang.String name)
RenameContainerCmd	renameContainerCmd(java.lang.String containerId) Rename container.
RestartContainerCmd	restartContainerCmd(java.lang.String containerId)
SaveImageCmd	saveImageCmd(java.lang.String name)
SearchImagesCmd	searchImagesCmd(java.lang.String term)
StartContainerCmd	startContainerCmd(java.lang.String containerId) Creates a new StartContainerCmd for the container with the given ID.
StatsCmd	statsCmd(java.lang.String containerId)
StopContainerCmd	stopContainerCmd(java.lang.String containerId)
TagImageCmd	tagImageCmd(java.lang.String imageId, java.lang.String imageNameWithRepository, java.lang.String tag)
TopContainerCmd	topContainerCmd(java.lang.String containerId)
UnpauseContainerCmd	unpauseContainerCmd(java.lang.String containerId)
UpdateContainerCmd	updateContainerCmd(java.lang.String containerId) Update container settings
UpdateServiceCmd	updateServiceCmd(java.lang.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(java.lang.String containerId)
DockerClientImpl	withDockerCmdExecFactory(DockerCmdExecFactory dockerCmdExecFactory)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DockerClientImpl getInstance()

getInstance

public static DockerClientImpl getInstance(DockerClientConfig dockerClientConfig)

getInstance

public static DockerClientImpl getInstance(java.lang.String serverUrl)

withDockerCmdExecFactory

public DockerClientImpl withDockerCmdExecFactory(DockerCmdExecFactory dockerCmdExecFactory)

authConfig

public AuthConfig authConfig()

Specified by:

authConfig in interface DockerClient

authCmd

public AuthCmd authCmd()

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(java.lang.String repository)

* IMAGE API *

Specified by:

pullImageCmd in interface DockerClient

pushImageCmd

public PushImageCmd pushImageCmd(java.lang.String name)

Specified by:

pushImageCmd in interface DockerClient

pushImageCmd

public PushImageCmd pushImageCmd(Identifier identifier)

Specified by:

pushImageCmd in interface DockerClient

saveImageCmd

public SaveImageCmd saveImageCmd(java.lang.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.

createImageCmd

public CreateImageCmd createImageCmd(java.lang.String repository,
                                     java.io.InputStream imageStream)

Specified by:

createImageCmd in interface DockerClient

loadImageCmd

public LoadImageCmd loadImageCmd(@Nonnull
                                 java.io.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(java.lang.String term)

Specified by:

searchImagesCmd in interface DockerClient

removeImageCmd

public RemoveImageCmd removeImageCmd(java.lang.String imageId)

Specified by:

removeImageCmd in interface DockerClient

listImagesCmd

public ListImagesCmd listImagesCmd()

Specified by:

listImagesCmd in interface DockerClient

inspectImageCmd

public InspectImageCmd inspectImageCmd(java.lang.String imageId)

Specified by:

inspectImageCmd in interface DockerClient

listContainersCmd

public ListContainersCmd listContainersCmd()

* CONTAINER API *

Specified by:

listContainersCmd in interface DockerClient

createContainerCmd

public CreateContainerCmd createContainerCmd(java.lang.String image)

Specified by:

createContainerCmd in interface DockerClient

startContainerCmd

public StartContainerCmd startContainerCmd(java.lang.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

inspectContainerCmd

public InspectContainerCmd inspectContainerCmd(java.lang.String containerId)

Specified by:

inspectContainerCmd in interface DockerClient

execCreateCmd

public ExecCreateCmd execCreateCmd(java.lang.String containerId)

Specified by:

execCreateCmd in interface DockerClient

removeContainerCmd

public RemoveContainerCmd removeContainerCmd(java.lang.String containerId)

Specified by:

removeContainerCmd in interface DockerClient

waitContainerCmd

public WaitContainerCmd waitContainerCmd(java.lang.String containerId)

Specified by:

waitContainerCmd in interface DockerClient

attachContainerCmd

public AttachContainerCmd attachContainerCmd(java.lang.String containerId)

Specified by:

attachContainerCmd in interface DockerClient

execStartCmd

public ExecStartCmd execStartCmd(java.lang.String execId)

Specified by:

execStartCmd in interface DockerClient

inspectExecCmd

public InspectExecCmd inspectExecCmd(java.lang.String execId)

Specified by:

inspectExecCmd in interface DockerClient

logContainerCmd

public LogContainerCmd logContainerCmd(java.lang.String containerId)

Specified by:

logContainerCmd in interface DockerClient

copyFileFromContainerCmd

public CopyFileFromContainerCmd copyFileFromContainerCmd(java.lang.String containerId,
                                                         java.lang.String resource)

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)

copyArchiveFromContainerCmd

public CopyArchiveFromContainerCmd copyArchiveFromContainerCmd(java.lang.String containerId,
                                                               java.lang.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

copyArchiveToContainerCmd

public CopyArchiveToContainerCmd copyArchiveToContainerCmd(java.lang.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(java.lang.String containerId)

Specified by:

containerDiffCmd in interface DockerClient

stopContainerCmd

public StopContainerCmd stopContainerCmd(java.lang.String containerId)

Specified by:

stopContainerCmd in interface DockerClient

killContainerCmd

public KillContainerCmd killContainerCmd(java.lang.String containerId)

Specified by:

killContainerCmd in interface DockerClient

updateContainerCmd

public UpdateContainerCmd updateContainerCmd(@Nonnull
                                             java.lang.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
                                             java.lang.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(java.lang.String containerId)

Specified by:

restartContainerCmd in interface DockerClient

commitCmd

public CommitCmd commitCmd(java.lang.String containerId)

Specified by:

commitCmd in interface DockerClient

buildImageCmd

public BuildImageCmd buildImageCmd()

Specified by:

buildImageCmd in interface DockerClient

buildImageCmd

public BuildImageCmd buildImageCmd(java.io.File dockerFileOrFolder)

Specified by:

buildImageCmd in interface DockerClient

buildImageCmd

public BuildImageCmd buildImageCmd(java.io.InputStream tarInputStream)

Specified by:

buildImageCmd in interface DockerClient

topContainerCmd

public TopContainerCmd topContainerCmd(java.lang.String containerId)

Specified by:

topContainerCmd in interface DockerClient

tagImageCmd

public TagImageCmd tagImageCmd(java.lang.String imageId,
                               java.lang.String imageNameWithRepository,
                               java.lang.String tag)

Specified by:

tagImageCmd in interface DockerClient

pauseContainerCmd

public PauseContainerCmd pauseContainerCmd(java.lang.String containerId)

Specified by:

pauseContainerCmd in interface DockerClient

unpauseContainerCmd

public UnpauseContainerCmd unpauseContainerCmd(java.lang.String containerId)

Specified by:

unpauseContainerCmd in interface DockerClient

eventsCmd

public EventsCmd eventsCmd()

Specified by:

eventsCmd in interface DockerClient

statsCmd

public StatsCmd statsCmd(java.lang.String containerId)

Specified by:

statsCmd in interface DockerClient

createVolumeCmd

public CreateVolumeCmd createVolumeCmd()

Specified by:

createVolumeCmd in interface DockerClient

inspectVolumeCmd

public InspectVolumeCmd inspectVolumeCmd(java.lang.String name)

Specified by:

inspectVolumeCmd in interface DockerClient

removeVolumeCmd

public RemoveVolumeCmd removeVolumeCmd(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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

logServiceCmd

public LogSwarmObjectCmd logServiceCmd(java.lang.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(java.lang.String taskId)

Description copied from interface: DockerClient

Command to get task log

Specified by:

logTaskCmd in interface DockerClient

Returns:

the 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

close

public void close()
           throws java.io.IOException

Specified by:

close in interface DockerClient

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException