kieker.analysis.plugin.reader.filesystem
Class FSReader

java.lang.Object
  kieker.analysis.plugin.AbstractPlugin
      kieker.analysis.plugin.reader.AbstractReaderPlugin
          kieker.analysis.plugin.reader.filesystem.FSReader

All Implemented Interfaces:

IPlugin, IReaderPlugin

public class FSReader
extends AbstractReaderPlugin

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

Author:

Andre van Hoorn, Jan Waller

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin

IPlugin.PluginInputPortReference

Field Summary

static String	CONFIG_PROPERTY_NAME_IGNORE_UNKNOWN_RECORD_TYPES
static String	CONFIG_PROPERTY_NAME_INPUTDIRS
static String	CONFIG_PROPERTY_VALUE_IGNORE_UNKNOWN_RECORD_TYPES_DEFAULT
static IMonitoringRecord	EOF
static String	OUTPUT_PORT_NAME_RECORDS

Fields inherited from class kieker.analysis.plugin.AbstractPlugin

CONFIG_NAME

Constructor Summary

FSReader(Configuration configuration)

Method Summary

Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
boolean	newMonitoringRecord(IMonitoringRecord record) This method is called for each new record by each ReaderThread.
boolean	read() Starts the reader.
void	terminate(boolean error) Initiates a termination of the reader.

Methods inherited from class kieker.analysis.plugin.AbstractPlugin

areAllRepositoryPortsConnected, connect, connect, getAllInputPortNames, getAllOutputPortNames, getConnectedPlugins, getCurrentRepositories, getName, getPluginDescription, getPluginName, isConnectionAllowed

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_PORT_NAME_RECORDS

public static final String OUTPUT_PORT_NAME_RECORDS

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_INPUTDIRS

public static final String CONFIG_PROPERTY_NAME_INPUTDIRS

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_IGNORE_UNKNOWN_RECORD_TYPES

public static final String CONFIG_PROPERTY_NAME_IGNORE_UNKNOWN_RECORD_TYPES

See Also:

Constant Field Values

CONFIG_PROPERTY_VALUE_IGNORE_UNKNOWN_RECORD_TYPES_DEFAULT

public static final String CONFIG_PROPERTY_VALUE_IGNORE_UNKNOWN_RECORD_TYPES_DEFAULT

EOF

public static final IMonitoringRecord EOF

Constructor Detail

FSReader

public FSReader(Configuration configuration)

Method Detail

terminate

public void terminate(boolean error)

Description copied from interface: IReaderPlugin

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(boolean) instead. After receiving this notification, the reader should terminate its IReaderPlugin.read() method.

Specified by:

terminate in interface IReaderPlugin

read

public boolean read()

Description copied from interface: IReaderPlugin

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

Specified by:

read in interface IReaderPlugin

Returns:

true if reading was successful; false if an error occurred

newMonitoringRecord

public boolean newMonitoringRecord(IMonitoringRecord record)

This method is called for each new record by each ReaderThread.

getCurrentConfiguration

public Configuration getCurrentConfiguration()

Description copied from interface: IPlugin

This method should deliver a Configuration object containing the current configuration of this instance. In other words: The constructor should be able to use the given object to initialize a new instance of this class with the same intern properties.

Specified by:

getCurrentConfiguration in interface IPlugin

Returns:

A completely filled configuration object.