com.github.dockerjava.api.command

Interface DockerCmdExecFactory

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

AbstractDockerCmdExecFactory, DockerCmdExecFactoryImpl, DockerCmdExecFactoryImpl, JerseyDockerCmdExecFactory, NettyDockerCmdExecFactory

public interface DockerCmdExecFactory
extends java.io.Closeable

Method Summary

Modifier and Type	Method and Description
void	close()
AttachContainerCmd.Exec	createAttachContainerCmdExec()
AuthCmd.Exec	createAuthCmdExec()
BuildImageCmd.Exec	createBuildImageCmdExec()
CommitCmd.Exec	createCommitCmdExec()
ConnectToNetworkCmd.Exec	createConnectToNetworkCmdExec()
ContainerDiffCmd.Exec	createContainerDiffCmdExec()
CopyArchiveFromContainerCmd.Exec	createCopyArchiveFromContainerCmdExec()
CopyArchiveToContainerCmd.Exec	createCopyArchiveToContainerCmdExec()
CopyFileFromContainerCmd.Exec	createCopyFileFromContainerCmdExec()
CreateContainerCmd.Exec	createCreateContainerCmdExec()
CreateImageCmd.Exec	createCreateImageCmdExec()
CreateNetworkCmd.Exec	createCreateNetworkCmdExec()
CreateServiceCmd.Exec	createCreateServiceCmdExec() Command to create a new service in a docker swarm.
CreateVolumeCmd.Exec	createCreateVolumeCmdExec()
DisconnectFromNetworkCmd.Exec	createDisconnectFromNetworkCmdExec()
EventsCmd.Exec	createEventsCmdExec()
ExecCreateCmd.Exec	createExecCmdExec()
ExecStartCmd.Exec	createExecStartCmdExec()
InfoCmd.Exec	createInfoCmdExec()
InitializeSwarmCmd.Exec	createInitializeSwarmCmdExec()
InspectContainerCmd.Exec	createInspectContainerCmdExec()
InspectExecCmd.Exec	createInspectExecCmdExec()
InspectImageCmd.Exec	createInspectImageCmdExec()
InspectNetworkCmd.Exec	createInspectNetworkCmdExec()
InspectServiceCmd.Exec	createInspectServiceCmdExec() Command to inspect a service in a docker swarm.
InspectSwarmCmd.Exec	createInspectSwarmCmdExec()
InspectVolumeCmd.Exec	createInspectVolumeCmdExec()
JoinSwarmCmd.Exec	createJoinSwarmCmdExec()
KillContainerCmd.Exec	createKillContainerCmdExec()
LeaveSwarmCmd.Exec	createLeaveSwarmCmdExec()
ListContainersCmd.Exec	createListContainersCmdExec()
ListImagesCmd.Exec	createListImagesCmdExec()
ListNetworksCmd.Exec	createListNetworksCmdExec()
ListServicesCmd.Exec	createListServicesCmdExec() Command to list all services in a docker swarm.
ListVolumesCmd.Exec	createListVolumesCmdExec()
LoadImageCmd.Exec	createLoadImageCmdExec()
LogContainerCmd.Exec	createLogContainerCmdExec()
PauseContainerCmd.Exec	createPauseContainerCmdExec()
PingCmd.Exec	createPingCmdExec()
PullImageCmd.Exec	createPullImageCmdExec()
PushImageCmd.Exec	createPushImageCmdExec()
RemoveContainerCmd.Exec	createRemoveContainerCmdExec()
RemoveImageCmd.Exec	createRemoveImageCmdExec()
RemoveNetworkCmd.Exec	createRemoveNetworkCmdExec()
RemoveServiceCmd.Exec	createRemoveServiceCmdExec() Command to remove a service in a docker swarm.
RemoveVolumeCmd.Exec	createRemoveVolumeCmdExec()
RenameContainerCmd.Exec	createRenameContainerCmdExec() Rename container.
RestartContainerCmd.Exec	createRestartContainerCmdExec()
SaveImageCmd.Exec	createSaveImageCmdExec()
SearchImagesCmd.Exec	createSearchImagesCmdExec()
StartContainerCmd.Exec	createStartContainerCmdExec()
StatsCmd.Exec	createStatsCmdExec()
StopContainerCmd.Exec	createStopContainerCmdExec()
TagImageCmd.Exec	createTagImageCmdExec()
TopContainerCmd.Exec	createTopContainerCmdExec()
UnpauseContainerCmd.Exec	createUnpauseContainerCmdExec()
UpdateContainerCmd.Exec	createUpdateContainerCmdExec()
UpdateServiceCmd.Exec	createUpdateServiceCmdExec() Command to update a service specification in a docker swarm.
UpdateSwarmCmd.Exec	createUpdateSwarmCmdExec()
VersionCmd.Exec	createVersionCmdExec()
WaitContainerCmd.Exec	createWaitContainerCmdExec()
void	init(DockerClientConfig dockerClientConfig)
InspectSwarmNodeCmd.Exec	inspectSwarmNodeCmdExec() Return low-level information on the node.
ListSwarmNodesCmd.Exec	listSwarmNodeCmdExec() List all nodes.
ListTasksCmd.Exec	listTasksCmdExec() Update a node.
LogSwarmObjectCmd.Exec	logSwarmObjectExec(java.lang.String endpoint)
PruneCmd.Exec	pruneCmdExec() Delete unused content (containers, images, volumes, networks, build relicts)
RemoveSwarmNodeCmd.Exec	removeSwarmNodeCmdExec() Remove a node from the swarm.
UpdateSwarmNodeCmd.Exec	updateSwarmNodeCmdExec() Update a node.

