public final class ConnectionHandlerCfgDefn extends ManagedObjectDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>
Connection Handlers are responsible for handling all interaction with the clients, including accepting the connections, reading requests, and sending responses.
Modifier and Type | Method and Description |
---|---|
ConnectionHandlerCfgClient |
createClientConfiguration(ManagedObject<? extends ConnectionHandlerCfgClient> impl)
Creates a client configuration view of the provided managed object.
|
ConnectionHandlerCfg |
createServerConfiguration(ServerManagedObject<? extends ConnectionHandlerCfg> 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 ConnectionHandlerCfgDefn |
getInstance()
Get the Connection Handler configuration definition singleton.
|
ClassPropertyDefinition |
getJavaClassPropertyDefinition()
Get the "java-class" property definition.
|
IntegerPropertyDefinition |
getRestrictedClientConnectionLimitPropertyDefinition()
Get the "restricted-client-connection-limit" property definition.
|
IpAddressMaskPropertyDefinition |
getRestrictedClientPropertyDefinition()
Get the "restricted-client" property definition.
|
Class<ConnectionHandlerCfg> |
getServerConfigurationClass()
Gets the server configuration class instance associated with this managed
object definition.
|
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 ConnectionHandlerCfgDefn getInstance()
public ConnectionHandlerCfgClient createClientConfiguration(ManagedObject<? extends ConnectionHandlerCfgClient> impl)
ManagedObjectDefinition
createClientConfiguration
in class ManagedObjectDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>
impl
- The managed object.public ConnectionHandlerCfg createServerConfiguration(ServerManagedObject<? extends ConnectionHandlerCfg> impl)
ManagedObjectDefinition
createServerConfiguration
in class ManagedObjectDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>
impl
- The server managed object.public Class<ConnectionHandlerCfg> getServerConfigurationClass()
ManagedObjectDefinition
getServerConfigurationClass
in class ManagedObjectDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>
public IpAddressMaskPropertyDefinition getAllowedClientPropertyDefinition()
A set of clients who will be allowed to establish connections to this 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 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 Connection Handler is enabled.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the Connection Handler implementation.
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 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.
Copyright 2010-2022 ForgeRock AS.