java.lang.Object
- org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
- - org.forgerock.opendj.config.ManagedObjectDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>
  - - org.forgerock.opendj.server.config.meta.ConnectionHandlerCfgDefn

```
public final class ConnectionHandlerCfgDefn
extends ManagedObjectDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>
```
An interface for querying the Connection Handler managed object definition meta information.
Connection Handlers are responsible for handling all interaction with the clients, including accepting the connections, reading requests, and sending responses.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, 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 ConnectionHandlerCfgDefn getInstance()
```
    Get the Connection Handler configuration definition singleton.
    
    Returns:
    
    Returns the Connection Handler configuration definition singleton.
  - createClientConfiguration
```
public ConnectionHandlerCfgClient createClientConfiguration(ManagedObject<? extends ConnectionHandlerCfgClient> 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<ConnectionHandlerCfgClient,ConnectionHandlerCfg>
    
    Parameters:
    
    impl - The managed object.
    
    Returns:
    
    Returns a client configuration view of the provided managed object.
  - createServerConfiguration
```
public ConnectionHandlerCfg createServerConfiguration(ServerManagedObject<? extends ConnectionHandlerCfg> impl)
```
    Description copied from class: ManagedObjectDefinition
    
    Creates a server configuration view of the provided server managed object.
    
    Specified by:
    
    createServerConfiguration in class ManagedObjectDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>
    
    Parameters:
    
    impl - The server managed object.
    
    Returns:
    
    Returns a server configuration view of the provided server managed object.
  - getServerConfigurationClass
```
public Class<ConnectionHandlerCfg> getServerConfigurationClass()
```
    Description copied from class: ManagedObjectDefinition
    
    Gets the server configuration class instance associated with this managed object definition.
    
    Specified by:
    
    getServerConfigurationClass in class ManagedObjectDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>
    
    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 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 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 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 Connection Handler implementation.
    
    Returns:
    
    Returns the "java-class" 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 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.

Class ConnectionHandlerCfgDefn

Method Summary

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

Methods inherited from class java.lang.Object

Method Detail

getInstance

createClientConfiguration

createServerConfiguration

getServerConfigurationClass

getAllowedClientPropertyDefinition

getDeniedClientPropertyDefinition

getEnabledPropertyDefinition

getJavaClassPropertyDefinition

getRestrictedClientPropertyDefinition

getRestrictedClientConnectionLimitPropertyDefinition