kieker.analysis.reader.filesystem
Class FSReader

java.lang.Object
  kieker.analysis.reader.AbstractMonitoringReader
      kieker.analysis.reader.filesystem.FSReader

All Implemented Interfaces:

IMonitoringReader

public class FSReader
extends AbstractMonitoringReader

Filesystem reader which reads from multiple directories simultaneously ordered by the logging timestamp.

Author:

Andre van Hoorn

Field Summary

static String

PROP_NAME_INPUTDIRS

Constructor Summary

FSReader()
Default constructor used for construction by reflection.

FSReader(String[] inputDirs)

FSReader(String[] inputDirs, Collection<Class<? extends IMonitoringRecord>> readOnlyRecordsOfType)

Method Summary

boolean	init(String initString) Initializes the reader based on the given key/value pair initString.
boolean	read() Starts the reader.
void	terminate() Initiates a termination of the reader.

Methods inherited from class kieker.analysis.reader.AbstractMonitoringReader

addRecordReceiver

Methods inherited from class java.lang.Object

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

Field Detail

PROP_NAME_INPUTDIRS

public static final String PROP_NAME_INPUTDIRS

See Also:

Constant Field Values

Constructor Detail

FSReader

public FSReader(String[] inputDirs)

FSReader

public FSReader(String[] inputDirs,
                Collection<Class<? extends IMonitoringRecord>> readOnlyRecordsOfType)

Parameters:

inputDirs -

readOnlyRecordsOfType - select only records of this type; null selects all

FSReader

public FSReader()

Default constructor used for construction by reflection.

Method Detail

read

public boolean read()

Description copied from interface: IMonitoringReader

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 IMonitoringReader.terminate() method can be used to initiate the termination of this method.

Returns:

true if reading was successful; false if an error occurred

init

public boolean init(String initString)

Initializes the reader based on the given key/value pair initString. For the key "inputDirs", the method expects a list of input directories separated by semicolon.

Example: inputDirs=dir0;...;dir1

Parameters:

initString - the initialization string

Returns:

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

terminate

public void terminate()

Description copied from interface: IMonitoringReader

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 IMonitoringReader.read() method.