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.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<String>	getKeyManagerProvider()	Gets the "key-manager-provider" property.
ValueOrExpression<com.forgerock.opendj.util.Host>	getListenAddress()	Gets the "listen-address" property.
ValueOrExpression<Integer>	getListenPort()	Gets the "listen-port" property.
ValueOrExpression<Integer>	getRmiPort()	Gets the "rmi-port" property.
SortedSet<ValueOrExpression<String>>	getSslCertNickname()	Gets the "ssl-cert-nickname" property.
ValueOrExpression<Boolean>	isUseSsl()	Gets the "use-ssl" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setKeyManagerProvider(ValueOrExpression<String> value)	Sets the "key-manager-provider" property.
void	setListenAddress(ValueOrExpression<com.forgerock.opendj.util.Host> value)	Sets the "listen-address" property.
void	setListenPort(ValueOrExpression<Integer> value)	Sets the "listen-port" property.
void	setRmiPort(ValueOrExpression<Integer> value)	Sets the "rmi-port" property.
void	setSslCertNickname(Collection<ValueOrExpression<String>> values)	Sets the "ssl-cert-nickname" property.
void	setUseSsl(ValueOrExpression<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, getRestrictedClient, getRestrictedClientConnectionLimit, isEnabled, setAllowedClient, setDeniedClient, setEnabled, setRestrictedClient, setRestrictedClientConnectionLimit

Method Details

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

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.protocols.jmx.JmxConnectionHandler

Specified by:

getJavaClass in interface ConnectionHandlerCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<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

ValueOrExpression<String> getKeyManagerProvider()

Gets the "key-manager-provider" property.

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

Default value is undefined

Returns:

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

setKeyManagerProvider

void setKeyManagerProvider(ValueOrExpression<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

ValueOrExpression<com.forgerock.opendj.util.Host> 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.

Default value: 0.0.0.0

Returns:

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

setListenAddress

void setListenAddress(ValueOrExpression<com.forgerock.opendj.util.Host> 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

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setListenPort(ValueOrExpression<Integer> 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

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

Default value: 0

Returns:

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

setRmiPort

void setRmiPort(ValueOrExpression<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<ValueOrExpression<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<ValueOrExpression<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

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

Default value: false

Returns:

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

setUseSsl

void setUseSsl(ValueOrExpression<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.