com.github.dockerjava.client
Class DockerClient

java.lang.Object
  com.github.dockerjava.client.DockerClient

All Implemented Interfaces:

Closeable

public class DockerClient
extends Object
implements Closeable

Author:

Konstantin Pelykh ([email protected])

Constructor Summary

DockerClient()

DockerClient(Config config)

DockerClient(Config config, CommandFactory cmdFactory)

DockerClient(String serverUrl)

Method Summary

static String	asString(com.sun.jersey.api.client.ClientResponse response)
AttachContainerCmd	attachContainerCmd(String containerId)
AuthCmd	authCmd() Authenticate with the server, useful for checking authentication.
AuthConfig	authConfig()
BuildImgCmd	buildImageCmd(File dockerFolder)
BuildImgCmd	buildImageCmd(InputStream tarInputStream)
void	close()
CommitCmd	commitCmd(String containerId)
ContainerDiffCmd	containerDiffCmd(String containerId)
CopyFileFromContainerCmd	copyFileFromContainerCmd(String containerId, String resource)
CreateContainerCmd	createContainerCmd(String image)
<RES_T> RES_T	execute(AbstrDockerCmd<?,RES_T> command)
ImportImageCmd	importImageCmd(String repository, InputStream imageStream)
InfoCmd	infoCmd()
InspectContainerCmd	inspectContainerCmd(String containerId)
InspectImageCmd	inspectImageCmd(String imageId)
KillContainerCmd	killContainerCmd(String containerId)
ListContainersCmd	listContainersCmd() * CONTAINER API *
ListImagesCmd	listImagesCmd()
LogContainerCmd	logContainerCmd(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)
void	setCredentials(String username, String password, String email)
StartContainerCmd	startContainerCmd(String containerId)
StopContainerCmd	stopContainerCmd(String containerId)
TagImageCmd	tagImageCmd(String imageId, String repository, String tag)
TopContainerCmd	topContainerCmd(String containerId)
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

DockerClient

public DockerClient()

DockerClient

public DockerClient(String serverUrl)

DockerClient

public DockerClient(Config config)

DockerClient

public DockerClient(Config config,
                    CommandFactory cmdFactory)

Method Detail

setCredentials

public void setCredentials(String username,
                           String password,
                           String email)

execute

public <RES_T> RES_T execute(AbstrDockerCmd<?,RES_T> command)
              throws DockerException

Throws:

DockerException

authConfig

public AuthConfig authConfig()
                      throws DockerException

Throws:

DockerException

authCmd

public AuthCmd authCmd()

Authenticate with the server, useful for checking authentication.

infoCmd

public InfoCmd infoCmd()
                throws DockerException

Throws:

DockerException

pingCmd

public PingCmd pingCmd()

versionCmd

public VersionCmd versionCmd()
                      throws DockerException

Throws:

DockerException

pullImageCmd

public PullImageCmd pullImageCmd(String repository)

* IMAGE API *

pushImageCmd

public PushImageCmd pushImageCmd(String name)

importImageCmd

public ImportImageCmd importImageCmd(String repository,
                                     InputStream imageStream)

searchImagesCmd

public SearchImagesCmd searchImagesCmd(String term)

removeImageCmd

public RemoveImageCmd removeImageCmd(String imageId)

listImagesCmd

public ListImagesCmd listImagesCmd()

inspectImageCmd

public InspectImageCmd inspectImageCmd(String imageId)

listContainersCmd

public ListContainersCmd listContainersCmd()

* CONTAINER API *

createContainerCmd

public CreateContainerCmd createContainerCmd(String image)

startContainerCmd

public StartContainerCmd startContainerCmd(String containerId)

inspectContainerCmd

public InspectContainerCmd inspectContainerCmd(String containerId)

removeContainerCmd

public RemoveContainerCmd removeContainerCmd(String containerId)

waitContainerCmd

public WaitContainerCmd waitContainerCmd(String containerId)

attachContainerCmd

public AttachContainerCmd attachContainerCmd(String containerId)

logContainerCmd

public LogContainerCmd logContainerCmd(String containerId)

copyFileFromContainerCmd

public CopyFileFromContainerCmd copyFileFromContainerCmd(String containerId,
                                                         String resource)

containerDiffCmd

public ContainerDiffCmd containerDiffCmd(String containerId)

stopContainerCmd

public StopContainerCmd stopContainerCmd(String containerId)

killContainerCmd

public KillContainerCmd killContainerCmd(String containerId)

restartContainerCmd

public RestartContainerCmd restartContainerCmd(String containerId)

commitCmd

public CommitCmd commitCmd(String containerId)

buildImageCmd

public BuildImgCmd buildImageCmd(File dockerFolder)

buildImageCmd

public BuildImgCmd buildImageCmd(InputStream tarInputStream)

topContainerCmd

public TopContainerCmd topContainerCmd(String containerId)

tagImageCmd

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

asString

public static String asString(com.sun.jersey.api.client.ClientResponse response)
                       throws IOException

Returns:

The output slurped into a string.

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Throws:

IOException