org.hobbit.controller

Class PlatformController

java.lang.Object

org.hobbit.core.components.AbstractComponent

org.hobbit.core.components.AbstractCommandReceivingComponent

org.hobbit.controller.PlatformController

All Implemented Interfaces:

Closeable, AutoCloseable, ExperimentAnalyzer, ContainerTerminationCallback, org.hobbit.core.components.CommandReceivingComponent, org.hobbit.core.components.Component

public class PlatformController
extends org.hobbit.core.components.AbstractCommandReceivingComponent
implements ContainerTerminationCallback, ExperimentAnalyzer

This class implements the functionality of the central platform controller.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Timer	challengePublishTimer Timer used to trigger publishing of challenges
protected ClusterManager	clusterManager
private static boolean	CONTAINER_PARENT_CHECK
private static String	CONTAINER_PARENT_CHECK_ENV_KEY
protected ContainerManager	containerManager A manager for Docker containers.
protected ContainerStateObserver	containerObserver The observer of docker containers.
protected com.rabbitmq.client.Channel	controller2Analysis RabbitMQ channel between front end and platform controller.
private static String	DEPLOY_ENV
private static String	DEPLOY_ENV_DEVELOP
private static String	DEPLOY_ENV_TESTING
protected ExperimentManager	expManager
protected com.rabbitmq.client.Channel	frontEnd2Controller RabbitMQ channel between front end and platform controller.
protected FrontEndApiHandler	frontEndApiHandler The handler for requests coming from the front end.
private com.google.gson.Gson	gson Threadsafe JSON parser.
protected ClusterHealthChecker	healthChecker Health checker used to make sure that the cluster has the preconfigured hardware.
protected ImageManager	imageManager Manager of benchmark and system images.
private long	lastIdTime Last experiment id that has been used.
private static org.slf4j.Logger	LOGGER
static String	PLATFORM_VERSION The current version of the platform.
static long	PUBLISH_CHALLENGES
protected ExperimentQueue	queue The queue containing experiments that are waiting for their execution.
private static String	RABBIT_MQ_EXPERIMENTS_HOST_NAME_KEY
protected String	rabbitMQExperimentsHostName
protected ResourceInformationCollector	resInfoCollector
protected org.hobbit.storage.client.StorageServiceClient	storage
private Semaphore	terminationMutex A simple mutex that is used to wait for a termination signal for the controller.

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

cmdChannel, cmdQueueFactory, DEFAULT_CMD_RESPONSE_TIMEOUT, defaultContainerType

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

connectionFactory, incomingDataQueueFactory, NUMBER_OF_RETRIES_TO_CONNECT_TO_RABBIT_MQ, outgoingDataQueuefactory, rabbitMQHostName, START_WAITING_TIME_BEFORE_RETRY

Constructor Summary

Constructors

Constructor and Description
PlatformController()

Method Summary

