org.hobbit.core.components

Class AbstractPlatformConnectorComponent

java.lang.Object

org.hobbit.core.components.AbstractComponent

org.hobbit.core.components.AbstractCommandReceivingComponent

org.hobbit.core.components.AbstractPlatformConnectorComponent

All Implemented Interfaces:

Closeable, AutoCloseable, CommandReceivingComponent, Component, PlatformConnector, RabbitQueueFactory

Direct Known Subclasses:

AbstractBenchmarkController, AbstractDataGenerator, AbstractEvaluationModule, AbstractEvaluationStorage, AbstractSystemAdapter, AbstractTaskGenerator

public abstract class AbstractPlatformConnectorComponent
extends AbstractCommandReceivingComponent
implements PlatformConnector

This extension of the AbstractCommandReceivingComponent offers some platform functionalities to other classes by implementing the PlatformConnector interface.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,ContainerStateObserver>	containerObservers

Fields inherited from class org.hobbit.core.components.AbstractCommandReceivingComponent

cmdChannel, cmdConnection, defaultContainerType

Fields inherited from class org.hobbit.core.components.AbstractComponent

connectionFactory, dataConnection, NUMBER_OF_RETRIES_TO_CONNECT_TO_RABBIT_MQ, rabbitMQHostName, START_WAITING_TIME_BEFORE_RETRY

Constructor Summary

Constructors

Constructor and Description
AbstractPlatformConnectorComponent()

Method Summary

Modifier and Type	Method and Description
protected void	addContainerObserver(String containerName, ContainerStateObserver observer)
String	createContainer(String imageName, String[] envVariables, ContainerStateObserver observer) This method sends a Commands.DOCKER_CONTAINER_START command to create and start an instance of the given image using the given environment variables.
RabbitQueue	createDefaultRabbitQueue(String name) This method opens a channel using the established AbstractComponent.dataConnection to RabbitMQ and creates a new queue using the given name and the following configuration: The channel number is automatically derived from the connection.
void	receiveCommand(byte command, byte[] data) This method is called if a command is received and might be interesting for this particular component.
void	stopContainer(String containerName) This method sends a Commands.DOCKER_CONTAINER_STOP command to stop the container with the given id.

Methods inherited from class org.hobbit.core.components.AbstractCommandReceivingComponent

addCommandHeaderId, close, createContainer, createContainer, handleCmd, init, sendToCmdQueue, sendToCmdQueue, sendToCmdQueue

Methods inherited from class org.hobbit.core.components.AbstractComponent

generateSessionQueueName, getHobbitSessionId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hobbit.core.components.Component

run

Field Detail

containerObservers

private Map<String,ContainerStateObserver> containerObservers

Constructor Detail

AbstractPlatformConnectorComponent

public AbstractPlatformConnectorComponent()

Method Detail

createDefaultRabbitQueue

public RabbitQueue createDefaultRabbitQueue(String name)
                                     throws IOException

This method opens a channel using the established AbstractComponent.dataConnection to RabbitMQ and creates a new queue using the given name and the following configuration:

• The channel number is automatically derived from the connection.
• The queue is not durable.
• The queue is not exclusive.
• The queue is configured to be deleted automatically.
• No additional queue configuration is defined.

Specified by:

createDefaultRabbitQueue in interface RabbitQueueFactory

Overrides:

createDefaultRabbitQueue in class AbstractComponent

Parameters:

name - name of the queue

Returns:

RabbitQueue object comprising the Channel and the name of the created queue

Throws:

IOException - if a communication error occurs

createContainer

public String createContainer(String imageName,
                              String[] envVariables,
                              ContainerStateObserver observer)

Description copied from interface: PlatformConnector

This method sends a Commands.DOCKER_CONTAINER_START command to create and start an instance of the given image using the given environment variables.

Specified by:

createContainer in interface PlatformConnector

Parameters:

imageName - the name of the image of the docker container

envVariables - environment variables that should be added to the created container

observer - the container state observer that is called if the container terminates

Returns:

the name of the container instance or null if an error occurred

receiveCommand

public void receiveCommand(byte command,
                           byte[] data)

Description copied from interface: CommandReceivingComponent

This method is called if a command is received and might be interesting for this particular component.

Specified by:

receiveCommand in interface CommandReceivingComponent

Parameters:

command - the byte encoding the command

data - additional data that was sent together with the command

stopContainer

public void stopContainer(String containerName)

Description copied from class: AbstractCommandReceivingComponent

This method sends a Commands.DOCKER_CONTAINER_STOP command to stop the container with the given id.

Specified by:

stopContainer in interface PlatformConnector

Overrides:

stopContainer in class AbstractCommandReceivingComponent

Parameters:

containerName - the name of the container instance that should be stopped

addContainerObserver

protected void addContainerObserver(String containerName,
                                    ContainerStateObserver observer)