Package kieker.analysis.plugin.filter.forward

Class TeeFilter

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

kieker.analysis.plugin.AbstractPlugin

kieker.analysis.plugin.filter.AbstractFilterPlugin

kieker.analysis.plugin.filter.forward.TeeFilter

All Implemented Interfaces:

IAnalysisComponent, IFilterPlugin, IPlugin

@Deprecated
public final class TeeFilter
extends AbstractFilterPlugin

Deprecated.

since 1.15 ported to teetime kieker.analysis.stage.forward.TeeFilter

This filter has exactly one input port and one output port. A simple message is printed to a configurable stream and all objects are forwarded to the output port.

Since:

1.2

Author:

Matthias Rohr, 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 final String	CONFIG_PROPERTY_NAME_APPEND	Deprecated. The name of the property determining whether or not the stream appends or overwrites to files.
static final String	CONFIG_PROPERTY_NAME_ENCODING	Deprecated. The name of the property determining the used encoding.
static final String	CONFIG_PROPERTY_NAME_STREAM	Deprecated. The name of the property determining the stream in which the incoming data will be printed.
static final String	CONFIG_PROPERTY_VALUE_DEFAULT_ENCODING	Deprecated. The default value of the encoding property which determines that the filter uses utf-8.
static final String	CONFIG_PROPERTY_VALUE_STREAM_APPEND	Deprecated. The default value of the stream property which determines that the filter appends or overwrites a file.
static final String	CONFIG_PROPERTY_VALUE_STREAM_NULL	Deprecated. The value of the stream property which determines that the filter doesn't print anything.
static final String	CONFIG_PROPERTY_VALUE_STREAM_STDERR	Deprecated. The value of the stream property which determines that the filter uses the standard error output.
static final String	CONFIG_PROPERTY_VALUE_STREAM_STDLOG	Deprecated. The value of the stream property which determines that the filter uses the standard log.
static final String	CONFIG_PROPERTY_VALUE_STREAM_STDOUT	Deprecated. The value of the stream property which determines that the filter uses the standard output.
static final String	INPUT_PORT_NAME_EVENTS	Deprecated. The name of the input port for incoming events.
static final String	OUTPUT_PORT_NAME_RELAYED_EVENTS	Deprecated. The name of the output port delivering the incoming events.

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME, configuration, logger, projectContext, recordsTimeUnitFromProjectContext

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Configuration	getCurrentConfiguration()	Deprecated. This method should deliver a Configuration object containing the current configuration of this instance.
final void	inputEvent(Object object)	Deprecated. This method is the input port of the filter receiving incoming objects.
final void	terminate(boolean error)	Deprecated. Initiates a termination of the plugin.

Methods inherited from class kieker.analysis.plugin.filter.AbstractFilterPlugin

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

INPUT_PORT_NAME_EVENTS

public static final String INPUT_PORT_NAME_EVENTS

Deprecated.

The name of the input port for incoming events.

See Also:

• Constant Field Values

OUTPUT_PORT_NAME_RELAYED_EVENTS

public static final String OUTPUT_PORT_NAME_RELAYED_EVENTS

Deprecated.

The name of the output port delivering the incoming events.

See Also:

• Constant Field Values

CONFIG_PROPERTY_NAME_STREAM

public static final String CONFIG_PROPERTY_NAME_STREAM

Deprecated.

The name of the property determining the stream in which the incoming data will be printed.

See Also:

• Constant Field Values

CONFIG_PROPERTY_NAME_ENCODING

public static final String CONFIG_PROPERTY_NAME_ENCODING

Deprecated.

The name of the property determining the used encoding.

See Also:

• Constant Field Values

CONFIG_PROPERTY_NAME_APPEND

public static final String CONFIG_PROPERTY_NAME_APPEND

Deprecated.

The name of the property determining whether or not the stream appends or overwrites to files.

See Also:

• Constant Field Values

CONFIG_PROPERTY_VALUE_STREAM_STDOUT

public static final String CONFIG_PROPERTY_VALUE_STREAM_STDOUT

Deprecated.

The value of the stream property which determines that the filter uses the standard output.

See Also:

• Constant Field Values

CONFIG_PROPERTY_VALUE_STREAM_STDERR

public static final String CONFIG_PROPERTY_VALUE_STREAM_STDERR

Deprecated.

The value of the stream property which determines that the filter uses the standard error output.

See Also:

• Constant Field Values

CONFIG_PROPERTY_VALUE_STREAM_STDLOG

public static final String CONFIG_PROPERTY_VALUE_STREAM_STDLOG

Deprecated.

The value of the stream property which determines that the filter uses the standard log.

See Also:

• Constant Field Values

CONFIG_PROPERTY_VALUE_STREAM_NULL

public static final String CONFIG_PROPERTY_VALUE_STREAM_NULL

Deprecated.

The value of the stream property which determines that the filter doesn't print anything.

See Also:

• Constant Field Values

CONFIG_PROPERTY_VALUE_DEFAULT_ENCODING

public static final String CONFIG_PROPERTY_VALUE_DEFAULT_ENCODING

Deprecated.

The default value of the encoding property which determines that the filter uses utf-8.

See Also:

• Constant Field Values

CONFIG_PROPERTY_VALUE_STREAM_APPEND

public static final String CONFIG_PROPERTY_VALUE_STREAM_APPEND

Deprecated.

The default value of the stream property which determines that the filter appends or overwrites a file.

See Also:

• Constant Field Values

Constructor Details

TeeFilter

public TeeFilter(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 final void terminate(boolean error)

Deprecated.

Description copied from class: AbstractFilterPlugin

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

Overrides:

terminate in class AbstractFilterPlugin

Parameters:

error - Determines whether the plugin is terminated due to an error or not.

getCurrentConfiguration

public final 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.

inputEvent

public final void inputEvent(Object object)

Deprecated.

This method is the input port of the filter receiving incoming objects. Every object will be printed into a stream (based on the configuration) before the filter sends it to the output port.

Parameters:

object - The new object.