Modifier and Type	Method and Description
protected String	addExperimentToQueue(String benchmarkUri, String systemUri, String userName, String serializedBenchParams, String challengUri, String challengTaskUri, Calendar executionDate) Adds a new experiment with the given benchmark, system and benchmark parameter to the queue.
void	analyzeExperiment(String uri) Runs further analysis based on the experiment results of the given URI.
protected void	checkRepeatableChallenges()
void	close()
private void	closeChallenge(String challengeUri) Closes the challenge with the given URI by adding the "closed" triple to its graph and inserting the configured experiments into the queue.
protected static boolean	copyChallengeToPublicResultGraph(org.hobbit.storage.client.StorageServiceClient storage, String challengeUri) Copies the challenge from challenge definition graph to public graph.
private String	createContainer(org.hobbit.core.data.StartCommandData data) Creates and starts a container based on the given StartCommandData instance.
private org.apache.jena.rdf.model.Model	createExpModelForChallengeTask(org.apache.jena.rdf.model.Model model, String challengeTaskUri, String systemUri)
private org.hobbit.core.data.StartCommandData	deserializeStartCommandData(byte[] data)
private org.hobbit.core.data.StopCommandData	deserializeStopCommandData(byte[] data)
private void	executeChallengeExperiments(String challengeUri) Inserts the configured experiments of a challenge into the queue.
private String	generateExperimentId() Generates a unique experiment Id based on the current time stamp and the last Id (lastIdTime) that has been created.
static String	generateExperimentUri(String id) Generates an experiment URI using the given id and the experiment URI namespace defined by Constants.EXPERIMENT_URI_NS.
protected org.apache.jena.rdf.model.Model	getChallengeFromUri(String challengeUri, String graphUri) Retrieves model for the given challenge from the given graph (or without selecting a certain graph if the graphUri is null).
private List<ExperimentConfiguration>	getChallengeTasksFromUri(String challengeUri)
private org.hobbit.core.data.status.ControllerStatus	getStatus(String userName) Creates a status object summarizing the current status of this controller.
protected void	handleCmd(byte[] bytes, String replyTo) The controller overrides the super method because it does not need to check for the leading hobbit id and delegates the command handling to the receiveCommand(byte, byte[], String, String) method.
void	handleFrontEndCmd(byte[] bytes, String replyTo, com.rabbitmq.client.AMQP.BasicProperties replyProperties)
ImageManager	imageManager()
void	init()
void	notifyTermination(String containerId, int exitCode) This method is called if the container with the given container Id terminated.
String	rabbitMQHostName()
private static String	readVersion()
void	receiveCommand(byte command, byte[] data) Deprecated. Not used inside the controller. Use receiveCommand(byte, byte[], String, String) instead.
void	receiveCommand(byte command, byte[] data, String sessionId, String replyTo) Handles incoming command request from the hobbit command queue.
protected static void	republishChallenges(org.hobbit.storage.client.StorageServiceClient storage, ExperimentQueue queue, ExperimentAnalyzer analyzer)
void	run()
protected static void	scheduleDateOfNextExecution(org.hobbit.storage.client.StorageServiceClient storage, String challengeUri, Calendar now) Schedules the date of next execution for a repeatable challenge, or closes it.
protected void	sendToCmdQueue(byte command) Deprecated. The PlatformController should use #sendToCmdQueue(String, byte, byte[], BasicProperties)
protected void	sendToCmdQueue(byte command, byte[] data) Deprecated. The PlatformController should use #sendToCmdQueue(String, byte, byte[], BasicProperties)
protected void	sendToCmdQueue(byte command, byte[] data, com.rabbitmq.client.AMQP.BasicProperties props) Deprecated. The PlatformController should use #sendToCmdQueue(String, byte, byte[], BasicProperties)
protected void	sendToCmdQueue(String address, byte command, byte[] data, com.rabbitmq.client.AMQP.BasicProperties props) Sends the given command to the command queue with the given data appended and using the given properties.
void	stopContainer(String containerName) Stops the container with the given container name.
org.hobbit.storage.client.StorageServiceClient	storage()
private void	switchCmdToExpRabbit() This method closes the command queue and its handling and reopens it on the RabbitMQ broker which will be used for experiments.

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

addCommandHeaderId, createContainer, createContainer

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

createConnection, generateSessionQueueName, getHobbitSessionId

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

PLATFORM_VERSION

public static final String PLATFORM_VERSION

The current version of the platform.

DEPLOY_ENV

private static final String DEPLOY_ENV

DEPLOY_ENV_TESTING

private static final String DEPLOY_ENV_TESTING

See Also:

Constant Field Values

DEPLOY_ENV_DEVELOP

private static final String DEPLOY_ENV_DEVELOP

See Also:

Constant Field Values

CONTAINER_PARENT_CHECK_ENV_KEY

private static final String CONTAINER_PARENT_CHECK_ENV_KEY

See Also:

Constant Field Values

CONTAINER_PARENT_CHECK

private static final boolean CONTAINER_PARENT_CHECK

RABBIT_MQ_EXPERIMENTS_HOST_NAME_KEY

private static final String RABBIT_MQ_EXPERIMENTS_HOST_NAME_KEY

See Also:

Constant Field Values

PUBLISH_CHALLENGES

public static final long PUBLISH_CHALLENGES

See Also:

Constant Field Values

frontEnd2Controller

protected com.rabbitmq.client.Channel frontEnd2Controller

RabbitMQ channel between front end and platform controller.

frontEndApiHandler

protected FrontEndApiHandler frontEndApiHandler

The handler for requests coming from the front end.

controller2Analysis

protected com.rabbitmq.client.Channel controller2Analysis

RabbitMQ channel between front end and platform controller.

containerManager

protected ContainerManager containerManager

A manager for Docker containers.

containerObserver

protected ContainerStateObserver containerObserver

The observer of docker containers.

queue

protected ExperimentQueue queue

The queue containing experiments that are waiting for their execution.

healthChecker

protected ClusterHealthChecker healthChecker

Health checker used to make sure that the cluster has the preconfigured hardware.

terminationMutex

private Semaphore terminationMutex

