org.rhq.plugins.jmx
Class JMXDiscoveryComponent

java.lang.Object
  org.rhq.plugins.jmx.JMXDiscoveryComponent

All Implemented Interfaces:

ManualAddFacet, ResourceDiscoveryComponent, ResourceUpgradeFacet

public class JMXDiscoveryComponent
extends Object
implements ResourceDiscoveryComponent, ManualAddFacet, ResourceUpgradeFacet

This component will discover JVM processes that appear to be long-running (i.e. "servers"). Specifically, it will discover java processes that:

• have enabled JMX Remoting (JSR-160) via com.sun.management.jmxremote* system properties on their command lines, or
• are Sun/Oracle-compatible java processes accessible via the com.sun.tools.attach API AND specify the org.rhq.resourceKey system property on their command lines (e.g. -Dorg.rhq.resourceKey=FOO); the attach API uses IPC under the covers, so for a process to be accessible, it must be running as the same user as the RHQ Agent; even if the Agent is running as root, processes running as other users cannot be accessed via the attach API

Some other java processes that do not meet these criteria can be manually added if they expose JMX remotely in another supported form (WebLogic, WebSphere, etc.).

Author:

Greg Hinkle, Ian Springer

Field Summary

static String	ADDITIONAL_CLASSPATH_ENTRIES
static String	COMMAND_LINE_CONFIG_PROPERTY
static String	CONNECTION_TYPE
static String	CONNECTOR_ADDRESS_CONFIG_PROPERTY
static String	INSTALL_URI
static String	PARENT_TYPE
static String	SYSPROP_RHQ_RESOURCE_KEY

Constructor Summary

JMXDiscoveryComponent()

Method Summary

protected DiscoveredResourceDetails	buildResourceDetails(ResourceDiscoveryContext context, ProcessInfo process, JMXServiceURL jmxServiceURL, Integer jmxRemotingPort)
DiscoveredResourceDetails	discoverResource(org.rhq.core.domain.configuration.Configuration pluginConfig, ResourceDiscoveryContext discoveryContext)
protected DiscoveredResourceDetails	discoverResourceDetails(ResourceDiscoveryContext context, ProcessInfo process)
Set<DiscoveredResourceDetails>	discoverResources(ResourceDiscoveryContext context)
List<URL>	getAdditionalClasspathUrls(ResourceDiscoveryContext<ResourceComponent<?>> context, DiscoveredResourceDetails details)
protected String	getJavaMainClassName(ProcessInfo process)
protected String	getJavaVersion(JMXConnector jmxConnector)
protected String	getJavaVersion(ProcessInfo process, JMXServiceURL jmxServiceURL)
protected Integer	getJmxRemotingPort(ProcessInfo process)
protected Set<String>	getProcessExcludes()
protected String	getSystemPropertyValue(ProcessInfo process, String systemPropertyName)
org.rhq.core.domain.resource.ResourceUpgradeReport	upgrade(ResourceUpgradeContext inventoriedResource)

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_LINE_CONFIG_PROPERTY

public static final String COMMAND_LINE_CONFIG_PROPERTY

See Also:

Constant Field Values

CONNECTOR_ADDRESS_CONFIG_PROPERTY

public static final String CONNECTOR_ADDRESS_CONFIG_PROPERTY

See Also:

Constant Field Values

INSTALL_URI

public static final String INSTALL_URI

See Also:

Constant Field Values

CONNECTION_TYPE

public static final String CONNECTION_TYPE

See Also:

Constant Field Values

PARENT_TYPE

public static final String PARENT_TYPE

See Also:

Constant Field Values

ADDITIONAL_CLASSPATH_ENTRIES

public static final String ADDITIONAL_CLASSPATH_ENTRIES

See Also:

Constant Field Values

SYSPROP_RHQ_RESOURCE_KEY

public static final String SYSPROP_RHQ_RESOURCE_KEY

See Also:

Constant Field Values

Constructor Detail

JMXDiscoveryComponent

public JMXDiscoveryComponent()

Method Detail

discoverResources

public Set<DiscoveredResourceDetails> discoverResources(ResourceDiscoveryContext context)

Specified by:

discoverResources in interface ResourceDiscoveryComponent

getProcessExcludes

protected Set<String> getProcessExcludes()

discoverResource

public DiscoveredResourceDetails discoverResource(org.rhq.core.domain.configuration.Configuration pluginConfig,
                                                  ResourceDiscoveryContext discoveryContext)
                                           throws InvalidPluginConfigurationException

Specified by:

discoverResource in interface ManualAddFacet

Throws:

InvalidPluginConfigurationException

getAdditionalClasspathUrls

public List<URL> getAdditionalClasspathUrls(ResourceDiscoveryContext<ResourceComponent<?>> context,
                                            DiscoveredResourceDetails details)
                                     throws Exception

Throws:

Exception

upgrade

public org.rhq.core.domain.resource.ResourceUpgradeReport upgrade(ResourceUpgradeContext inventoriedResource)

Specified by:

upgrade in interface ResourceUpgradeFacet

discoverResourceDetails

protected DiscoveredResourceDetails discoverResourceDetails(ResourceDiscoveryContext context,
                                                            ProcessInfo process)

buildResourceDetails

protected DiscoveredResourceDetails buildResourceDetails(ResourceDiscoveryContext context,
                                                         ProcessInfo process,
                                                         JMXServiceURL jmxServiceURL,
                                                         Integer jmxRemotingPort)

getJavaVersion

protected String getJavaVersion(ProcessInfo process,
                                JMXServiceURL jmxServiceURL)

getJavaVersion

protected String getJavaVersion(JMXConnector jmxConnector)
                         throws Exception

Throws:

Exception

getJavaMainClassName

protected String getJavaMainClassName(ProcessInfo process)

getJmxRemotingPort

protected Integer getJmxRemotingPort(ProcessInfo process)

getSystemPropertyValue

protected String getSystemPropertyValue(ProcessInfo process,
                                        String systemPropertyName)