org.opends.server.admin.std.meta
Class JMXConnectionHandlerCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<JMXConnectionHandlerCfgClient,JMXConnectionHandlerCfg>
          extended by org.opends.server.admin.std.meta.JMXConnectionHandlerCfgDefn

public final class JMXConnectionHandlerCfgDefn
extends ManagedObjectDefinition<JMXConnectionHandlerCfgClient,JMXConnectionHandlerCfg>

An interface for querying the JMX Connection Handler managed object definition meta information.

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


Method Summary
 JMXConnectionHandlerCfgClient createClientConfiguration(ManagedObject<? extends JMXConnectionHandlerCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 JMXConnectionHandlerCfg createServerConfiguration(ServerManagedObject<? extends JMXConnectionHandlerCfg> impl)
          Creates a server configuration view of the provided server managed object.
 IPAddressMaskPropertyDefinition getAllowedClientPropertyDefinition()
          Get the "allowed-client" property definition.
 IPAddressMaskPropertyDefinition getDeniedClientPropertyDefinition()
          Get the "denied-client" property definition.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static JMXConnectionHandlerCfgDefn getInstance()
          Get the JMX Connection Handler configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg> getKeyManagerProviderPropertyDefinition()
          Get the "key-manager-provider" property definition.
 IntegerPropertyDefinition getListenPortPropertyDefinition()
          Get the "listen-port" property definition.
 java.lang.Class<JMXConnectionHandlerCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 StringPropertyDefinition getSSLCertNicknamePropertyDefinition()
          Get the "ssl-cert-nickname" property definition.
 BooleanPropertyDefinition getUseSSLPropertyDefinition()
          Get the "use-ssl" property definition.
 
Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getInstance

public static JMXConnectionHandlerCfgDefn getInstance()
Get the JMX Connection Handler configuration definition singleton.

Returns:
Returns the JMX Connection Handler configuration definition singleton.

createClientConfiguration

public JMXConnectionHandlerCfgClient createClientConfiguration(ManagedObject<? extends JMXConnectionHandlerCfgClient> impl)
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:
createClientConfiguration in class ManagedObjectDefinition<JMXConnectionHandlerCfgClient,JMXConnectionHandlerCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public JMXConnectionHandlerCfg createServerConfiguration(ServerManagedObject<? extends JMXConnectionHandlerCfg> impl)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<JMXConnectionHandlerCfgClient,JMXConnectionHandlerCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<JMXConnectionHandlerCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<JMXConnectionHandlerCfgClient,JMXConnectionHandlerCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getAllowedClientPropertyDefinition

public IPAddressMaskPropertyDefinition getAllowedClientPropertyDefinition()
Get the "allowed-client" property definition.

Specifies a set of address masks that determines the addresses of the clients that are allowed to establish connections to this connection handler.

Returns:
Returns the "allowed-client" property definition.

getDeniedClientPropertyDefinition

public IPAddressMaskPropertyDefinition getDeniedClientPropertyDefinition()
Get the "denied-client" property definition.

Specifies a set of address masks that determines the addresses of the clients that are not allowed to establish connections to this connection handler.

If both allowed and denied client masks are defined and a client connection matches one or more masks in both lists, then the connection is denied. If only a denied list is specified, then any client not matching a mask in that list is allowed.

Returns:
Returns the "denied-client" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.

Indicates whether the JMX Connection Handler is enabled.

Returns:
Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.

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

Returns:
Returns the "java-class" property definition.

getKeyManagerProviderPropertyDefinition

public AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg> getKeyManagerProviderPropertyDefinition()
Get the "key-manager-provider" property definition.

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

Returns:
Returns the "key-manager-provider" property definition.

getListenPortPropertyDefinition

public IntegerPropertyDefinition getListenPortPropertyDefinition()
Get the "listen-port" property definition.

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 "listen-port" property definition.

getSSLCertNicknamePropertyDefinition

public StringPropertyDefinition getSSLCertNicknamePropertyDefinition()
Get the "ssl-cert-nickname" property definition.

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 "ssl-cert-nickname" property definition.

getUseSSLPropertyDefinition

public BooleanPropertyDefinition getUseSSLPropertyDefinition()
Get the "use-ssl" property definition.

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 "use-ssl" property definition.