org.opends.server.admin.std.meta

Class ConnectionHandlerCfgDefn

java.lang.Object

org.opends.server.admin.AbstractManagedObjectDefinition<C,S>

org.opends.server.admin.ManagedObjectDefinition<ConnectionHandlerCfgClient,ConnectionHandlerCfg>

org.opends.server.admin.std.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

Methods

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.
Class<ConnectionHandlerCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object 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 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)

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)

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()

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.

Specifies a set of host names or address masks that determine the clients that are 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.

Returns:

Returns the "allowed-client" property definition.

getDeniedClientPropertyDefinition

public IPAddressMaskPropertyDefinition getDeniedClientPropertyDefinition()

Get the "denied-client" property definition.

Specifies a set of host names or address masks that determine the clients that 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.

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.