JmxServerConnector (OpenNMS 29.0.3 API)

All Known Implementing Classes:

DefaultJmxConnector, 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 Description

static class JmxServerConnector.Parameters

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String DEFAULT_OPENNMS_JMX_PORT

static java.lang.String JMX_PORT_SYSTEM_PROPERTY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`JmxServerConnectionWrapper`	`createConnection(java.net.InetAddress ipAddress, java.util.Map<java.lang.String,java.lang.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 java.lang.String DEFAULT_OPENNMS_JMX_PORT
```
    See Also:
    
    Constant Field Values
  - JMX_PORT_SYSTEM_PROPERTY
```
static final java.lang.String JMX_PORT_SYSTEM_PROPERTY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - createConnection
```
JmxServerConnectionWrapper createConnection(java.net.InetAddress ipAddress,
                                            java.util.Map<java.lang.String,java.lang.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.