public interface JmxConnectionHandlerCfg extends ConnectionHandlerCfg
The JMX Connection Handler is used to interact with clients using the Java Management Extensions (JMX) protocol.
Modifier and Type | Method and Description |
---|---|
void |
addJmxChangeListener(ConfigurationChangeListener<JmxConnectionHandlerCfg> listener)
Register to be notified when this JMX Connection Handler is changed.
|
Class<? extends JmxConnectionHandlerCfg> |
configurationClass()
Gets the configuration class associated with this JMX Connection Handler.
|
String |
getJavaClass()
Gets the "java-class" property.
|
String |
getKeyManagerProvider()
Gets the "key-manager-provider" property.
|
Dn |
getKeyManagerProviderDn()
Gets the "key-manager-provider" property as a DN.
|
InetAddress |
getListenAddress()
Gets the "listen-address" property.
|
int |
getListenPort()
Gets the "listen-port" property.
|
int |
getRmiPort()
Gets the "rmi-port" property.
|
SortedSet<String> |
getSslCertNickname()
Gets the "ssl-cert-nickname" property.
|
boolean |
isUseSsl()
Gets the "use-ssl" property.
|
void |
removeJmxChangeListener(ConfigurationChangeListener<JmxConnectionHandlerCfg> listener)
Deregister an existing JMX Connection Handler configuration change listener.
|
addChangeListener, getAllowedClient, getDeniedClient, isEnabled, removeChangeListener
dn, name
Class<? extends JmxConnectionHandlerCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface ConnectionHandlerCfg
void addJmxChangeListener(ConfigurationChangeListener<JmxConnectionHandlerCfg> listener)
listener
- The JMX Connection Handler configuration change listener.void removeJmxChangeListener(ConfigurationChangeListener<JmxConnectionHandlerCfg> listener)
listener
- The JMX Connection Handler configuration change listener.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the JMX Connection Handler implementation.
getJavaClass
in interface ConnectionHandlerCfg
String getKeyManagerProvider()
Specifies the name of the key manager that should be used with this JMX Connection Handler .
Dn getKeyManagerProviderDn()
Specifies the name of the key manager that should be used with this JMX Connection Handler .
InetAddress getListenAddress()
Specifies the address on which this JMX Connection Handler should listen for connections from JMX clients.
If no value is provided, then the JMX Connection Handler listens on all interfaces.
int getListenPort()
Specifies the port number on which the JMX Connection Handler will listen for connections from clients.
Only a single port number may be provided.
int getRmiPort()
Specifies the port number on which the JMX RMI service will listen for connections from clients. A value of 0 indicates the service to choose a port of its own.
If the value provided is different than 0, the value will be used as the RMI port. Otherwise, the RMI service will choose a port of its own.
SortedSet<String> getSslCertNickname()
Specifies the nicknames (also called the aliases) of the keys or key pairs that the JMX Connection Handler should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.
This is only applicable when the JMX Connection Handler is configured to use SSL.
boolean isUseSsl()
Indicates whether the JMX Connection Handler should use SSL.
If enabled, the JMX Connection Handler will use SSL to encrypt communication with the clients.
Copyright 2010-2020 ForgeRock AS.