kieker.analysis.plugin.reader.jms
Class JMSReader
java.lang.Object
kieker.analysis.plugin.AbstractPlugin
kieker.analysis.plugin.reader.AbstractReaderPlugin
kieker.analysis.plugin.reader.jms.JMSReader
- All Implemented Interfaces:
- IPlugin, IReaderPlugin
public final class JMSReader
- extends AbstractReaderPlugin
Reads monitoring records from a (remote or local) JMS queue.
- Author:
- Andre van Hoorn, Matthias Rohr
Constructor Summary |
JMSReader(Configuration configuration)
Creates a new instance of this class using the given parameters to configure the reader. |
Method Summary |
Configuration |
getCurrentConfiguration()
This method should deliver a Configuration object containing the current configuration of this instance. |
boolean |
read()
A call to this method is a blocking call. |
void |
terminate(boolean error)
Initiates a termination of the reader. |
Methods inherited from class kieker.analysis.plugin.AbstractPlugin |
areAllRepositoryPortsConnected, connect, connect, getAllInputPortNames, getAllOutputPortNames, getConnectedPlugins, getCurrentRepositories, getName, getPluginDescription, getPluginName, isConnectionAllowed |
OUTPUT_PORT_NAME_RECORDS
public static final String OUTPUT_PORT_NAME_RECORDS
- See Also:
- Constant Field Values
CONFIG_PROPERTY_NAME_PROVIDERURL
public static final String CONFIG_PROPERTY_NAME_PROVIDERURL
- See Also:
- Constant Field Values
CONFIG_PROPERTY_NAME_DESTINATION
public static final String CONFIG_PROPERTY_NAME_DESTINATION
- See Also:
- Constant Field Values
CONFIG_PROPERTY_NAME_FACTORYLOOKUP
public static final String CONFIG_PROPERTY_NAME_FACTORYLOOKUP
- See Also:
- Constant Field Values
JMSReader
public JMSReader(Configuration configuration)
throws IllegalArgumentException
- Creates a new instance of this class using the given parameters to configure the reader.
- Parameters:
configuration
- The configuration used to initialize the whole reader. Keep in mind that the configuration should contain the following properties:
- Throws:
IllegalArgumentException
- If one of the properties is empty.
read
public boolean read()
- A call to this method is a blocking call.
- Returns:
- true if reading was successful; false if an error occurred
terminate
public void terminate(boolean error)
- Description copied from interface:
IReaderPlugin
- Initiates a termination of the reader. This method is only used by the
framework and should not be called manually to register a receiver. Use
the method
AnalysisController.terminate(boolean)
instead.
After receiving this notification,
the reader should terminate its IReaderPlugin.read()
method.
getCurrentConfiguration
public Configuration getCurrentConfiguration()
- Description copied from interface:
IPlugin
- 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.
- Returns:
- A completely filled configuration object.
Copyright 2012 the Kieker Project, http://kieker-monitoring.net>