Kieker 1.8

kieker.analysis.plugin.reader
Class AbstractReaderPlugin

java.lang.Object
  extended by kieker.analysis.analysisComponent.AbstractAnalysisComponent
      extended by kieker.analysis.plugin.AbstractPlugin
          extended by kieker.analysis.plugin.reader.AbstractReaderPlugin
All Implemented Interfaces:
IAnalysisComponent, IPlugin, IReaderPlugin
Direct Known Subclasses:
DbReader, FSReader, JMSReader, JMXReader, ListReader, PipeReader, 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
 
Constructor Summary
AbstractReaderPlugin(Configuration configuration, IProjectContext projectContext)
          Each Plugin requires a constructor with a Configuration object and a IProjectContext.
 
Method Summary
 boolean init()
          Initiates the start of a component.
 
Methods inherited from class kieker.analysis.plugin.AbstractPlugin
areAllRepositoryPortsConnected, connect, connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getIncomingPlugins, getPluginDescription, getPluginName, getState, isConnectionAllowed, shutdown, start
 
Methods inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
getCurrentConfiguration, getName
 
Methods inherited from class java.lang.Object
equals, 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.

Kieker 1.8

Copyright 2013 Kieker Project, http://kieker-monitoring.net