Package org.forgerock.opendj.server.config.meta

Class JmxConnectionHandlerCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<JmxConnectionHandlerCfgClient,JmxConnectionHandlerCfg>
org.forgerock.opendj.server.config.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 Details

    • 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)
      Description copied from class: ManagedObjectDefinition
      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)
      Description copied from class: ManagedObjectDefinition
      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 Class<JmxConnectionHandlerCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      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.

      A set of clients who will be allowed to establish connections to this JMX Connection Handler.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.

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

    • getDeniedClientPropertyDefinition

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

      A set of clients who are not allowed to establish connections to this JMX Connection Handler.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. 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. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      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.

    • getListenAddressPropertyDefinition

      public HostPropertyDefinition getListenAddressPropertyDefinition()
      Get the "listen-address" property definition.

      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 "listen-address" 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.

    • getRestrictedClientPropertyDefinition

      public IpAddressMaskPropertyDefinition getRestrictedClientPropertyDefinition()
      Get the "restricted-client" property definition.

      A set of clients who will be limited to the maximum number of connections specified by the "restricted-client-connection-limit" property.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.

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

    • getRestrictedClientConnectionLimitPropertyDefinition

      public IntegerPropertyDefinition getRestrictedClientConnectionLimitPropertyDefinition()
      Get the "restricted-client-connection-limit" property definition.

      Specifies the maximum number of connections a restricted client can open at the same time to this JMX Connection Handler.

      Once Directory Server accepts the specified number of connections from a client specified in restricted-client, any additional connection will be rejected. The number of connections is maintained by IP address. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Returns:
      Returns the "restricted-client-connection-limit" property definition.

    • getRmiPortPropertyDefinition

      public IntegerPropertyDefinition getRmiPortPropertyDefinition()
      Get the "rmi-port" property definition.

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

    • getSslCertNicknamePropertyDefinition

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

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