org.hobbit.core.components.stream

Class AbstractStreamingSystemAdapter

java.lang.Object

org.hobbit.core.components.AbstractComponent

org.hobbit.core.components.AbstractCommandReceivingComponent

org.hobbit.core.components.AbstractPlatformConnectorComponent

org.hobbit.core.components.stream.AbstractStreamingSystemAdapter

All Implemented Interfaces:

Closeable, AutoCloseable, CommandReceivingComponent, Component, PlatformConnector, StreamingGeneratedDataReceivingComponent, StreamingTaskReceivingComponent, TaskReceivingComponent

Direct Known Subclasses:

AbstractSystemAdapter

public abstract class AbstractStreamingSystemAdapter
extends AbstractPlatformConnectorComponent
implements StreamingGeneratedDataReceivingComponent, TaskReceivingComponent

This abstract class implements basic functions that can be used to implement a system adapter.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractStreamingSystemAdapter.GeneratedDataHandler A simple internal handler class that calls StreamingGeneratedDataReceivingComponent.receiveGeneratedData(InputStream) with the given InputStream.
protected class	AbstractStreamingSystemAdapter.GeneratedTaskHandler A simple internal handler class that calls AbstractStreamingTaskGenerator.generateTask(InputStream) with the given InputStream.

Field Summary

Fields

Modifier and Type	Field and Description
private Exception	cause The cause for an unusual termination.
private Semaphore	causeMutex Mutex used to manage access to the cause object.
protected DataReceiver	dataReceiver
private static int	DEFAULT_MAX_PARALLEL_PROCESSED_MESSAGES Default value of the maxParallelProcessedMsgs attribute.
private static org.slf4j.Logger	LOGGER
private int	maxParallelProcessedMsgs The maximum number of incoming messages that are processed in parallel.
protected DataSender	sender2EvalStore
protected org.apache.jena.rdf.model.Model	systemParamModel The RDF model containing the system parameters.
protected DataReceiver	taskReceiver
private Semaphore	terminateMutex Mutex used to wait for the terminate signal.

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
AbstractStreamingSystemAdapter()
AbstractStreamingSystemAdapter(DataSender sender2EvalStore, DataReceiver dataReceiver, DataReceiver taskReceiver)
AbstractStreamingSystemAdapter(int maxParallelProcessedMsgs)

Method Summary

Modifier and Type	Method and Description
void	close()
void	init() This method initializes the component.
void	receiveCommand(byte command, byte[] data) This method is called if a command is received and might be interesting for this particular component.
void	run() This method executes the component.
protected void	sendResultToEvalStorage(String taskIdString, InputStream dataStream) This method sends the given result data for the task with the given task id to the evaluation storage.
protected void	terminate(Exception cause) Starts termination of the main thread of this system adapter.

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

addContainerObserver, createContainer, getFactoryForIncomingCmdQueues, getFactoryForIncomingDataQueues, getFactoryForOutgoingCmdQueues, getFactoryForOutgoingDataQueues, stopContainer

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

addCommandHeaderId, createContainer, createContainer, handleCmd, sendToCmdQueue, sendToCmdQueue, sendToCmdQueue

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

Methods inherited from interface org.hobbit.core.components.stream.StreamingGeneratedDataReceivingComponent

receiveGeneratedData

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

receiveGeneratedTask

Methods inherited from interface org.hobbit.core.components.stream.StreamingTaskReceivingComponent

receiveGeneratedTask

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

DEFAULT_MAX_PARALLEL_PROCESSED_MESSAGES

private static final int DEFAULT_MAX_PARALLEL_PROCESSED_MESSAGES

Default value of the maxParallelProcessedMsgs attribute.

See Also:

Constant Field Values

terminateMutex

private Semaphore terminateMutex

Mutex used to wait for the terminate signal.

maxParallelProcessedMsgs

private final int maxParallelProcessedMsgs

The maximum number of incoming messages that are processed in parallel. Additional messages have to wait.

systemParamModel

protected org.apache.jena.rdf.model.Model systemParamModel

The RDF model containing the system parameters.

sender2EvalStore

protected DataSender sender2EvalStore

dataReceiver

protected DataReceiver dataReceiver

taskReceiver

protected DataReceiver taskReceiver

cause

private Exception cause

The cause for an unusual termination.

causeMutex

private Semaphore causeMutex

Mutex used to manage access to the cause object.

Constructor Detail

AbstractStreamingSystemAdapter

public AbstractStreamingSystemAdapter()

AbstractStreamingSystemAdapter

public AbstractStreamingSystemAdapter(int maxParallelProcessedMsgs)

AbstractStreamingSystemAdapter

public AbstractStreamingSystemAdapter(DataSender sender2EvalStore,
                                      DataReceiver dataReceiver,
                                      DataReceiver taskReceiver)

Method Detail

init

public void init()
          throws Exception

Description copied from interface: Component

This method initializes the component.

Specified by:

init in interface Component

Overrides:

init in class AbstractCommandReceivingComponent

Throws:

Exception - if an error occurs during the initialization

run

public void run()
         throws Exception

Description copied from interface: Component

This method executes the component.

Specified by:

run in interface Component

Throws:

Exception - if an error occurs during the execution

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

Overrides:

receiveCommand in class AbstractPlatformConnectorComponent

Parameters:

command - the byte encoding the command

data - additional data that was sent together with the command

terminate

protected void terminate(Exception cause)

Starts termination of the main thread of this system adapter. If a cause is given, it will be thrown causing an abortion from the main thread instead of a normal termination.

Parameters:

cause - the cause for an abortion of the process or {code null} if the component should terminate in a normal way.

sendResultToEvalStorage

protected void sendResultToEvalStorage(String taskIdString,
                                       InputStream dataStream)
                                throws IOException

This method sends the given result data for the task with the given task id to the evaluation storage.

Parameters:

taskIdString - the id of the task

data - the data of the task

Throws:

IOException - if there is an error during the sending

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractCommandReceivingComponent

Throws:

IOException