kieker.analysis.reader
Interface IMonitoringReader

All Known Implementing Classes:

AbstractMonitoringReader, FSReader, FSReaderRealtime, JMSReader, JMXReader, PipeReader

public interface IMonitoringReader

TODO: refactor analysis readers similar to monitoring writers! See ticket http://samoa.informatik.uni-kiel.de:8000/kieker/ticket/161

Author:

Andre van Hoorn

Method Summary

void	addRecordReceiver(IMonitoringRecordReceiver receiver) Adds the given record receiver.
boolean	init(String initString) Initialize instance from passed initialization string which is typically a list of separated parameter/values pairs.
boolean	read() Starts the reader.
void	terminate() Initiates a termination of the reader.

Method Detail

init

boolean init(String initString)

Initialize instance from passed initialization string which is typically a list of separated parameter/values pairs. The implementing class AbstractMonitoringReader includes convenient methods to extract configuration values from an initString.

Parameters:

initString - the initialization string

Returns:

true if the initialization was successful; false if an error occurred

addRecordReceiver

void addRecordReceiver(IMonitoringRecordReceiver receiver)

Adds the given record receiver. This method is only used by the framework and should not be called manually to register a receiver. Use an AnalysisController instead.

Parameters:

receiver - the receiver

read

boolean read()

Starts the reader. This method is intended to be a blocking operation, i.e., it is assumed that reading has finished before this method returns. The method should indicate an error by the return value false. In asynchronous scenarios, the terminate() method can be used to initiate the termination of this method.

Returns:

true if reading was successful; false if an error occurred

terminate

void terminate()

Initiates a termination of the reader. This method is only used by the framework and should not be called manually to register a receiver. Use the method AnalysisController.terminate() instead. After receiving this notification, the reader should terminate its read() method.