net.wouterdanes.docker.provider

Class RemoteApiBasedDockerProvider

java.lang.Object

net.wouterdanes.docker.provider.RemoteApiBasedDockerProvider

All Implemented Interfaces:

DockerProvider

Direct Known Subclasses:

LocalDockerProvider, RemoteDockerProvider

public abstract class RemoteApiBasedDockerProvider
extends Object
implements DockerProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCKER_HOST_PROPERTY
static String	DOCKER_HOST_SYSTEM_ENV
static String	DOCKER_PORT_PROPERTY
static String	TCP_PROTOCOL

Constructor Summary

Constructors

Modifier	Constructor and Description
	RemoteApiBasedDockerProvider()
protected	RemoteApiBasedDockerProvider(String host, int port)

Method Summary

Modifier and Type	Method and Description
String	buildImage(ImageBuildConfiguration image) Builds a new Docker Image based on the passed configuration and returns the id of the newly created image.
String	commitContainer(ContainerCommitConfiguration configuration) Create a new image from a container's changes
void	deleteContainer(String containerId) Delete a docker container
protected ContainersService	getContainersService()
protected String	getHost()
protected ImagesService	getImagesService()
String	getLogs(String containerId) Returns the logs of the specified container
protected int	getPort()
void	pushImage(String nameAndTag) Pushes an image from docker to a registry.
protected void	register(BaseService... servicesToBeRegistered)
void	removeImage(String imageId) Removes an image from docker
void	setCredentials(Credentials credentials) Sets (or un-sets) the credentials to be used when communicating with the Docker host.
void	setLogger(org.apache.maven.plugin.logging.Log logger) Sets the logger to use.
void	setRemoteRepositories(List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories) Sets the remoteRepositories to use.
void	setRepositorySystem(org.eclipse.aether.RepositorySystem repositorySystem) Sets the repositorySystem to use.
void	setRepositorySystemSession(org.eclipse.aether.RepositorySystemSession repositorySystemSession) Sets the repositorySystemSession to use.
protected ContainerInspectionResult	startContainer(ContainerStartConfiguration configuration, ContainerStartRequest startRequest)
void	stopContainer(String containerId) Stops a docker container
void	tagImage(String imageId, String nameAndTag) Associates an image with a new repo/tag.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.wouterdanes.docker.provider.DockerProvider

getExposedPorts, startContainer

Field Detail

DOCKER_HOST_SYSTEM_ENV

public static final String DOCKER_HOST_SYSTEM_ENV

See Also:

Constant Field Values

DOCKER_HOST_PROPERTY

public static final String DOCKER_HOST_PROPERTY

See Also:

Constant Field Values

DOCKER_PORT_PROPERTY

public static final String DOCKER_PORT_PROPERTY

See Also:

Constant Field Values

TCP_PROTOCOL

public static final String TCP_PROTOCOL

See Also:

Constant Field Values

Constructor Detail

RemoteApiBasedDockerProvider

public RemoteApiBasedDockerProvider()

RemoteApiBasedDockerProvider

protected RemoteApiBasedDockerProvider(String host,
                                       int port)

Method Detail

setCredentials

public void setCredentials(Credentials credentials)

Description copied from interface: DockerProvider

Sets (or un-sets) the credentials to be used when communicating with the Docker host.

Specified by:

setCredentials in interface DockerProvider

Parameters:

credentials - the user credentials, may be null

stopContainer

public void stopContainer(String containerId)

Description copied from interface: DockerProvider

Stops a docker container

Specified by:

stopContainer in interface DockerProvider

Parameters:

containerId - the Id of the container to stop

deleteContainer

public void deleteContainer(String containerId)

Description copied from interface: DockerProvider

Delete a docker container

Specified by:

deleteContainer in interface DockerProvider

Parameters:

containerId - the Id of the container to delete

buildImage

public String buildImage(ImageBuildConfiguration image)

Description copied from interface: DockerProvider

Builds a new Docker Image based on the passed configuration and returns the id of the newly created image.

Specified by:

buildImage in interface DockerProvider

Parameters:

image - the image configuration to use

Returns:

the id of the new Docker Image

commitContainer

public String commitContainer(ContainerCommitConfiguration configuration)

Description copied from interface: DockerProvider

Create a new image from a container's changes

Specified by:

commitContainer in interface DockerProvider

Parameters:

configuration - the configuration parameters

Returns:

the ID of the created image

removeImage

public void removeImage(String imageId)

Description copied from interface: DockerProvider

Removes an image from docker

Specified by:

removeImage in interface DockerProvider

Parameters:

imageId - the Id of the images to remove

pushImage

public void pushImage(String nameAndTag)

Description copied from interface: DockerProvider

Pushes an image from docker to a registry.

Specified by:

pushImage in interface DockerProvider

Parameters:

nameAndTag - optional name and tag to be associated with pushed image

tagImage

public void tagImage(String imageId,
                     String nameAndTag)

Description copied from interface: DockerProvider

Associates an image with a new repo/tag.

Specified by:

tagImage in interface DockerProvider

Parameters:

imageId - the Id of the image to tag

nameAndTag - the repo/tag to assign

toString

public String toString()

Overrides:

toString in class Object

getLogs

public String getLogs(String containerId)

Description copied from interface: DockerProvider

Returns the logs of the specified container

Specified by:

getLogs in interface DockerProvider

Parameters:

containerId - the Id of the container

Returns:

the container's logs

setLogger

public void setLogger(org.apache.maven.plugin.logging.Log logger)

Description copied from interface: DockerProvider

Sets the logger to use.

Specified by:

setLogger in interface DockerProvider

Parameters:

logger - the Maven logger to use

setRepositorySystem

public void setRepositorySystem(org.eclipse.aether.RepositorySystem repositorySystem)

Description copied from interface: DockerProvider

Sets the repositorySystem to use.

Specified by:

setRepositorySystem in interface DockerProvider

Parameters:

repositorySystem - the Maven repositorySystem to use

setRepositorySystemSession

public void setRepositorySystemSession(org.eclipse.aether.RepositorySystemSession repositorySystemSession)

Description copied from interface: DockerProvider

Sets the repositorySystemSession to use.

Specified by:

setRepositorySystemSession in interface DockerProvider

Parameters:

repositorySystemSession - the Maven repositorySystemSession to use

setRemoteRepositories

public void setRemoteRepositories(List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories)

Description copied from interface: DockerProvider

Sets the remoteRepositories to use.

Specified by:

setRemoteRepositories in interface DockerProvider

Parameters:

remoteRepositories - the Maven remoteRepositories to use

startContainer

protected ContainerInspectionResult startContainer(ContainerStartConfiguration configuration,
                                                   ContainerStartRequest startRequest)

getContainersService

protected ContainersService getContainersService()

getImagesService

protected ImagesService getImagesService()

register

protected void register(BaseService... servicesToBeRegistered)

getHost

protected String getHost()

getPort

protected int getPort()