public final class JmxConnectionHandlerCfgDefn extends ManagedObjectDefinition<JmxConnectionHandlerCfgClient,JmxConnectionHandlerCfg>
The JMX Connection Handler is used to interact with clients using the Java Management Extensions (JMX) protocol.
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
public static JmxConnectionHandlerCfgDefn getInstance()
public JmxConnectionHandlerCfgClient createClientConfiguration(ManagedObject<? extends JmxConnectionHandlerCfgClient> impl)
ManagedObjectDefinition
createClientConfiguration
in class ManagedObjectDefinition<JmxConnectionHandlerCfgClient,JmxConnectionHandlerCfg>
impl
- The managed object.public JmxConnectionHandlerCfg createServerConfiguration(ServerManagedObject<? extends JmxConnectionHandlerCfg> impl)
ManagedObjectDefinition
createServerConfiguration
in class ManagedObjectDefinition<JmxConnectionHandlerCfgClient,JmxConnectionHandlerCfg>
impl
- The server managed object.public Class<JmxConnectionHandlerCfg> getServerConfigurationClass()
ManagedObjectDefinition
getServerConfigurationClass
in class ManagedObjectDefinition<JmxConnectionHandlerCfgClient,JmxConnectionHandlerCfg>
public IpAddressMaskPropertyDefinition getAllowedClientPropertyDefinition()
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.
public IpAddressMaskPropertyDefinition getDeniedClientPropertyDefinition()
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.
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the JMX Connection Handler is enabled.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the JMX Connection Handler implementation.
public AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg> getKeyManagerProviderPropertyDefinition()
Specifies the name of the key manager that should be used with this JMX Connection Handler .
public IpAddressPropertyDefinition getListenAddressPropertyDefinition()
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.
public IntegerPropertyDefinition getListenPortPropertyDefinition()
Specifies the port number on which the JMX Connection Handler will listen for connections from clients.
Only a single port number may be provided.
public IpAddressMaskPropertyDefinition getRestrictedClientPropertyDefinition()
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.
public IntegerPropertyDefinition getRestrictedClientConnectionLimitPropertyDefinition()
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.
public IntegerPropertyDefinition getRmiPortPropertyDefinition()
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.
public StringPropertyDefinition getSslCertNicknamePropertyDefinition()
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.
public BooleanPropertyDefinition getUseSslPropertyDefinition()
Indicates whether the JMX Connection Handler should use SSL.
If enabled, the JMX Connection Handler will use SSL to encrypt communication with the clients.
Copyright 2010-2022 ForgeRock AS.