org.opennms.netmgt.jmx.connection

Interface JmxServerConnector

All Known Implementing Classes:

PlatformMBeanServerConnector

public interface JmxServerConnector

The JmxServerConnector implements the logic on how to connect to a certain JMX Server (MBeanServer).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JmxServerConnector.Parameters

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_OPENNMS_JMX_PORT
static String	JMX_PORT_SYSTEM_PROPERTY

Method Summary

Modifier and Type	Method and Description
JmxServerConnectionWrapper	createConnection(InetAddress ipAddress, Map<String,String> propertiesMap) Establishes a JMX connection (MBeanServerConnection) to the given ipAddress using required properties from the given propertiesMap.

Field Detail

DEFAULT_OPENNMS_JMX_PORT

static final String DEFAULT_OPENNMS_JMX_PORT

See Also:

Constant Field Values

JMX_PORT_SYSTEM_PROPERTY

static final String JMX_PORT_SYSTEM_PROPERTY

See Also:

Constant Field Values

Method Detail

createConnection

JmxServerConnectionWrapper createConnection(InetAddress ipAddress,
                                            Map<String,String> propertiesMap)
                                     throws JmxServerConnectionException

Establishes a JMX connection (MBeanServerConnection) to the given ipAddress using required properties from the given propertiesMap.

The created MBeanServerConnection is wrapped by the JmxServerConnectionWrapper.

Parameters:

ipAddress - The IP address to connect to.

propertiesMap - Properties to use to establish the connection (e.g. timeout, user, password, etc.)

Returns:

The wrapped MBeanServerConnection. May return null, but should throw a JmxServerConnectionException instead.

Throws:

JmxServerConnectionException - If a JMX connection to the given ipAddress could not be established.