Kieker 1.8

kieker.analysis.plugin.reader.jmx
Class JMXReader

java.lang.Object
  extended by kieker.analysis.analysisComponent.AbstractAnalysisComponent
      extended by kieker.analysis.plugin.AbstractPlugin
          extended by kieker.analysis.plugin.reader.AbstractReaderPlugin
              extended by kieker.analysis.plugin.reader.jmx.JMXReader
All Implemented Interfaces:
IAnalysisComponent, IPlugin, IReaderPlugin

public final class JMXReader
extends AbstractReaderPlugin

This is a reader which reads the records from a JMX queue.

Since:
1.4
Author:
Jan Waller

Nested Class Summary
 
Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin
IPlugin.PluginInputPortReference, IPlugin.STATE
 
Field Summary
static String CONFIG_PROPERTY_NAME_DOMAIN
          The name of the configuration determining the JMX domain.
static String CONFIG_PROPERTY_NAME_LOGNAME
          The name of the configuration determining the logname used by the reader.
static String CONFIG_PROPERTY_NAME_PORT
          The name of the configuration determining the JMX port.
static String CONFIG_PROPERTY_NAME_SERVER
          The name of the configuration determining the JMX server.
static String CONFIG_PROPERTY_NAME_SERVICEURL
          The name of the configuration determining the optional service URL.
static String CONFIG_PROPERTY_NAME_SILENT
          The name of the configuration determining whether the reader silently reconnects on any errors.
static String OUTPUT_PORT_NAME_RECORDS
          The name of the output port delivering the received records.
 
Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
CONFIG_NAME
 
Constructor Summary
JMXReader(Configuration configuration, IProjectContext projectContext)
          Creates a new instance of this class using the given parameters.
 
Method Summary
 Configuration getCurrentConfiguration()
          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.
 boolean read()
          Starts the reader.
 void terminate(boolean error)
          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, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getIncomingPlugins, getPluginDescription, getPluginName, getState, isConnectionAllowed, shutdown, start
 
Methods inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
getName
 
Methods inherited from class java.lang.Object
equals, 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 Detail

OUTPUT_PORT_NAME_RECORDS

public static final String OUTPUT_PORT_NAME_RECORDS
The name of the output port delivering the received records.

See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_SERVER

public static final String CONFIG_PROPERTY_NAME_SERVER
The name of the configuration determining the JMX server.

See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_PORT

public static final String CONFIG_PROPERTY_NAME_PORT
The name of the configuration determining the JMX port.

See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_SERVICEURL

public static final String CONFIG_PROPERTY_NAME_SERVICEURL
The name of the configuration determining the optional service URL.

See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_DOMAIN

public static final String CONFIG_PROPERTY_NAME_DOMAIN
The name of the configuration determining the JMX domain.

See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_LOGNAME

public static final String CONFIG_PROPERTY_NAME_LOGNAME
The name of the configuration determining the logname used by the reader.

See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_SILENT

public static final String CONFIG_PROPERTY_NAME_SILENT
The name of the configuration determining whether the reader silently reconnects on any errors.

See Also:
Constant Field Values
Constructor Detail

JMXReader

public JMXReader(Configuration configuration,
                 IProjectContext projectContext)
          throws IllegalArgumentException
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.
Throws:
IllegalArgumentException - If the arguments are invalid.
Method Detail

terminate

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

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

read

public final boolean read()
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.

Returns:
true if reading was successful; false if an error occurred

getCurrentConfiguration

public Configuration getCurrentConfiguration()
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.

Kieker 1.8

Copyright 2013 Kieker Project, http://kieker-monitoring.net