Method Detail

init

void init(DockerClientConfig dockerClientConfig)

createAuthCmdExec

AuthCmd.Exec createAuthCmdExec()

createInfoCmdExec

InfoCmd.Exec createInfoCmdExec()

createPingCmdExec

PingCmd.Exec createPingCmdExec()

createExecCmdExec

ExecCreateCmd.Exec createExecCmdExec()

createVersionCmdExec

VersionCmd.Exec createVersionCmdExec()

createPullImageCmdExec

PullImageCmd.Exec createPullImageCmdExec()

createPushImageCmdExec

PushImageCmd.Exec createPushImageCmdExec()

createSaveImageCmdExec

SaveImageCmd.Exec createSaveImageCmdExec()

createCreateImageCmdExec

CreateImageCmd.Exec createCreateImageCmdExec()

createLoadImageCmdExec

LoadImageCmd.Exec createLoadImageCmdExec()

createSearchImagesCmdExec

SearchImagesCmd.Exec createSearchImagesCmdExec()

createRemoveImageCmdExec

RemoveImageCmd.Exec createRemoveImageCmdExec()

createListImagesCmdExec

ListImagesCmd.Exec createListImagesCmdExec()

createInspectImageCmdExec

InspectImageCmd.Exec createInspectImageCmdExec()

createListContainersCmdExec

ListContainersCmd.Exec createListContainersCmdExec()

createCreateContainerCmdExec

CreateContainerCmd.Exec createCreateContainerCmdExec()

createStartContainerCmdExec

StartContainerCmd.Exec createStartContainerCmdExec()

createInspectContainerCmdExec

InspectContainerCmd.Exec createInspectContainerCmdExec()

createRemoveContainerCmdExec

RemoveContainerCmd.Exec createRemoveContainerCmdExec()

createWaitContainerCmdExec

WaitContainerCmd.Exec createWaitContainerCmdExec()

createAttachContainerCmdExec

AttachContainerCmd.Exec createAttachContainerCmdExec()

createExecStartCmdExec

ExecStartCmd.Exec createExecStartCmdExec()

createInspectExecCmdExec

InspectExecCmd.Exec createInspectExecCmdExec()

createLogContainerCmdExec

LogContainerCmd.Exec createLogContainerCmdExec()

createCopyFileFromContainerCmdExec

CopyFileFromContainerCmd.Exec createCopyFileFromContainerCmdExec()

createCopyArchiveFromContainerCmdExec

CopyArchiveFromContainerCmd.Exec createCopyArchiveFromContainerCmdExec()

createCopyArchiveToContainerCmdExec

CopyArchiveToContainerCmd.Exec createCopyArchiveToContainerCmdExec()

createStopContainerCmdExec

StopContainerCmd.Exec createStopContainerCmdExec()

createContainerDiffCmdExec

ContainerDiffCmd.Exec createContainerDiffCmdExec()

createKillContainerCmdExec

KillContainerCmd.Exec createKillContainerCmdExec()

createUpdateContainerCmdExec

UpdateContainerCmd.Exec createUpdateContainerCmdExec()

createRenameContainerCmdExec

RenameContainerCmd.Exec createRenameContainerCmdExec()

Rename container.

Since:

RemoteApiVersion.VERSION_1_17

createRestartContainerCmdExec

RestartContainerCmd.Exec createRestartContainerCmdExec()

createCommitCmdExec

CommitCmd.Exec createCommitCmdExec()

createBuildImageCmdExec

BuildImageCmd.Exec createBuildImageCmdExec()

createTopContainerCmdExec

TopContainerCmd.Exec createTopContainerCmdExec()

