kieker.analysis.plugin.reader

Class AbstractReaderPlugin

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

kieker.analysis.plugin.AbstractPlugin

kieker.analysis.plugin.reader.AbstractReaderPlugin

All Implemented Interfaces:

IAnalysisComponent, IPlugin, IReaderPlugin

Direct Known Subclasses:

AbstractRawDataReader, AbstractStringRegistryReaderPlugin, AsciiLogReader, BinaryLogReader, DbReader, DualSocketTcpReader, FSReader, JmsReader, JmxReader, ListReader, PipeReader, RawDataReaderPlugin, SingleSocketTcpReader, TCPReader, TimeReader

public abstract class AbstractReaderPlugin
extends AbstractPlugin
implements IReaderPlugin

This class should be used as a base for every reader used within Kieker. For filter plugins, the class AbstractFilterPlugin should be used instead.

Since:

1.5

Author:

Nils Christian Ehmke

Nested Class Summary

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

IPlugin.PluginInputPortReference, IPlugin.STATE

Field Summary

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME, configuration, log, LOG, projectContext, recordsTimeUnitFromProjectContext

Constructor Summary

Constructors

Constructor and Description
AbstractReaderPlugin(Configuration configuration, IProjectContext projectContext) Each Plugin requires a constructor with a Configuration object and a IProjectContext.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	init() Initiates the start of a component.

Methods inherited from class kieker.analysis.plugin.AbstractPlugin

areAllRepositoryPortsConnected, connect, connect, deliver, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getDefaultConfiguration, getIncomingPlugins, getPluginDescription, getPluginName, getRepository, getState, isConnectionAllowed, notifyNewIncomingConnection, notifyNewOutgoingConnection, shutdown, start

Methods inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

getCurrentConfiguration, getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface kieker.analysis.plugin.reader.IReaderPlugin

read

Methods inherited from interface kieker.analysis.plugin.IPlugin

connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentConfiguration, getCurrentRepositories, getName, getPluginDescription, getPluginName, getState, terminate

Constructor Detail

AbstractReaderPlugin

public AbstractReaderPlugin(Configuration configuration,
                    IProjectContext projectContext)

Each Plugin requires a constructor with a Configuration object and a IProjectContext.

Parameters:

configuration - The configuration for this component.

projectContext - The project context for this component. The component will be registered.

Method Detail

init

public boolean init()

Initiates the start of a component. This method is called once when a AnalysisController's run() method is called. This implementation must not be blocking! Asynchronous consumers would spawn (an) asynchronous thread(s) in this method.

Specified by:

init in interface IPlugin

Returns:

true on success; false otherwise.