kieker.analysis.reader
Interface IMonitoringReader

All Known Implementing Classes:

AbstractMonitoringReader, DummyLogReader, FSReader, FSReaderRealtime, JMSReader, PipeReader, RabbitMqReader

public interface IMonitoringReader

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.

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 AbstractMonitoringLogWriter 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 AnalysisInstance 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.

Returns:

true if reading was successful; false if an error occurred