com.github.dockerjava.core

Class DockerClientImpl

java.lang.Object

com.github.dockerjava.core.DockerClientImpl

All Implemented Interfaces:

DockerClient, Closeable, AutoCloseable

public class DockerClientImpl
extends Object
implements Closeable, DockerClient

Author:

Konstantin Pelykh (kpelykh@gmail.com)

See Also:

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

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)
CopyArchiveToContainerCmd	copyArchiveToContainerCmd(String containerId)
CopyFileFromContainerCmd	copyFileFromContainerCmd(String containerId, String resource)
CreateConfigCmd	createConfigCmd()
CreateContainerCmd	createContainerCmd(String image)
CreateImageCmd	createImageCmd(String repository, InputStream imageStream)
CreateNetworkCmd	createNetworkCmd()
CreateSecretCmd	createSecretCmd(SecretSpec secretSpec)
CreateServiceCmd	createServiceCmd(ServiceSpec serviceSpec)
CreateVolumeCmd	createVolumeCmd()
DisconnectFromNetworkCmd	disconnectFromNetworkCmd()
EventsCmd	eventsCmd()
ExecCreateCmd	execCreateCmd(String containerId)
ExecStartCmd	execStartCmd(String execId)
DockerHttpClient	getHttpClient()
static DockerClientImpl	getInstance() Deprecated. use getInstance(DockerClientConfig, DockerHttpClient)
static DockerClientImpl	getInstance(DockerClientConfig dockerClientConfig) Deprecated. use getInstance(DockerClientConfig, DockerHttpClient)
static DockerClient	getInstance(DockerClientConfig dockerClientConfig, DockerHttpClient dockerHttpClient)
static DockerClientImpl	getInstance(String serverUrl) Deprecated. use getInstance(DockerClientConfig, DockerHttpClient)
InfoCmd	infoCmd()
InitializeSwarmCmd	initializeSwarmCmd(SwarmSpec swarmSpec)
InspectConfigCmd	inspectConfigCmd(String configId)
InspectContainerCmd	inspectContainerCmd(String containerId)
InspectExecCmd	inspectExecCmd(String execId)
InspectImageCmd	inspectImageCmd(String imageId)
InspectNetworkCmd	inspectNetworkCmd()
InspectServiceCmd	inspectServiceCmd(String serviceId)
InspectSwarmCmd	inspectSwarmCmd()
InspectVolumeCmd	inspectVolumeCmd(String name)
JoinSwarmCmd	joinSwarmCmd()
KillContainerCmd	killContainerCmd(String containerId)
LeaveSwarmCmd	leaveSwarmCmd()
ListConfigsCmd	listConfigsCmd()
ListContainersCmd	listContainersCmd() * CONTAINER API *
ListImagesCmd	listImagesCmd()
ListNetworksCmd	listNetworksCmd()
ListSecretsCmd	listSecretsCmd()
ListServicesCmd	listServicesCmd()
ListSwarmNodesCmd	listSwarmNodesCmd()
ListTasksCmd	listTasksCmd()
ListVolumesCmd	listVolumesCmd()
LoadImageAsyncCmd	loadImageAsyncCmd(InputStream imageStream)
LoadImageCmd	loadImageCmd(InputStream imageStream)
LogContainerCmd	logContainerCmd(String containerId)
LogSwarmObjectCmd	logServiceCmd(String serviceId)
LogSwarmObjectCmd	logTaskCmd(String taskId)
PauseContainerCmd	pauseContainerCmd(String containerId)
PingCmd	pingCmd()
PruneCmd	pruneCmd(PruneType pruneType)
PullImageCmd	pullImageCmd(String repository) * IMAGE API *
PushImageCmd	pushImageCmd(Identifier identifier)
PushImageCmd	pushImageCmd(String name)
RemoveConfigCmd	removeConfigCmd(String configId)
RemoveContainerCmd	removeContainerCmd(String containerId)
RemoveImageCmd	removeImageCmd(String imageId)
RemoveNetworkCmd	removeNetworkCmd(String networkId)
RemoveSecretCmd	removeSecretCmd(String secretId)
RemoveServiceCmd	removeServiceCmd(String serviceId)
RemoveSwarmNodeCmd	removeSwarmNodeCmd(String swarmNodeId)
RemoveVolumeCmd	removeVolumeCmd(String name)
RenameContainerCmd	renameContainerCmd(String containerId)
ResizeContainerCmd	resizeContainerCmd(String containerId)
ResizeExecCmd	resizeExecCmd(String execId)
RestartContainerCmd	restartContainerCmd(String containerId)
SaveImageCmd	saveImageCmd(String name)
SaveImagesCmd	saveImagesCmd()
SearchImagesCmd	searchImagesCmd(String term)
StartContainerCmd	startContainerCmd(String containerId)
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)
UpdateServiceCmd	updateServiceCmd(String serviceId, ServiceSpec serviceSpec)
UpdateSwarmCmd	updateSwarmCmd(SwarmSpec swarmSpec)
UpdateSwarmNodeCmd	updateSwarmNodeCmd()
VersionCmd	versionCmd()
WaitContainerCmd	waitContainerCmd(String containerId)
DockerClientImpl	withDockerCmdExecFactory(DockerCmdExecFactory dockerCmdExecFactory) Deprecated. use getInstance(DockerClientConfig, DockerHttpClient)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

