Package org.forgerock.opendj.server.config.client

Interface JMXConnectionHandlerCfgClient

All Superinterfaces:

ConfigurationClient, ConnectionHandlerCfgClient

public interface JMXConnectionHandlerCfgClient
extends ConnectionHandlerCfgClient

A client-side interface for reading and modifying JMX Connection Handler settings.

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

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends JMXConnectionHandlerCfgClient,? extends JMXConnectionHandlerCfg>	definition()	Get the configuration definition associated with this JMX Connection Handler.
String	getJavaClass()	Gets the "java-class" property.
String	getKeyManagerProvider()	Gets the "key-manager-provider" property.
InetAddress	getListenAddress()	Gets the "listen-address" property.
Integer	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	setJavaClass(String value)	Sets the "java-class" property.
void	setKeyManagerProvider(String value)	Sets the "key-manager-provider" property.
void	setListenAddress(InetAddress value)	Sets the "listen-address" property.
void	setListenPort(int value)	Sets the "listen-port" property.
void	setRmiPort(Integer value)	Sets the "rmi-port" property.
void	setSSLCertNickname(Collection<String> values)	Sets the "ssl-cert-nickname" property.
void	setUseSSL(Boolean value)	Sets the "use-ssl" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.ConnectionHandlerCfgClient

getAllowedClient, getDeniedClient, isEnabled, setAllowedClient, setDeniedClient, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends JMXConnectionHandlerCfgClient,? extends JMXConnectionHandlerCfg> definition()

Get the configuration definition associated with this JMX Connection Handler.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface ConnectionHandlerCfgClient

Returns:

Returns the configuration definition associated with this JMX Connection Handler.

getJavaClass

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 ConnectionHandlerCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface ConnectionHandlerCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getKeyManagerProvider

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.

setKeyManagerProvider

void setKeyManagerProvider(String value)
                    throws PropertyException

Sets the "key-manager-provider" property.

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

Parameters:

value - The value of the "key-manager-provider" property.

Throws:

PropertyException - If the new value is invalid.

getListenAddress

InetAddress getListenAddress()

Gets the "listen-address" property.

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.

Returns:

Returns the value of the "listen-address" property.

setListenAddress

void setListenAddress(InetAddress value)
               throws PropertyException

Sets the "listen-address" property.

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.

Parameters:

value - The value of the "listen-address" property.

Throws:

PropertyException - If the new value is invalid.

getListenPort

Integer 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.

setListenPort

void setListenPort(int value)
            throws PropertyException

Sets 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.

Parameters:

value - The value of the "listen-port" property.

Throws:

PropertyException - If the new value is invalid.

getRmiPort

int getRmiPort()

Gets the "rmi-port" property.

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.

Returns:

Returns the value of the "rmi-port" property.

setRmiPort

void setRmiPort(Integer value)
         throws PropertyException

Sets the "rmi-port" property.

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.

Parameters:

value - The value of the "rmi-port" property.

Throws:

PropertyException - If the new value is invalid.

getSSLCertNickname

SortedSet<String> getSSLCertNickname()

Gets the "ssl-cert-nickname" property.

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.

Returns:

Returns the values of the "ssl-cert-nickname" property.

setSSLCertNickname

void setSSLCertNickname(Collection<String> values)
                 throws PropertyException

Sets the "ssl-cert-nickname" property.

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.

Parameters:

values - The values of the "ssl-cert-nickname" property.

Throws:

PropertyException - If one or more of the new values are invalid.

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.

setUseSSL

void setUseSSL(Boolean value)
        throws PropertyException

Sets 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.

Parameters:

value - The value of the "use-ssl" property.

Throws:

PropertyException - If the new value is invalid.