io.fabric8.maven.docker.service

Class RunService

java.lang.Object

io.fabric8.maven.docker.service.RunService

public class RunService
extends Object

Service class for helping in running containers.

Since:

16/06/15

Author:

roland

Constructor Summary

Constructors

Constructor and Description
RunService(DockerAccess docker, QueryService queryService, ContainerTracker tracker, LogOutputSpecFactory logConfig, Logger log)

Method Summary

Modifier and Type	Method and Description
void	addShutdownHookForStoppingContainers(boolean keepContainer, boolean removeVolumes) Add a shutdown hook in order to stop all registered containers
String	createAndStartContainer(ImageConfiguration imageConfig, PortMapping mappedPorts, PomLabel pomLabel, Properties mavenProps) Create and start a container with the given image configuration.
String	execInContainer(String containerId, String command, ImageConfiguration imageConfiguration) Create and start a Exec container with the given image configuration.
List<StartOrderResolver.Resolvable>	getImagesConfigsInOrder(QueryService queryService, List<ImageConfiguration> images) Get the proper order for images to start
PortMapping	getPortMapping(RunImageConfiguration runConfig, Properties properties) Create port mapping for a specific configuration as it can be used when creating containers
String	lookupContainer(String lookup) Lookup a container that has been started
void	stopContainer(String containerId, ImageConfiguration imageConfig, boolean keepContainer, boolean removeVolumes) Stop a container immediately by id.
void	stopPreviouslyStartedContainer(String containerId, boolean keepContainer, boolean removeVolumes) Lookup up whether a certain has been already started and registered.
void	stopStartedContainers(boolean keepContainer, boolean removeVolumes, PomLabel pomLabel) Stop all registered container

Methods inherited from class java.lang.Object

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

Constructor Detail

RunService

public RunService(DockerAccess docker,
                  QueryService queryService,
                  ContainerTracker tracker,
                  LogOutputSpecFactory logConfig,
                  Logger log)

Method Detail

execInContainer

public String execInContainer(String containerId,
                              String command,
                              ImageConfiguration imageConfiguration)
                       throws DockerAccessException

Create and start a Exec container with the given image configuration.

Parameters:

containerId - container id to run exec command against

command - command to execute

imageConfiguration - configuration of the container's image

Returns:

the exec container id

Throws:

DockerAccessException - if access to the docker backend fails

createAndStartContainer

public String createAndStartContainer(ImageConfiguration imageConfig,
                                      PortMapping mappedPorts,
                                      PomLabel pomLabel,
                                      Properties mavenProps)
                               throws DockerAccessException

Create and start a container with the given image configuration.

Parameters:

imageConfig - image configuration holding the run information and the image name

mappedPorts - container port mapping

mavenProps - properties to fill in with dynamically assigned ports

pomLabel - label to tag the started container with

Returns:

the container id

Throws:

DockerAccessException - if access to the docker backend fails

stopContainer

public void stopContainer(String containerId,
                          ImageConfiguration imageConfig,
                          boolean keepContainer,
                          boolean removeVolumes)
                   throws DockerAccessException

Stop a container immediately by id.

Parameters:

containerId - the container to stop

imageConfig - image configuration for this container

keepContainer - whether to keep container or to remove them after stoppings

removeVolumes - whether to remove volumes after stopping

Throws:

DockerAccessException

stopPreviouslyStartedContainer

public void stopPreviouslyStartedContainer(String containerId,
                                           boolean keepContainer,
                                           boolean removeVolumes)
                                    throws DockerAccessException

Lookup up whether a certain has been already started and registered. If so, stop it

Parameters:

containerId - the container to stop

keepContainer - whether to keep container or to remove them after stoppings

removeVolumes - whether to remove volumes after stopping

Throws:

DockerAccessException

stopStartedContainers

public void stopStartedContainers(boolean keepContainer,
                                  boolean removeVolumes,
                                  PomLabel pomLabel)
                           throws DockerAccessException

Stop all registered container

Parameters:

keepContainer - whether to keep container or to remove them after stoppings

removeVolumes - whether to remove volumes after stopping

Throws:

DockerAccessException - if during stopping of a container sth fails

lookupContainer

public String lookupContainer(String lookup)

Lookup a container that has been started

Parameters:

lookup - a container by id or alias

Returns:

the container id if the container exists, null otherwise.

getImagesConfigsInOrder

public List<StartOrderResolver.Resolvable> getImagesConfigsInOrder(QueryService queryService,
                                                                   List<ImageConfiguration> images)

Get the proper order for images to start

Parameters:

images - list of images for which the order should be created

Returns:

list of images in the right startup order

getPortMapping

public PortMapping getPortMapping(RunImageConfiguration runConfig,
                                  Properties properties)

Create port mapping for a specific configuration as it can be used when creating containers

Parameters:

runConfig - the cun configuration

properties - properties to lookup variables

Returns:

the portmapping

addShutdownHookForStoppingContainers

public void addShutdownHookForStoppingContainers(boolean keepContainer,
                                                 boolean removeVolumes)

Add a shutdown hook in order to stop all registered containers