Class RawDataReaderPlugin
java.lang.Object
kieker.analysis.analysisComponent.AbstractAnalysisComponent
kieker.analysis.plugin.AbstractPlugin
kieker.analysis.plugin.reader.AbstractReaderPlugin
kieker.analysis.plugin.reader.newio.RawDataReaderPlugin
- All Implemented Interfaces:
IAnalysisComponent
,IPlugin
,IReaderPlugin
,IRawDataProcessor
@Deprecated public class RawDataReaderPlugin extends AbstractReaderPlugin implements IRawDataProcessor
Deprecated.
since 1.15.1 old plugin api
Generic reader plugin for the new raw data I/O infrastructure.
- Since:
- 1.13
- Author:
- Holger Knoche
-
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_DESERIALIZER
Deprecated.The name of the configuration property for the deserializer class name.static java.lang.String
CONFIG_PROPERTY_READER
Deprecated.The name of the configuration property for the reader class name.static java.lang.String
OUTPUT_PORT_NAME_RECORDS
Deprecated.The name of the output port for the decoded records.Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
CONFIG_NAME, configuration, logger, projectContext, recordsTimeUnitFromProjectContext
-
Constructor Summary
Constructors Constructor Description RawDataReaderPlugin(Configuration configuration, IProjectContext projectContext)
Deprecated. -
Method Summary
Modifier and Type Method Description void
decodeAndDeliverRecords(byte[] rawData)
Deprecated.Decodes the given raw data and delivers the decoded records.void
decodeAndDeliverRecords(java.nio.ByteBuffer rawData, int dataSize)
Deprecated.Decodes the given raw data and delivers the decoded records.Configuration
getCurrentConfiguration()
Deprecated.This method should deliver aConfiguration
object containing the current configuration of this instance.boolean
init()
Deprecated.Initiates the start of a component.boolean
read()
Deprecated.Starts the reader.void
terminate(boolean error)
Deprecated.Initiates a termination of the plugin.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 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_RECORDSDeprecated.The name of the output port for the decoded records.- See Also:
- Constant Field Values
-
CONFIG_PROPERTY_DESERIALIZER
public static final java.lang.String CONFIG_PROPERTY_DESERIALIZERDeprecated.The name of the configuration property for the deserializer class name.- See Also:
- Constant Field Values
-
CONFIG_PROPERTY_READER
public static final java.lang.String CONFIG_PROPERTY_READERDeprecated.The name of the configuration property for the reader class name.- See Also:
- Constant Field Values
-
-
Constructor Details
-
RawDataReaderPlugin
Deprecated.
-
-
Method Details
-
getCurrentConfiguration
Deprecated.Description copied from class:AbstractAnalysisComponent
This method should deliver aConfiguration
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 interfaceIAnalysisComponent
- Specified by:
getCurrentConfiguration
in interfaceIPlugin
- Specified by:
getCurrentConfiguration
in classAbstractAnalysisComponent
- Returns:
- A completely filled configuration object.
-
init
public boolean init()Deprecated.Description copied from class:AbstractReaderPlugin
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 interfaceIPlugin
- Overrides:
init
in classAbstractReaderPlugin
- Returns:
- true on success; false otherwise.
-
read
public boolean read()Deprecated.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, theIPlugin.terminate(boolean)
method can be used to initiate the termination of this method.- Specified by:
read
in interfaceIReaderPlugin
- Returns:
- true if reading was successful; false if an error occurred
-
terminate
public void terminate(boolean error)Deprecated.Description copied from interface:IPlugin
Initiates a termination of the plugin. This method is only used by the framework and should not be called manually. Use the methodAnalysisController.terminate(boolean)
instead. After receiving this notification, the plugin should terminate any running methods, e.g., read for readers. -
decodeAndDeliverRecords
public void decodeAndDeliverRecords(byte[] rawData)Deprecated.Description copied from interface:IRawDataProcessor
Decodes the given raw data and delivers the decoded records.- Specified by:
decodeAndDeliverRecords
in interfaceIRawDataProcessor
- Parameters:
rawData
- The raw data to decode
-
decodeAndDeliverRecords
public void decodeAndDeliverRecords(java.nio.ByteBuffer rawData, int dataSize)Deprecated.Description copied from interface:IRawDataProcessor
Decodes the given raw data and delivers the decoded records.- Specified by:
decodeAndDeliverRecords
in interfaceIRawDataProcessor
- Parameters:
rawData
- The raw data to decodedataSize
- The size of the contained data
-