A simple mutex that is used to wait for a termination signal for the controller.

gson

private com.google.gson.Gson gson

Threadsafe JSON parser.

imageManager

protected ImageManager imageManager

Manager of benchmark and system images.

lastIdTime

private long lastIdTime

Last experiment id that has been used.

storage

protected org.hobbit.storage.client.StorageServiceClient storage

expManager

protected ExperimentManager expManager

resInfoCollector

protected ResourceInformationCollector resInfoCollector

clusterManager

protected ClusterManager clusterManager

challengePublishTimer

protected Timer challengePublishTimer

Timer used to trigger publishing of challenges

rabbitMQExperimentsHostName

protected String rabbitMQExperimentsHostName

Constructor Detail

PlatformController

public PlatformController()

Method Detail

init

public void init()
          throws Exception

Specified by:

init in interface org.hobbit.core.components.Component

Overrides:

init in class org.hobbit.core.components.AbstractCommandReceivingComponent

Throws:

Exception

switchCmdToExpRabbit

private void switchCmdToExpRabbit()
                           throws Exception

This method closes the command queue and its handling and reopens it on the RabbitMQ broker which will be used for experiments.

Throws:

Exception

receiveCommand

public void receiveCommand(byte command,
                           byte[] data,
                           String sessionId,
                           String replyTo)

Handles incoming command request from the hobbit command queue.

Commands handled by this method:

• Commands.DOCKER_CONTAINER_START
• Commands.DOCKER_CONTAINER_STOP

Parameters:

command - command to be executed

data - byte-encoded supplementary json for the command 0 - start container 1 - stop container Data format for each command: Start container:

deserializeStopCommandData

private org.hobbit.core.data.StopCommandData deserializeStopCommandData(byte[] data)

deserializeStartCommandData

private org.hobbit.core.data.StartCommandData deserializeStartCommandData(byte[] data)

createContainer

private String createContainer(org.hobbit.core.data.StartCommandData data)

Creates and starts a container based on the given StartCommandData instance.

Parameters:

data - the data needed to start the container

Returns:

the name of the created container

stopContainer

public void stopContainer(String containerName)

Stops the container with the given container name.

Overrides:

stopContainer in class org.hobbit.core.components.AbstractCommandReceivingComponent

Parameters:

containerName - name of the container that should be stopped

run

public void run()
         throws Exception

Specified by:

run in interface org.hobbit.core.components.Component

Throws:

Exception

notifyTermination

public void notifyTermination(String containerId,
                              int exitCode)

Description copied from interface: ContainerTerminationCallback

This method is called if the container with the given container Id terminated.

Specified by:

notifyTermination in interface ContainerTerminationCallback

Parameters:

containerId - the id of the container that terminated

exitCode - the exit code of the container

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class org.hobbit.core.components.AbstractCommandReceivingComponent

Throws:

IOException

analyzeExperiment

public void analyzeExperiment(String uri)
                       throws IOException

Description copied from interface: ExperimentAnalyzer

Runs further analysis based on the experiment results of the given URI.

Specified by:

analyzeExperiment in interface ExperimentAnalyzer

Parameters:

uri - the URI of the experiment which should be enhanced with further analysis

Throws:

IOException

sendToCmdQueue

protected void sendToCmdQueue(String address,
                              byte command,
                              byte[] data,
                              com.rabbitmq.client.AMQP.BasicProperties props)
                       throws IOException

Sends the given command to the command queue with the given data appended and using the given properties.

Parameters:

address - address for the message

command - the command that should be sent

data - data that should be appended to the command

props - properties that should be used for the message

Throws:

IOException

handleCmd

protected void handleCmd(byte[] bytes,
                         String replyTo)

The controller overrides the super method because it does not need to check for the leading hobbit id and delegates the command handling to the receiveCommand(byte, byte[], String, String) method.

Overrides:

handleCmd in class org.hobbit.core.components.AbstractCommandReceivingComponent

handleFrontEndCmd

public void handleFrontEndCmd(byte[] bytes,
                              String replyTo,
                              com.rabbitmq.client.AMQP.BasicProperties replyProperties)

getChallengeFromUri

protected org.apache.jena.rdf.model.Model getChallengeFromUri(String challengeUri,
                                                              String graphUri)

Retrieves model for the given challenge from the given graph (or without selecting a certain graph if the graphUri is null).

Parameters:

challengeUri - the URI for which the model should be retrieved

graphUri - the URI from which the data should be retrieved or null if all graphs should be taken into account.

Returns:

the RDF model of the challenge

getChallengeTasksFromUri

