Class AmqpReader
java.lang.Object
- All Implemented Interfaces:
IAnalysisComponent
,IPlugin
,IReaderPlugin
@Deprecated public final class AmqpReader extends AbstractStringRegistryReaderPlugin
Deprecated.
since 1.15.1 old plugin api
Reader plugin that reads monitoring records from an AMQP queue.
- Since:
- 1.12
- 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_CACHE_DURATION
Deprecated.The name of the configuration property for the cache duration (in seconds) for string registries.static java.lang.String
CONFIG_PROPERTY_HEARTBEAT
Deprecated.The name of the configuration property for the heartbeat timeout.static java.lang.String
CONFIG_PROPERTY_QUEUENAME
Deprecated.The name of the configuration property for the AMQP queue name.static java.lang.String
CONFIG_PROPERTY_URI
Deprecated.The name of the configuration property for the server URI.static java.lang.String
OUTPUT_PORT_NAME_RECORDS
Deprecated.The name of the output port delivering the received records.Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
CONFIG_NAME, configuration, logger, projectContext, recordsTimeUnitFromProjectContext
-
Constructor Summary
Constructors Constructor Description AmqpReader(Configuration configuration, IProjectContext projectContext)
Deprecated.Creates a new AMQP reader with the given configuration in the given context. -
Method Summary
Modifier and Type Method Description protected void
deliverRecord(IMonitoringRecord monitoringRecord)
Deprecated.Delivers the given record to the appropriate output port(s).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.reader.AbstractStringRegistryReaderPlugin
createCache, ensureThreadsStarted, handleRegistryRecord, handleRegularRecord
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 delivering the received records.- See Also:
- Constant Field Values
-
CONFIG_PROPERTY_URI
public static final java.lang.String CONFIG_PROPERTY_URIDeprecated.The name of the configuration property for the server URI.- See Also:
- Constant Field Values
-
CONFIG_PROPERTY_QUEUENAME
public static final java.lang.String CONFIG_PROPERTY_QUEUENAMEDeprecated.The name of the configuration property for the AMQP queue name.- See Also:
- Constant Field Values
-
CONFIG_PROPERTY_HEARTBEAT
public static final java.lang.String CONFIG_PROPERTY_HEARTBEATDeprecated.The name of the configuration property for the heartbeat timeout.- See Also:
- Constant Field Values
-
CONFIG_PROPERTY_CACHE_DURATION
public static final java.lang.String CONFIG_PROPERTY_CACHE_DURATIONDeprecated.The name of the configuration property for the cache duration (in seconds) for string registries.- See Also:
- Constant Field Values
-
-
Constructor Details
-
AmqpReader
Deprecated.Creates a new AMQP reader with the given configuration in the given context.- Parameters:
configuration
- The configuration for this readerprojectContext
- The project context for this component
-
-
Method Details
-
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 classAbstractStringRegistryReaderPlugin
- Returns:
- true on success; false otherwise.
-
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.
-
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.- 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.- Parameters:
error
- Determines whether the plugin is terminated due to an error or not.
-
deliverRecord
Deprecated.Description copied from class:AbstractStringRegistryReaderPlugin
Delivers the given record to the appropriate output port(s).- Specified by:
deliverRecord
in classAbstractStringRegistryReaderPlugin
- Parameters:
monitoringRecord
- The monitoring record to deliver
-