org.opends.server.admin.std.server
Interface JMXConnectionHandlerCfg

All Superinterfaces:
Configuration, ConnectionHandlerCfg

public interface JMXConnectionHandlerCfg
extends ConnectionHandlerCfg

A server-side interface for querying JMX Connection Handler settings.

The JMX Connection Handler is used to interact with clients using the Java Management Extensions (JMX) protocol.


Method Summary
 void addJMXChangeListener(ConfigurationChangeListener<JMXConnectionHandlerCfg> listener)
          Register to be notified when this JMX Connection Handler is changed.
 java.lang.Class<? extends JMXConnectionHandlerCfg> configurationClass()
          Gets the configuration class associated with this JMX Connection Handler.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getKeyManagerProvider()
          Gets the "key-manager-provider" property.
 DN getKeyManagerProviderDN()
          Gets the "key-manager-provider" property as a DN.
 int getListenPort()
          Gets the "listen-port" property.
 java.lang.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.
 
Methods inherited from interface org.opends.server.admin.std.server.ConnectionHandlerCfg
addChangeListener, getAllowedClient, getDeniedClient, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends JMXConnectionHandlerCfg> configurationClass()
Gets the configuration class associated with this JMX Connection Handler.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface ConnectionHandlerCfg
Returns:
Returns the configuration class associated with this JMX Connection Handler.

addJMXChangeListener

void addJMXChangeListener(ConfigurationChangeListener<JMXConnectionHandlerCfg> listener)
Register to be notified when this JMX Connection Handler is changed.

Parameters:
listener - The JMX Connection Handler configuration change listener.

removeJMXChangeListener

void removeJMXChangeListener(ConfigurationChangeListener<JMXConnectionHandlerCfg> listener)
Deregister an existing JMX Connection Handler configuration change listener.

Parameters:
listener - The JMX Connection Handler configuration change listener.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the JMX Connection Handler implementation.

Specified by:
getJavaClass in interface ConnectionHandlerCfg
Returns:
Returns the value of the "java-class" property.

getKeyManagerProvider

java.lang.String getKeyManagerProvider()
Gets the "key-manager-provider" property.

Specifies the name of the key manager that should be used with this JMX Connection Handler .

Returns:
Returns the value of the "key-manager-provider" property.

getKeyManagerProviderDN

DN getKeyManagerProviderDN()
Gets the "key-manager-provider" property as a DN.

Specifies the name of the key manager that should be used with this JMX Connection Handler .

Returns:
Returns the DN value of the "key-manager-provider" property.

getListenPort

int getListenPort()
Gets the "listen-port" property.

Specifies the port number on which the JMX Connection Handler will listen for connections from clients.

Only a single port number may be provided.

Returns:
Returns the value of the "listen-port" property.

getSSLCertNickname

java.lang.String getSSLCertNickname()
Gets the "ssl-cert-nickname" property.

Specifies the nickname (also called the alias) of the certificate that the JMX Connection Handler should use when performing SSL communication.

This is only applicable when the JMX Connection Handler is configured to use SSL.

Returns:
Returns the value of the "ssl-cert-nickname" property.

isUseSSL

boolean isUseSSL()
Gets the "use-ssl" property.

Indicates whether the JMX Connection Handler should use SSL.

If enabled, the JMX Connection Handler will use SSL to encrypt communication with the clients.

Returns:
Returns the value of the "use-ssl" property.