private List<ExperimentConfiguration> getChallengeTasksFromUri(String challengeUri)

executeChallengeExperiments

private void executeChallengeExperiments(String challengeUri)

Inserts the configured experiments of a challenge into the queue.

Parameters:

challengeUri - the URI of the challenge

scheduleDateOfNextExecution

protected static void scheduleDateOfNextExecution(org.hobbit.storage.client.StorageServiceClient storage,
                                                  String challengeUri,
                                                  Calendar now)

Schedules the date of next execution for a repeatable challenge, or closes it.

Parameters:

storage - storage

challengeUri - challenge URI

now - time to use as current when scheduling

copyChallengeToPublicResultGraph

protected static boolean copyChallengeToPublicResultGraph(org.hobbit.storage.client.StorageServiceClient storage,
                                                          String challengeUri)

Copies the challenge from challenge definition graph to public graph.

Parameters:

storage - storage

challengeUri - challenge URI

closeChallenge

private void closeChallenge(String challengeUri)

Closes the challenge with the given URI by adding the "closed" triple to its graph and inserting the configured experiments into the queue.

Parameters:

challengeUri - the URI of the challenge that should be closed

checkRepeatableChallenges

protected void checkRepeatableChallenges()

republishChallenges

protected static void republishChallenges(org.hobbit.storage.client.StorageServiceClient storage,
                                          ExperimentQueue queue,
                                          ExperimentAnalyzer analyzer)

createExpModelForChallengeTask

private org.apache.jena.rdf.model.Model createExpModelForChallengeTask(org.apache.jena.rdf.model.Model model,
                                                                       String challengeTaskUri,
                                                                       String systemUri)

addExperimentToQueue

protected String addExperimentToQueue(String benchmarkUri,
                                      String systemUri,
                                      String userName,
                                      String serializedBenchParams,
                                      String challengUri,
                                      String challengTaskUri,
                                      Calendar executionDate)

Adds a new experiment with the given benchmark, system and benchmark parameter to the queue.

Parameters:

benchmarkUri - the URI of the benchmark

systemUri - the URI of the system

userName - the name of the user who requested the creation of the experiment

serializedBenchParams - the serialized benchmark parameters

executionDate - the date at which this experiment should be executed as part of a challenge. Should be set to null if it is not part of a challenge.

Returns:

the Id of the created experiment

getStatus

private org.hobbit.core.data.status.ControllerStatus getStatus(String userName)

Creates a status object summarizing the current status of this controller.

Returns:

the status of this controller

generateExperimentId

private String generateExperimentId()

Generates a unique experiment Id based on the current time stamp and the last Id (lastIdTime) that has been created.

Returns:

a unique experiment Id

generateExperimentUri

public static String generateExperimentUri(String id)

Generates an experiment URI using the given id and the experiment URI namespace defined by Constants.EXPERIMENT_URI_NS.

Parameters:

id - the id of the experiment

Returns:

the experiment URI

imageManager

public ImageManager imageManager()

storage

public org.hobbit.storage.client.StorageServiceClient storage()

rabbitMQHostName

public String rabbitMQHostName()

receiveCommand

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

Deprecated. Not used inside the controller. Use receiveCommand(byte, byte[], String, String) instead.

Specified by:

receiveCommand in interface org.hobbit.core.components.CommandReceivingComponent

sendToCmdQueue

@Deprecated
protected void sendToCmdQueue(byte command)
                                   throws IOException

Deprecated. The PlatformController should use #sendToCmdQueue(String, byte, byte[], BasicProperties)

Overrides:

sendToCmdQueue in class org.hobbit.core.components.AbstractCommandReceivingComponent

Throws:

IOException

sendToCmdQueue

@Deprecated
protected void sendToCmdQueue(byte command,
                                          byte[] data)
                                   throws IOException

Deprecated. The PlatformController should use #sendToCmdQueue(String, byte, byte[], BasicProperties)

Overrides:

sendToCmdQueue in class org.hobbit.core.components.AbstractCommandReceivingComponent

Throws:

IOException

sendToCmdQueue

@Deprecated
protected void sendToCmdQueue(byte command,
                                          byte[] data,
                                          com.rabbitmq.client.AMQP.BasicProperties props)
                                   throws IOException

Deprecated. The PlatformController should use #sendToCmdQueue(String, byte, byte[], BasicProperties)

Overrides:

sendToCmdQueue in class org.hobbit.core.components.AbstractCommandReceivingComponent

Throws:

IOException

readVersion

private static String readVersion()