org.eclipse.jkube.kit.build.service.docker

Class RunService

java.lang.Object

org.eclipse.jkube.kit.build.service.docker.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, org.eclipse.jkube.kit.common.KitLogger log)

Method Summary

Modifier and Type	Method and Description
void	addShutdownHookForStoppingContainers(boolean keepContainer, boolean removeVolumes, boolean removeCustomNetworks) Add a shutdown hook in order to stop all registered containers
String	createAndStartContainer(org.eclipse.jkube.kit.config.image.ImageConfiguration imageConfig, PortMapping portMapping, GavLabel gavLabel, Properties properties, File baseDir, String defaultContainerNamePattern, Date buildTimestamp) Create and start a container with the given image configuration.
void	createCustomNetworkIfNotExistant(String customNetwork)
PortMapping	createPortMapping(org.eclipse.jkube.kit.config.image.RunImageConfiguration runConfig, Properties properties) Create port mapping for a specific configuration as it can be used when creating containers
List<String>	createVolumesAsPerVolumeBinds(DockerServiceHub hub, List<String> binds, List<VolumeConfiguration> volumes) Creates a Volume if a volume is referred to during startup in bind mount mapping and a VolumeConfiguration exists
String	execInContainer(String containerId, String command, org.eclipse.jkube.kit.config.image.ImageConfiguration imageConfiguration) Create and start a Exec container with the given image configuration.
List<org.eclipse.jkube.kit.config.image.ImageConfiguration>	getImagesConfigsInOrder(QueryService queryService, List<org.eclipse.jkube.kit.config.image.ImageConfiguration> images) Get the proper order for images to start
String	lookupContainer(String lookup) Lookup a container that has been started
void	removeCustomNetworks(Collection<Network> networks)
void	stopContainer(String containerId, org.eclipse.jkube.kit.config.image.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, boolean removeCustomNetworks, GavLabel gavLabel) 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,
                  org.eclipse.jkube.kit.common.KitLogger log)

Method Detail

execInContainer

public String execInContainer(String containerId,
                              String command,
                              org.eclipse.jkube.kit.config.image.ImageConfiguration imageConfiguration)
                       throws DockerAccessException,
                              ExecException

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

ExecException - if any problem faced during exec

createAndStartContainer

public String createAndStartContainer(org.eclipse.jkube.kit.config.image.ImageConfiguration imageConfig,
                                      PortMapping portMapping,
                                      GavLabel gavLabel,
                                      Properties properties,
                                      File baseDir,
                                      String defaultContainerNamePattern,
                                      Date buildTimestamp)
                               throws DockerAccessException

Create and start a container with the given image configuration.

Parameters:

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

portMapping - container port mapping

gavLabel - label to tag the started container with

baseDir - base directory

properties - properties to fill in with dynamically assigned ports

defaultContainerNamePattern - pattern to use for naming containers. Can be null in which case a default pattern is used

buildTimestamp - date which should be used as the timestamp when calculating container names

Returns:

the container id

Throws:

DockerAccessException - if access to the docker backend fails

stopContainer

public void stopContainer(String containerId,
                          org.eclipse.jkube.kit.config.image.ImageConfiguration imageConfig,
                          boolean keepContainer,
                          boolean removeVolumes)
                   throws DockerAccessException,
                          ExecException

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 stopping

removeVolumes - whether to remove volumes after stopping

Throws:

DockerAccessException - docker access exception

ExecException - exec exception

stopPreviouslyStartedContainer

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

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 - docker access exception

ExecException - exec exception

stopStartedContainers

public void stopStartedContainers(boolean keepContainer,
                                  boolean removeVolumes,
                                  boolean removeCustomNetworks,
                                  GavLabel gavLabel)
                           throws DockerAccessException,
                                  ExecException

Stop all registered container

Parameters:

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

removeVolumes - whether to remove volumes after stopping

removeCustomNetworks - whether to remove custom networks

gavLabel - group artifact version label

Throws:

DockerAccessException - if during stopping of a container sth fails

ExecException - if any problem during exec

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<org.eclipse.jkube.kit.config.image.ImageConfiguration> getImagesConfigsInOrder(QueryService queryService,
                                                                                           List<org.eclipse.jkube.kit.config.image.ImageConfiguration> images)

Get the proper order for images to start

Parameters:

queryService - query service

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

Returns:

list of images in the right startup order

createPortMapping

public PortMapping createPortMapping(org.eclipse.jkube.kit.config.image.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,
                                                 boolean removeCustomNetworks)

Add a shutdown hook in order to stop all registered containers

Parameters:

keepContainer - whether to keep container or not

removeVolumes - whether to remove volumes or not

removeCustomNetworks - whether to remove custom networks or not

createCustomNetworkIfNotExistant

public void createCustomNetworkIfNotExistant(String customNetwork)
                                      throws DockerAccessException

Throws:

DockerAccessException

removeCustomNetworks

public void removeCustomNetworks(Collection<Network> networks)
                          throws DockerAccessException

Throws:

DockerAccessException

createVolumesAsPerVolumeBinds

public List<String> createVolumesAsPerVolumeBinds(DockerServiceHub hub,
                                                  List<String> binds,
                                                  List<VolumeConfiguration> volumes)
                                           throws DockerAccessException

Creates a Volume if a volume is referred to during startup in bind mount mapping and a VolumeConfiguration exists

Parameters:

hub - Service hub

binds - volume binds present in ImageConfiguration

volumes - VolumeConfigs present

Returns:

List of volumes created

Throws:

DockerAccessException - docker access exception