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

Class AccessControlHandlerCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<AccessControlHandlerCfgClient,AccessControlHandlerCfg>

org.forgerock.opendj.server.config.meta.AccessControlHandlerCfgDefn

public final class AccessControlHandlerCfgDefn
extends ManagedObjectDefinition<AccessControlHandlerCfgClient,AccessControlHandlerCfg>

An interface for querying the Access Control Handler managed object definition meta information.

Access Control Handlers manage the application-wide access control. The OpenDJ access control handler is defined through an extensible interface, so that alternate implementations can be created. Only one access control handler may be active in the server at any given time.

Method Summary

Modifier and Type	Method	Description
AccessControlHandlerCfgClient	createClientConfiguration(ManagedObject<? extends AccessControlHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
AccessControlHandlerCfg	createServerConfiguration(ServerManagedObject<? extends AccessControlHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static AccessControlHandlerCfgDefn	getInstance()	Get the Access Control Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<AccessControlHandlerCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

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

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, 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 Details

getInstance

public static AccessControlHandlerCfgDefn getInstance()

Get the Access Control Handler configuration definition singleton.

Returns:

Returns the Access Control Handler configuration definition singleton.

createClientConfiguration

public AccessControlHandlerCfgClient createClientConfiguration(ManagedObject<? extends AccessControlHandlerCfgClient> 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<AccessControlHandlerCfgClient,AccessControlHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public AccessControlHandlerCfg createServerConfiguration(ServerManagedObject<? extends AccessControlHandlerCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<AccessControlHandlerCfgClient,AccessControlHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<AccessControlHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<AccessControlHandlerCfgClient,AccessControlHandlerCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Access Control Handler is enabled. If set to FALSE, then any client (including unauthenticated or anonymous clients) is allowed to bind to the server and any connection with the "bypass-acl" privilege is allowed to perform any operation.

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 Access Control Handler implementation.

Returns:

Returns the "java-class" property definition.