kieker.analysis.plugin.reader.jmx
Class JMXReader

java.lang.Object
  kieker.analysis.plugin.AbstractPlugin
      kieker.analysis.plugin.reader.AbstractReaderPlugin
          kieker.analysis.plugin.reader.jmx.JMXReader

All Implemented Interfaces:

IPlugin, IReaderPlugin

public final class JMXReader
extends AbstractReaderPlugin

Author:

Jan Waller

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin

IPlugin.PluginInputPortReference

Field Summary

static String	CONFIG_PROPERTY_NAME_DOMAIN
static String	CONFIG_PROPERTY_NAME_LOGNAME
static String	CONFIG_PROPERTY_NAME_PORT
static String	CONFIG_PROPERTY_NAME_SERVER
static String	CONFIG_PROPERTY_NAME_SERVICEURL
static String	CONFIG_PROPERTY_NAME_SILENT
static String	OUTPUT_PORT_NAME_RECORDS

Fields inherited from class kieker.analysis.plugin.AbstractPlugin

CONFIG_NAME

Constructor Summary

JMXReader(Configuration configuation)

Method Summary

Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
boolean	read() Starts the reader.
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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OUTPUT_PORT_NAME_RECORDS

public static final String OUTPUT_PORT_NAME_RECORDS

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_SERVER

public static final String CONFIG_PROPERTY_NAME_SERVER

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_PORT

public static final String CONFIG_PROPERTY_NAME_PORT

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_SERVICEURL

public static final String CONFIG_PROPERTY_NAME_SERVICEURL

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_DOMAIN

public static final String CONFIG_PROPERTY_NAME_DOMAIN

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_LOGNAME

public static final String CONFIG_PROPERTY_NAME_LOGNAME

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_SILENT

public static final String CONFIG_PROPERTY_NAME_SILENT

See Also:

Constant Field Values

Constructor Detail

JMXReader

public JMXReader(Configuration configuation)
          throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Detail

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.

read

public final boolean read()

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, the IReaderPlugin.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()

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.