public interface JmxConnectionHandlerCfgClient extends ConnectionHandlerCfgClient
The JMX Connection Handler is used to interact with clients using the Java Management Extensions (JMX) protocol.
Modifier and Type | Method and 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<InetAddress> |
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<InetAddress> 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.
|
getAllowedClient, getDeniedClient, isEnabled, setAllowedClient, setDeniedClient, setEnabled
commit, properties
ManagedObjectDefinition<? extends JmxConnectionHandlerCfgClient,? extends JmxConnectionHandlerCfg> definition()
definition
in interface ConfigurationClient
definition
in interface ConnectionHandlerCfgClient
ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the JMX Connection Handler implementation.
getJavaClass
in interface ConnectionHandlerCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the JMX Connection Handler implementation.
setJavaClass
in interface ConnectionHandlerCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getKeyManagerProvider()
Specifies the name of the key manager that should be used with this JMX Connection Handler .
void setKeyManagerProvider(ValueOrExpression<String> value) throws PropertyException
Specifies the name of the key manager that should be used with this JMX Connection Handler .
value
- The value of the "key-manager-provider" property.PropertyException
- If the new value is invalid.ValueOrExpression<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.
void setListenAddress(ValueOrExpression<InetAddress> value) throws PropertyException
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.
value
- The value of the "listen-address" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> 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.
void setListenPort(ValueOrExpression<Integer> value) throws PropertyException
Specifies the port number on which the JMX Connection Handler will listen for connections from clients.
Only a single port number may be provided.
value
- The value of the "listen-port" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> 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.
void setRmiPort(ValueOrExpression<Integer> value) throws PropertyException
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.
value
- The value of the "rmi-port" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<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.
void setSslCertNickname(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "ssl-cert-nickname" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<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.
void setUseSsl(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the JMX Connection Handler should use SSL.
If enabled, the JMX Connection Handler will use SSL to encrypt communication with the clients.
value
- The value of the "use-ssl" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.