com.nirima.docker.api

Interface MiscClient

public interface MiscClient

Author:

Nigel Magnay [nigel.magnay@gmail.com]

Method Summary

Modifier and Type	Method and Description
Void	auth()
InputStream	build(String repositoryNameAndTag, boolean supressVerboseOutput, boolean suppressCache, InputStream content)
IdResponse	commit(String container, String commitMessage, String repository, String tag, String author, String run)
javax.ws.rs.core.Response	events(Long since, Long until) Monitor Docker's events
byte[]	getTarball(String name)
Info	info()
String	ping() Ping the docker server.
Void	postTarball(byte[] data)
Version	version()

Method Detail

build

@POST
 @Path(value="/build")
 @Consumes(value="application/tar")
 @Produces(value="text/plain")
InputStream build(@QueryParam(value="t")
                                                                                                                  String repositoryNameAndTag,
                                                                                                                  @QueryParam(value="q")
                                                                                                                  boolean supressVerboseOutput,
                                                                                                                  @QueryParam(value="nocache")
                                                                                                                  boolean suppressCache,
                                                                                                                  InputStream content)

auth

@POST
 @Path(value="/auth")
Void auth()

info

@GET
 @Path(value="/info")
Info info()

version

@GET
 @Path(value="/version")
Version version()

commit

@POST
 @Path(value="/commit")
IdResponse commit(@QueryParam(value="container")
                                                String container,
                                                @QueryParam(value="m")
                                                String commitMessage,
                                                @QueryParam(value="repo")
                                                String repository,
                                                @QueryParam(value="tag")
                                                String tag,
                                                @QueryParam(value="author")
                                                String author,
                                                @QueryParam(value="run")
                                                String run)

events

@GET
 @Path(value="/events")
javax.ws.rs.core.Response events(@QueryParam(value="since")
                                                              Long since,
                                                              @QueryParam(value="since")
                                                              Long until)

Monitor Docker's events

Parameters:

since - timestamp used for polling

until - timestamp used for polling

Returns:

stream of events

getTarball

@GET
 @Path(value="/images/{name}/list")
byte[] getTarball(@PathParam(value="name")
                                                           String name)

postTarball

@POST
 @Path(value="/images/load")
Void postTarball(byte[] data)

ping

@GET
 @Path(value="/_ping")
String ping()

Ping the docker server.

Since:

1.11