Package org.eso.ias.converter

Class ConverterStream

java.lang.Object

org.eso.ias.converter.ConverterStream

Direct Known Subclasses:

ConverterKafkaStream

public abstract class ConverterStream
extends Object

The interface to stream the strings received from the plugin (i.e. the stringified version of a monitor point value or alarm) to strings to send to the core of the IAS (i.e. a stringified representation of a IAS value)

Classes extending ConverterStream could need to instantiate a thread (in start() to receive data from the input stream depending on the underlying transport system.

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	converterID	The ID of the converter.
protected Function<String,String>	mapper	The function to map a input string to output string

Constructor Summary

Constructors

Constructor	Description
ConverterStream(String converterID)	Constructor

Method Summary

Modifier and Type	Method	Description
protected abstract void	init()	User defined initialization
void	initialize(Function<String,String> mapper)	Initialize the stream
void	start()	Start streaming data from the input to the output stream in a dedicated thread.
protected abstract void	startStreaming()	Start streaming data from the input to the output stream in a dedicated thread.
void	stop()	Stops getting data from the input stream
protected abstract void	stopStreaming()	Stops getting data from the input stream

Methods inherited from class java.lang.Object

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

Field Details

mapper

protected Function<String,String> mapper

The function to map a input string to output string

converterID

protected final String converterID

The ID of the converter.

The ID of the converter uniquely identify each running converter

Constructor Details

ConverterStream

public ConverterStream(String converterID)

Constructor

Parameters:

converterID - The ID of the converter.

Method Details

initialize

public void initialize(Function<String,String> mapper)
                throws ConverterStreamException

Initialize the stream

After some initialization, it delegates to init()

Parameters:

mapper - the function to map inputs to outputs

Throws:

ConverterStreamException - in case of error initializing

init

protected abstract void init()
                      throws ConverterStreamException

User defined initialization

Throws:

ConverterStreamException - in case of error initializing

start

public void start()
           throws ConverterStreamException

Start streaming data from the input to the output stream in a dedicated thread.

it delegates to the user implemented startStreaming()

Throws:

ConverterStreamException - in case of error starting

stop

public void stop()
          throws ConverterStreamException

Stops getting data from the input stream

it delegates to the user implemented stopStreaming()

Throws:

ConverterStreamException - in case of error stopping

startStreaming

protected abstract void startStreaming()
                                throws ConverterStreamException

Start streaming data from the input to the output stream in a dedicated thread.

Throws:

ConverterStreamException - in case of error starting

stopStreaming

protected abstract void stopStreaming()
                               throws ConverterStreamException

Stops getting data from the input stream

Throws:

ConverterStreamException - in case of error stopping