@Deprecated
public static DockerClientImpl getInstance()

Deprecated. use getInstance(DockerClientConfig, DockerHttpClient)

getInstance

@Deprecated
public static DockerClientImpl getInstance(DockerClientConfig dockerClientConfig)

Deprecated. use getInstance(DockerClientConfig, DockerHttpClient)

getInstance

public static DockerClient getInstance(DockerClientConfig dockerClientConfig,
                                       DockerHttpClient dockerHttpClient)

getInstance

@Deprecated
public static DockerClientImpl getInstance(String serverUrl)

Deprecated. use getInstance(DockerClientConfig, DockerHttpClient)

getHttpClient

@Nullable
public DockerHttpClient getHttpClient()

Returns:

DockerHttpClient or null if not set

withDockerCmdExecFactory

@Deprecated
public DockerClientImpl withDockerCmdExecFactory(DockerCmdExecFactory dockerCmdExecFactory)

Deprecated. use getInstance(DockerClientConfig, DockerHttpClient)

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

* IMAGE API *

Specified by:

pullImageCmd in interface DockerClient

pushImageCmd

public PushImageCmd pushImageCmd(String name)

Specified by:

pushImageCmd in interface DockerClient

pushImageCmd

public PushImageCmd pushImageCmd(Identifier identifier)

Specified by:

pushImageCmd in interface DockerClient

saveImageCmd

public SaveImageCmd saveImageCmd(String name)

Specified by:

saveImageCmd in interface DockerClient

saveImagesCmd

public SaveImagesCmd saveImagesCmd()

Specified by:

saveImagesCmd in interface DockerClient

createImageCmd

public CreateImageCmd createImageCmd(String repository,
                                     InputStream imageStream)

Specified by:

createImageCmd in interface DockerClient

loadImageCmd

public LoadImageCmd loadImageCmd(@Nonnull
                                 InputStream imageStream)

Specified by:

loadImageCmd in interface DockerClient

loadImageAsyncCmd

public LoadImageAsyncCmd loadImageAsyncCmd(@Nonnull
                                           InputStream imageStream)

Specified by:

loadImageAsyncCmd in interface DockerClient

searchImagesCmd

public SearchImagesCmd searchImagesCmd(String term)

Specified by:

searchImagesCmd in interface DockerClient

removeImageCmd

public RemoveImageCmd removeImageCmd(String imageId)

Specified by:

removeImageCmd in interface DockerClient

listImagesCmd

public ListImagesCmd listImagesCmd()

Specified by:

listImagesCmd in interface DockerClient

inspectImageCmd

public InspectImageCmd inspectImageCmd(String imageId)

Specified by:

inspectImageCmd in interface DockerClient

listContainersCmd

public ListContainersCmd listContainersCmd()

* CONTAINER API *

Specified by:

listContainersCmd in interface DockerClient

createContainerCmd

public CreateContainerCmd createContainerCmd(String image)

Specified by:

createContainerCmd in interface DockerClient

startContainerCmd

public StartContainerCmd startContainerCmd(String containerId)

Specified by:

startContainerCmd in interface DockerClient

inspectContainerCmd

public InspectContainerCmd inspectContainerCmd(String containerId)

Specified by:

inspectContainerCmd in interface DockerClient

execCreateCmd

public ExecCreateCmd execCreateCmd(String containerId)

Specified by:

execCreateCmd in interface DockerClient

resizeExecCmd

public ResizeExecCmd resizeExecCmd(@Nonnull
                                   String execId)

Specified by:

resizeExecCmd in interface DockerClient

removeContainerCmd

public RemoveContainerCmd removeContainerCmd(String containerId)

Specified by:

removeContainerCmd in interface DockerClient

waitContainerCmd

public WaitContainerCmd waitContainerCmd(String containerId)

Specified by:

waitContainerCmd in interface DockerClient

attachContainerCmd

public AttachContainerCmd attachContainerCmd(String containerId)

Specified by:

attachContainerCmd in interface DockerClient

execStartCmd

public ExecStartCmd execStartCmd(String execId)

Specified by:

execStartCmd in interface DockerClient

inspectExecCmd

public InspectExecCmd inspectExecCmd(String execId)

Specified by:

inspectExecCmd in interface DockerClient

logContainerCmd

public LogContainerCmd logContainerCmd(String containerId)

Specified by:

logContainerCmd in interface DockerClient

copyFileFromContainerCmd

public CopyFileFromContainerCmd copyFileFromContainerCmd(String containerId,
                                                         String resource)

Specified by:

copyFileFromContainerCmd in interface DockerClient

copyArchiveFromContainerCmd

public CopyArchiveFromContainerCmd copyArchiveFromContainerCmd(String containerId,
                                                               String resource)

Specified by:

copyArchiveFromContainerCmd in interface DockerClient

copyArchiveToContainerCmd

public CopyArchiveToContainerCmd copyArchiveToContainerCmd(String containerId)

Specified by:

copyArchiveToContainerCmd in interface DockerClient

containerDiffCmd

public ContainerDiffCmd containerDiffCmd(String containerId)

Specified by:

containerDiffCmd in interface DockerClient

stopContainerCmd

public StopContainerCmd stopContainerCmd(String containerId)

Specified by:

stopContainerCmd in interface DockerClient

killContainerCmd

public KillContainerCmd killContainerCmd(String containerId)

Specified by:

killContainerCmd in interface DockerClient

updateContainerCmd

public UpdateContainerCmd updateContainerCmd(@Nonnull
                                             String containerId)

Specified by:

updateContainerCmd in interface DockerClient

renameContainerCmd

public RenameContainerCmd renameContainerCmd(@Nonnull
                                             String containerId)

Specified by:

renameContainerCmd in interface DockerClient

restartContainerCmd

public RestartContainerCmd restartContainerCmd(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(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(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)

Specified by:

initializeSwarmCmd in interface DockerClient

inspectSwarmCmd

public InspectSwarmCmd inspectSwarmCmd()

Specified by:

inspectSwarmCmd in interface DockerClient

joinSwarmCmd

public JoinSwarmCmd joinSwarmCmd()

Specified by:

joinSwarmCmd in interface DockerClient

leaveSwarmCmd

public LeaveSwarmCmd leaveSwarmCmd()

Specified by:

leaveSwarmCmd in interface DockerClient

updateSwarmCmd

public UpdateSwarmCmd updateSwarmCmd(SwarmSpec swarmSpec)

Specified by:

updateSwarmCmd in interface DockerClient

updateSwarmNodeCmd

public UpdateSwarmNodeCmd updateSwarmNodeCmd()

Specified by:

updateSwarmNodeCmd in interface DockerClient

removeSwarmNodeCmd

public RemoveSwarmNodeCmd removeSwarmNodeCmd(String swarmNodeId)

Specified by:

removeSwarmNodeCmd in interface DockerClient

listSwarmNodesCmd

public ListSwarmNodesCmd listSwarmNodesCmd()

Specified by:

listSwarmNodesCmd in interface DockerClient

listServicesCmd

public ListServicesCmd listServicesCmd()

Specified by:

listServicesCmd in interface DockerClient

createServiceCmd

public CreateServiceCmd createServiceCmd(ServiceSpec serviceSpec)

Specified by:

createServiceCmd in interface DockerClient

inspectServiceCmd

public InspectServiceCmd inspectServiceCmd(String serviceId)

Specified by:

inspectServiceCmd in interface DockerClient

updateServiceCmd

public UpdateServiceCmd updateServiceCmd(String serviceId,
                                         ServiceSpec serviceSpec)

Specified by:

updateServiceCmd in interface DockerClient

removeServiceCmd

public RemoveServiceCmd removeServiceCmd(String serviceId)

Specified by:

removeServiceCmd in interface DockerClient

logServiceCmd

public LogSwarmObjectCmd logServiceCmd(String serviceId)

Specified by:

logServiceCmd in interface DockerClient

logTaskCmd

public LogSwarmObjectCmd logTaskCmd(String taskId)

Specified by:

logTaskCmd in interface DockerClient

pruneCmd

public PruneCmd pruneCmd(PruneType pruneType)

Specified by:

pruneCmd in interface DockerClient

listSecretsCmd

public ListSecretsCmd listSecretsCmd()

Specified by:

listSecretsCmd in interface DockerClient

createSecretCmd

public CreateSecretCmd createSecretCmd(SecretSpec secretSpec)

Specified by:

createSecretCmd in interface DockerClient

removeSecretCmd

public RemoveSecretCmd removeSecretCmd(String secretId)

Specified by:

removeSecretCmd in interface DockerClient

listConfigsCmd

public ListConfigsCmd listConfigsCmd()

Specified by:

listConfigsCmd in interface DockerClient

createConfigCmd

public CreateConfigCmd createConfigCmd()

Specified by:

createConfigCmd in interface DockerClient

inspectConfigCmd

public InspectConfigCmd inspectConfigCmd(String configId)

Specified by:

inspectConfigCmd in interface DockerClient

removeConfigCmd

public RemoveConfigCmd removeConfigCmd(String configId)

Specified by:

removeConfigCmd in interface DockerClient

listTasksCmd

public ListTasksCmd listTasksCmd()

Specified by:

listTasksCmd in interface DockerClient

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