kieker.analysis.reader
Interface IMonitoringLogReader

All Known Implementing Classes:

AbstractMonitoringLogReader, DummyLogReader, FSReader, FSReaderRealtime, JMSReader, RabbitMqReader

public interface IMonitoringLogReader

Author:

Andre van Hoorn

Method Summary

void	addRecordReceiver(IMonitoringRecordReceiver receiver) Adds the given record receiver.
void	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

void init(String initString)
          throws IllegalArgumentException

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. TODO: make signature of this init method and the writer's init method (returns boolean and doesn't throw exception) consistent.

Parameters:

initString - the initialization string

Throws:

IllegalArgumentException - if an error occured

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()
             throws MonitoringLogReaderException

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.

Returns:

true iff reading was successful

Throws:

LogReaderExecutionException - if an error occured

MonitoringLogReaderException