com.github.dockerjava.api
Interface DockerClient

All Superinterfaces:

Closeable

All Known Implementing Classes:

DockerClientImpl

public interface DockerClient
extends Closeable

Method Summary

AttachContainerCmd	attachContainerCmd(String containerId)
AuthCmd	authCmd() Authenticate with the server, useful for checking authentication.
AuthConfig	authConfig()
BuildImageCmd	buildImageCmd(File dockerFolder)
BuildImageCmd	buildImageCmd(InputStream tarInputStream)
void	close()
CommitCmd	commitCmd(String containerId)
ContainerDiffCmd	containerDiffCmd(String containerId)
CopyFileFromContainerCmd	copyFileFromContainerCmd(String containerId, String resource)
CreateContainerCmd	createContainerCmd(String image)
CreateImageCmd	createImageCmd(String repository, InputStream imageStream)
EventsCmd	eventsCmd(EventCallback eventCallback)
InfoCmd	infoCmd()
InspectContainerCmd	inspectContainerCmd(String containerId)
InspectImageCmd	inspectImageCmd(String imageId)
KillContainerCmd	killContainerCmd(String containerId)
ListContainersCmd	listContainersCmd() * CONTAINER API *
ListImagesCmd	listImagesCmd()
LogContainerCmd	logContainerCmd(String containerId)
PauseContainerCmd	pauseContainerCmd(String containerId)
PingCmd	pingCmd()
PullImageCmd	pullImageCmd(String repository) * IMAGE API *
PushImageCmd	pushImageCmd(String name)
RemoveContainerCmd	removeContainerCmd(String containerId)
RemoveImageCmd	removeImageCmd(String imageId)
RestartContainerCmd	restartContainerCmd(String containerId)
SearchImagesCmd	searchImagesCmd(String term)
StartContainerCmd	startContainerCmd(String containerId)
StopContainerCmd	stopContainerCmd(String containerId)
TagImageCmd	tagImageCmd(String imageId, String repository, String tag)
TopContainerCmd	topContainerCmd(String containerId)
UnpauseContainerCmd	unpauseContainerCmd(String containerId)
VersionCmd	versionCmd()
WaitContainerCmd	waitContainerCmd(String containerId)

Method Detail

authConfig

AuthConfig authConfig()
                      throws DockerException

Throws:

DockerException

authCmd

AuthCmd authCmd()

Authenticate with the server, useful for checking authentication.

infoCmd

InfoCmd infoCmd()

pingCmd

PingCmd pingCmd()

versionCmd

VersionCmd versionCmd()

pullImageCmd

PullImageCmd pullImageCmd(String repository)

* IMAGE API *

pushImageCmd

PushImageCmd pushImageCmd(String name)

createImageCmd

CreateImageCmd createImageCmd(String repository,
                              InputStream imageStream)

searchImagesCmd

SearchImagesCmd searchImagesCmd(String term)

removeImageCmd

RemoveImageCmd removeImageCmd(String imageId)

listImagesCmd

ListImagesCmd listImagesCmd()

inspectImageCmd

InspectImageCmd inspectImageCmd(String imageId)

listContainersCmd

ListContainersCmd listContainersCmd()

* CONTAINER API *

createContainerCmd

CreateContainerCmd createContainerCmd(String image)

startContainerCmd

StartContainerCmd startContainerCmd(String containerId)

inspectContainerCmd

InspectContainerCmd inspectContainerCmd(String containerId)

removeContainerCmd

RemoveContainerCmd removeContainerCmd(String containerId)

waitContainerCmd

WaitContainerCmd waitContainerCmd(String containerId)

attachContainerCmd

AttachContainerCmd attachContainerCmd(String containerId)

logContainerCmd

LogContainerCmd logContainerCmd(String containerId)

copyFileFromContainerCmd

CopyFileFromContainerCmd copyFileFromContainerCmd(String containerId,
                                                  String resource)

containerDiffCmd

ContainerDiffCmd containerDiffCmd(String containerId)

stopContainerCmd

StopContainerCmd stopContainerCmd(String containerId)

killContainerCmd

KillContainerCmd killContainerCmd(String containerId)

restartContainerCmd

RestartContainerCmd restartContainerCmd(String containerId)

commitCmd

CommitCmd commitCmd(String containerId)

buildImageCmd

BuildImageCmd buildImageCmd(File dockerFolder)

buildImageCmd

BuildImageCmd buildImageCmd(InputStream tarInputStream)

topContainerCmd

TopContainerCmd topContainerCmd(String containerId)

tagImageCmd

TagImageCmd tagImageCmd(String imageId,
                        String repository,
                        String tag)

pauseContainerCmd

PauseContainerCmd pauseContainerCmd(String containerId)

unpauseContainerCmd

UnpauseContainerCmd unpauseContainerCmd(String containerId)

eventsCmd

EventsCmd eventsCmd(EventCallback eventCallback)

close

void close()
           throws IOException

Specified by:

close in interface Closeable

Throws:

IOException