createTagImageCmdExec

TagImageCmd.Exec createTagImageCmdExec()

createPauseContainerCmdExec

PauseContainerCmd.Exec createPauseContainerCmdExec()

createUnpauseContainerCmdExec

UnpauseContainerCmd.Exec createUnpauseContainerCmdExec()

createEventsCmdExec

EventsCmd.Exec createEventsCmdExec()

createStatsCmdExec

StatsCmd.Exec createStatsCmdExec()

createCreateVolumeCmdExec

CreateVolumeCmd.Exec createCreateVolumeCmdExec()

createInspectVolumeCmdExec

InspectVolumeCmd.Exec createInspectVolumeCmdExec()

createRemoveVolumeCmdExec

RemoveVolumeCmd.Exec createRemoveVolumeCmdExec()

createListVolumesCmdExec

ListVolumesCmd.Exec createListVolumesCmdExec()

createListNetworksCmdExec

ListNetworksCmd.Exec createListNetworksCmdExec()

createInspectNetworkCmdExec

InspectNetworkCmd.Exec createInspectNetworkCmdExec()

createCreateNetworkCmdExec

CreateNetworkCmd.Exec createCreateNetworkCmdExec()

createRemoveNetworkCmdExec

RemoveNetworkCmd.Exec createRemoveNetworkCmdExec()

createConnectToNetworkCmdExec

ConnectToNetworkCmd.Exec createConnectToNetworkCmdExec()

createDisconnectFromNetworkCmdExec

DisconnectFromNetworkCmd.Exec createDisconnectFromNetworkCmdExec()

createInitializeSwarmCmdExec

InitializeSwarmCmd.Exec createInitializeSwarmCmdExec()

createInspectSwarmCmdExec

InspectSwarmCmd.Exec createInspectSwarmCmdExec()

createJoinSwarmCmdExec

JoinSwarmCmd.Exec createJoinSwarmCmdExec()

createLeaveSwarmCmdExec

LeaveSwarmCmd.Exec createLeaveSwarmCmdExec()

createUpdateSwarmCmdExec

UpdateSwarmCmd.Exec createUpdateSwarmCmdExec()

createListServicesCmdExec

ListServicesCmd.Exec createListServicesCmdExec()

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

Since:

RemoteApiVersion.VERSION_1_24

createCreateServiceCmdExec

CreateServiceCmd.Exec createCreateServiceCmdExec()

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

Since:

RemoteApiVersion.VERSION_1_24

createInspectServiceCmdExec

InspectServiceCmd.Exec createInspectServiceCmdExec()

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

Since:

RemoteApiVersion.VERSION_1_24

createUpdateServiceCmdExec

UpdateServiceCmd.Exec createUpdateServiceCmdExec()

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

Since:

RemoteApiVersion.VERSION_1_24

createRemoveServiceCmdExec

RemoveServiceCmd.Exec createRemoveServiceCmdExec()

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

Since:

RemoteApiVersion.VERSION_1_24

logSwarmObjectExec

LogSwarmObjectCmd.Exec logSwarmObjectExec(java.lang.String endpoint)

Parameters:

endpoint - endpoint name to tail logs

Returns:

Since:

RemoteApiVersion.VERSION_1_29

listSwarmNodeCmdExec

ListSwarmNodesCmd.Exec listSwarmNodeCmdExec()

List all nodes. Node operations require the engine to be part of a swarm

Since:

RemoteApiVersion.VERSION_1_24

inspectSwarmNodeCmdExec

InspectSwarmNodeCmd.Exec inspectSwarmNodeCmdExec()

Return low-level information on the node. Node operations require the engine to be part of a swarm

Since:

RemoteApiVersion.VERSION_1_24

removeSwarmNodeCmdExec

RemoveSwarmNodeCmd.Exec removeSwarmNodeCmdExec()

Remove a node from the swarm. Node operations require the engine to be part of a swarm

Since:

RemoteApiVersion.VERSION_1_24

updateSwarmNodeCmdExec

UpdateSwarmNodeCmd.Exec updateSwarmNodeCmdExec()

Update a node. Node operations require the engine to be part of a swarm

Since:

RemoteApiVersion.VERSION_1_24

listTasksCmdExec

ListTasksCmd.Exec listTasksCmdExec()

Update a node. Node operations require the engine to be part of a swarm

Since:

RemoteApiVersion.VERSION_1_24

pruneCmdExec

PruneCmd.Exec pruneCmdExec()

Delete unused content (containers, images, volumes, networks, build relicts)

Since:

RemoteApiVersion.VERSION_1_25

close

void close()
    throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException