net.wouterdanes.docker.provider

Interface DockerProvider

All Known Implementing Classes:

LocalDockerProvider, RemoteApiBasedDockerProvider, RemoteDockerProvider

public interface DockerProvider

This interface represents an implementation that provides Docker functionality. Examples are:

• Local Docker via Unix Socket
• Local Docker via TCP Socket
• Remote (Boot2Docker) via TCP Socket
• tutum.co

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
List<ExposedPort>	getExposedPorts(String containerId) Returns a list of ports exposed by the container, including information on how to reach them
String	getLogs(String containerId) Returns the logs of the specified container
void	pushImage(String nameAndTag) Pushes an image from docker to a registry.
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.
ContainerInspectionResult	startContainer(ContainerStartConfiguration configuration) Starts a docker container and returns the ID of the started container
void	stopContainer(String containerId) Stops a docker container
void	tagImage(String imageId, String nameAndTag) Associates an image with a new repo/tag.

Method Detail

setCredentials

void setCredentials(Credentials credentials)

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

Parameters:

credentials - the user credentials, may be null

startContainer

ContainerInspectionResult startContainer(ContainerStartConfiguration configuration)

Starts a docker container and returns the ID of the started container

Parameters:

configuration - the configuration parameters

Returns:

the ID of the started container

stopContainer

void stopContainer(String containerId)

Stops a docker container

Parameters:

containerId - the Id of the container to stop

deleteContainer

void deleteContainer(String containerId)

Delete a docker container

Parameters:

containerId - the Id of the container to delete

getExposedPorts

List<ExposedPort> getExposedPorts(String containerId)

Returns a list of ports exposed by the container, including information on how to reach them

Parameters:

containerId - the Id of the container

Returns:

List of ExposedPorts

buildImage

String buildImage(ImageBuildConfiguration image)

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

Parameters:

image - the image configuration to use

Returns:

the id of the new Docker Image

commitContainer

String commitContainer(ContainerCommitConfiguration configuration)

Create a new image from a container's changes

Parameters:

configuration - the configuration parameters

Returns:

the ID of the created image

removeImage

void removeImage(String imageId)

Removes an image from docker

Parameters:

imageId - the Id of the images to remove

pushImage

void pushImage(String nameAndTag)

Pushes an image from docker to a registry.

Parameters:

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

tagImage

void tagImage(String imageId,
              String nameAndTag)

Associates an image with a new repo/tag.

Parameters:

imageId - the Id of the image to tag

nameAndTag - the repo/tag to assign

getLogs

String getLogs(String containerId)

Returns the logs of the specified container

Parameters:

containerId - the Id of the container

Returns:

the container's logs

setLogger

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

Sets the logger to use.

Parameters:

logger - the Maven logger to use

setRepositorySystem

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

Sets the repositorySystem to use.

Parameters:

repositorySystem - the Maven repositorySystem to use

setRepositorySystemSession

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

Sets the repositorySystemSession to use.

Parameters:

repositorySystemSession - the Maven repositorySystemSession to use

setRemoteRepositories

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

Sets the remoteRepositories to use.

Parameters:

remoteRepositories - the Maven remoteRepositories to use