Package kieker.analysis.plugin.reader.jmx

Class JmxReader

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

kieker.analysis.plugin.AbstractPlugin

kieker.analysis.plugin.reader.AbstractReaderPlugin

kieker.analysis.plugin.reader.jmx.JmxReader

All Implemented Interfaces:

IAnalysisComponent, IPlugin, IReaderPlugin

@Deprecated
public final class JmxReader
extends AbstractReaderPlugin

Deprecated.

since 1.15.1 old plugin api

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

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PROPERTY_NAME_DOMAIN	Deprecated. The name of the configuration determining the JMX domain.
static final String	CONFIG_PROPERTY_NAME_LOGNAME	Deprecated. The name of the configuration determining the logname used by the reader.
static final String	CONFIG_PROPERTY_NAME_PORT	Deprecated. The name of the configuration determining the JMX port.
static final String	CONFIG_PROPERTY_NAME_SERVER	Deprecated. The name of the configuration determining the JMX server.
static final String	CONFIG_PROPERTY_NAME_SERVICEURL	Deprecated. The name of the configuration determining the optional service URL.
static final String	CONFIG_PROPERTY_NAME_SILENT	Deprecated. The name of the configuration determining whether the reader silently reconnects on any errors.
static final 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
JmxReader(Configuration configuration, IProjectContext projectContext)	Deprecated. Creates a new instance of this class using the given parameters.

Method Summary

Modifier and Type	Method	Description
Configuration	getCurrentConfiguration()	Deprecated. This method should deliver a Configuration object containing the current configuration of this instance.
protected org.slf4j.Logger	getLogger()	Deprecated.
final 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.AbstractReaderPlugin

init

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 kieker.analysis.analysisComponent.AbstractAnalysisComponent

getName

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 String OUTPUT_PORT_NAME_RECORDS

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

The name of the configuration determining whether the reader silently reconnects on any errors.

See Also:

• Constant Field Values

Constructor Details

JmxReader

public JmxReader(Configuration configuration,
 IProjectContext projectContext)
          throws IllegalArgumentException

Deprecated.

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 Details

terminate

public void terminate(boolean error)

Deprecated.

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()

Deprecated.

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()

Deprecated.

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.

getLogger

protected org.slf4j.Logger getLogger()

Deprecated.