java.lang.Object

kieker.analysis.plugin.reader.filesystem.BinaryLogReader

All Implemented Interfaces:: IAnalysisComponent, IPlugin, IReaderPlugin, IMonitoringRecordReceiver

@Deprecated
public class BinaryLogReader
extends AbstractReaderPlugin
implements IMonitoringRecordReceiver

Deprecated.

1.15 replaced by teetime log reading facilities

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

Since:: 0.95a
Author:: Andre van Hoorn, Jan Waller

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`CONFIG_PROPERTY_NAME_IGNORE_UNKNOWN_RECORD_TYPES`	Deprecated. The name of the configuration determining whether the reader ignores unknown record types or not.
`static java.lang.String`	`CONFIG_PROPERTY_NAME_INPUTDIRS`	Deprecated. The name of the configuration determining the input directories for this plugin.
`static java.lang.String`	`CONFIG_SHOULD_DECOMPRESS`	Deprecated. The name of the configuration determining whether to decompress the Kieker log files.
`static java.lang.String`	`OUTPUT_PORT_NAME_RECORDS`	Deprecated. The name of the output port delivering the record read by this plugin.

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME, configuration, logger, projectContext, recordsTimeUnitFromProjectContext

Constructor Summary

Constructors
Constructor	Description
`BinaryLogReader(Configuration configuration, IProjectContext projectContext)`	Deprecated. Creates a new instance of this class using the given parameters.

Method Summary

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

Methods inherited from class kieker.analysis.plugin.reader.AbstractReaderPlugin

init

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

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.IPlugin

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

Field Details
- OUTPUT_PORT_NAME_RECORDS
  
  public static final java.lang.String OUTPUT_PORT_NAME_RECORDS
  
  Deprecated.
  
  The name of the output port delivering the record read by this plugin.
  
  See Also:
  
  Constant Field Values
- CONFIG_PROPERTY_NAME_INPUTDIRS
  
  public static final java.lang.String CONFIG_PROPERTY_NAME_INPUTDIRS
  
  Deprecated.
  
  The name of the configuration determining the input directories for this plugin.
  
  See Also:
  
  Constant Field Values
- CONFIG_PROPERTY_NAME_IGNORE_UNKNOWN_RECORD_TYPES
  
  public static final java.lang.String CONFIG_PROPERTY_NAME_IGNORE_UNKNOWN_RECORD_TYPES
  
  Deprecated.
  
  The name of the configuration determining whether the reader ignores unknown record types or not.
  
  See Also:
  
  Constant Field Values
- CONFIG_SHOULD_DECOMPRESS
  
  public static final java.lang.String CONFIG_SHOULD_DECOMPRESS
  
  Deprecated.
  
  The name of the configuration determining whether to decompress the Kieker log files.
  
  See Also:
  
  Constant Field Values
Constructor Details
- BinaryLogReader
  
  public BinaryLogReader(Configuration configuration, IProjectContext projectContext)
  
  Deprecated.
  
  Creates a new instance of this class using the given parameters.
  
  Parameters:
  
  configuration - The configuration for this component.
  
  projectContext - The project context for this component.
Method Details
- terminate
  
  public void terminate(boolean error)
  
  Deprecated.
  
  Initiates a termination of the plugin. This method is only used by the framework and should not be called manually. Use the method AnalysisController.terminate(boolean) instead. After receiving this notification, the plugin should terminate any running methods, e.g., read for readers.
  
  Specified by:
  
  terminate in interface IPlugin
  
  Parameters:
  
  error - Determines whether the plugin is terminated due to an error or not.
- read
  
  public boolean read()
  
  Deprecated.
  
  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 IPlugin.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)
  
  Deprecated.
  
  This method is called for each new record by each ReaderThread.
  
  Specified by:
  
  newMonitoringRecord in interface IMonitoringRecordReceiver
  
  Parameters:
  
  record - The record to be processed.
  
  Returns:
  
  true if and only if the record has been handled correctly.
- getCurrentConfiguration
  
  public Configuration getCurrentConfiguration()
  
  Deprecated.
  
  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 IAnalysisComponent
  
  Specified by:
  
  getCurrentConfiguration in interface IPlugin
  
  Specified by:
  
  getCurrentConfiguration in class AbstractAnalysisComponent
  
  Returns:
  
  A completely filled configuration object.
- newEndOfFileRecord
  
  public void newEndOfFileRecord()
  
  Deprecated.
  
  Specified by:
  
  newEndOfFileRecord in interface IMonitoringRecordReceiver

Class BinaryLogReader

Nested Class Summary

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