org.opends.server.admin.std.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
 ManagedObjectDefinition<? extends JMXConnectionHandlerCfgClient,? extends JMXConnectionHandlerCfg> definition()
          Get the configuration definition 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.
 java.lang.Integer getListenPort()
          Gets the "listen-port" property.
 java.lang.String getSSLCertNickname()
          Gets the "ssl-cert-nickname" property.
 boolean isUseSSL()
          Gets the "use-ssl" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setKeyManagerProvider(java.lang.String value)
          Sets the "key-manager-provider" property.
 void setListenPort(int value)
          Sets the "listen-port" property.
 void setSSLCertNickname(java.lang.String value)
          Sets the "ssl-cert-nickname" property.
 void setUseSSL(java.lang.Boolean value)
          Sets the "use-ssl" property.
 
Methods inherited from interface org.opends.server.admin.std.client.ConnectionHandlerCfgClient
getAllowedClient, getDeniedClient, isEnabled, setAllowedClient, setDeniedClient, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

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

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 ConnectionHandlerCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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.

setKeyManagerProvider

void setKeyManagerProvider(java.lang.String value)
                           throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

getListenPort

java.lang.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 IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

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.

setSSLCertNickname

void setSSLCertNickname(java.lang.String value)
                        throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "ssl-cert-nickname" property.
Throws:
IllegalPropertyValueException - If the new value is 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(java.lang.Boolean value)
               throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.