net.wouterdanes.docker.remoteapi

Class MiscService

java.lang.Object

net.wouterdanes.docker.remoteapi.BaseService

net.wouterdanes.docker.remoteapi.MiscService

public class MiscService
extends BaseService

The class act as an interface to the "root" Remote Docker API with some "misc" service end points.

Field Summary

Fields inherited from class net.wouterdanes.docker.remoteapi.BaseService

REGISTRY_AUTH_HEADER

Constructor Summary

Constructors

Constructor and Description
MiscService(String dockerApiRoot)

Method Summary

Modifier and Type	Method and Description
String	buildImage(byte[] tarArchive, Optional<String> name, Optional<String> buildArguments) Builds an image based on the passed tar archive.
String	commitContainer(String container, Optional<String> repo, Optional<String> tag, Optional<String> comment, Optional<String> author) Create a new image from a container's changes
DockerVersionInfo	getVersionInfo() Returns the Docker version information

Methods inherited from class net.wouterdanes.docker.remoteapi.BaseService

checkImageTargetingResponse, getRegistryAuthHeaderValue, getServiceEndPoint, makeImageTargetingException, setCredentials, toJson, toObject

Methods inherited from class java.lang.Object

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

Constructor Detail

MiscService

public MiscService(String dockerApiRoot)

Method Detail

getVersionInfo

public DockerVersionInfo getVersionInfo()

Returns the Docker version information

Returns:

a DockerVersionInfo instance describing this docker installation.

commitContainer

public String commitContainer(String container,
                              Optional<String> repo,
                              Optional<String> tag,
                              Optional<String> comment,
                              Optional<String> author)

Create a new image from a container's changes

Parameters:

container - source container

repo - repository

tag - tag

comment - commit message

author - author (e.g., "John Hannibal Smith <hannibal@a-team.com>")

Returns:

the ID of the created image

buildImage

public String buildImage(byte[] tarArchive,
                         Optional<String> name,
                         Optional<String> buildArguments)

Builds an image based on the passed tar archive. Optionally names & tags the image

Parameters:

tarArchive - the tar archive to use as a source for the image

name - the name and optional tag of the image.

buildArguments - a list of optional build arguments made available to the Dockerfile.

Returns:

the ID of the created image