org.hobbit.controller.docker

Interface ContainerManager

All Known Implementing Classes:

ContainerManagerImpl

public interface ContainerManager

This interface is implemented by classes that can be used to manage Docker containers.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Field Summary

Fields

Modifier and Type	Field and Description
static String	LABEL_PARENT Label that denotes container parent
static String	LABEL_TYPE Label that denotes container type

Method Summary

Modifier and Type	Method and Description
void	addContainerObserver(ContainerStateObserver containerObserver) Adds the given observer to the list of internal observers.
String	getContainerId(String name) Retrieves the container Id for the container with the given name or null if no such container could be found.
com.spotify.docker.client.messages.swarm.Task	getContainerInfo(String containerId) Returns container info
String	getContainerName(String containerId) Returns the name of the container with the given Id or null if such a container can not be found
default List<com.spotify.docker.client.messages.swarm.Task>	getContainers() Get a list of tasks
List<com.spotify.docker.client.messages.swarm.Task>	getContainers(com.spotify.docker.client.messages.swarm.Task.Criteria criteria) Get a list of tasks which fulfill the given filter criteria.
com.spotify.docker.client.messages.ContainerStats	getStats(String containerId) Returns statistics of the container with the given Id or null if the container can not be found or an error occurs.
void	pullImage(String imageName) Pulls the image with the given name.
void	removeContainer(String containerId) Removes the container with the given container Id.
void	removeParentAndChildren(String parentId) Removes the parent container and all its children given the parent id
String	startContainer(String imageName) Deprecated. because the method tries to create a container with type=null and parent="" which does not work without a predefined default type for all containers that are created in that way. Use startContainer(String, String, String) instead.
String	startContainer(String imageName, String[] command) Deprecated. because the method tries to create a container with type=null and parent="" which does not work without a predefined default type for all containers that are created in that way. Use startContainer(String, String, String, String[]) instead.
String	startContainer(String imageName, String type, String parent) Start container with given image, type and parent
String	startContainer(String imageName, String containerType, String parentId, String[] command) Starts the container with the given image name.
String	startContainer(String imageName, String containerType, String parentId, String[] env, String[] command) Starts the container with the given image name.
String	startContainer(String imageName, String containerType, String parentId, String[] env, String[] command, String experimentId) Starts the container with the given image name.
void	stopContainer(String containerId) Deprecated. use removeContainer(String) instead.
void	stopParentAndChildren(String parentId) Deprecated. use removeParentAndChildren(String) instead.

Field Detail

LABEL_TYPE

static final String LABEL_TYPE

Label that denotes container type

See Also:

Constant Field Values

LABEL_PARENT

static final String LABEL_PARENT

Label that denotes container parent

See Also:

Constant Field Values

Method Detail

startContainer

@Deprecated
String startContainer(String imageName)

Deprecated. because the method tries to create a container with type=null and parent="" which does not work without a predefined default type for all containers that are created in that way. Use startContainer(String, String, String) instead.

Start container with container type Benchmark and no parent

Parameters:

imageName - Name of the image to start

Returns:

container id

startContainer

String startContainer(String imageName,
                      String[] command)

Deprecated. because the method tries to create a container with type=null and parent="" which does not work without a predefined default type for all containers that are created in that way. Use startContainer(String, String, String, String[]) instead.

Start container with container type Benchmark and no parent

Parameters:

imageName - name of the image to start

command - command to be executed

Returns:

container id

startContainer

String startContainer(String imageName,
                      String type,
                      String parent)

Start container with given image, type and parent

Parameters:

imageName - name of the image to start

type - container type

parent - parent id

Returns:

container id

startContainer

String startContainer(String imageName,
                      String containerType,
                      String parentId,
                      String[] command)

Starts the container with the given image name.

Parameters:

imageName - name of the image to be started

containerType - type to be assigned to container

parentId - id of the parent container

command - commands that should be executed

Returns:

container Id or null if an error occurred.

startContainer

String startContainer(String imageName,
                      String containerType,
                      String parentId,
                      String[] env,
                      String[] command)

Starts the container with the given image name.

Parameters:

imageName - name of the image to be started

containerType - type to be assigned to container

parentId - id of the parent container

env - environment variables of the schema "key=value"

command - commands that should be executed

Returns:

container Id or null if an error occurred.

startContainer

String startContainer(String imageName,
                      String containerType,
                      String parentId,
                      String[] env,
                      String[] command,
                      String experimentId)

Starts the container with the given image name.

Parameters:

imageName - name of the image to be started

containerType - type to be assigned to container

parentId - id of the parent container

env - environment variables of the schema "key=value"

command - commands that should be executed

experimentId - experimentId to add to GELF tag

Returns:

container Id or null if an error occurred.

stopContainer

@Deprecated
void stopContainer(String containerId)

Deprecated. use removeContainer(String) instead.

Stops the container with the given container Id.

Parameters:

containerId - id of the container that should be stopped

removeContainer

void removeContainer(String containerId)

Removes the container with the given container Id.

Parameters:

containerId - id of the container that should be removed

stopParentAndChildren

@Deprecated
void stopParentAndChildren(String parentId)

Deprecated. use removeParentAndChildren(String) instead.

Stops the parent container and all its children given the parent id

Parameters:

parentId - id of the parent container

removeParentAndChildren

void removeParentAndChildren(String parentId)

Removes the parent container and all its children given the parent id

Parameters:

parentId - id of the parent container

getContainerInfo

com.spotify.docker.client.messages.swarm.Task getContainerInfo(String containerId)
                                                        throws InterruptedException,
                                                               com.spotify.docker.client.exceptions.DockerException

Returns container info

Parameters:

containerId -

Throws:

InterruptedException

com.spotify.docker.client.exceptions.DockerException

getContainers

default List<com.spotify.docker.client.messages.swarm.Task> getContainers()

Get a list of tasks

getContainers

List<com.spotify.docker.client.messages.swarm.Task> getContainers(com.spotify.docker.client.messages.swarm.Task.Criteria criteria)

Get a list of tasks which fulfill the given filter criteria.

getContainerId

String getContainerId(String name)

Retrieves the container Id for the container with the given name or null if no such container could be found.

getContainerName

String getContainerName(String containerId)

Returns the name of the container with the given Id or null if such a container can not be found

Parameters:

containerId - the Id of the container for which the name should be retrieved

Returns:

the name of the container with the given Id or null if such a container can not be found

addContainerObserver

void addContainerObserver(ContainerStateObserver containerObserver)

Adds the given observer to the list of internal observers.

Parameters:

containerObserver - the observer that should be added to the internal list

pullImage

void pullImage(String imageName)

Pulls the image with the given name.

Parameters:

imageName - the name of the image that should be pulled

getStats

com.spotify.docker.client.messages.ContainerStats getStats(String containerId)

Returns statistics of the container with the given Id or null if the container can not be found or an error occurs.

Parameters:

containerId - the Id of the container for which statistics should be requested

Returns:

statistics of the container with the given Id or null if the container can not be found or an error occurs.