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

Class DseeCompatAccessControlHandlerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<DseeCompatAccessControlHandlerCfgClient,DseeCompatAccessControlHandlerCfg>

org.forgerock.opendj.server.config.meta.DseeCompatAccessControlHandlerCfgDefn

public final class DseeCompatAccessControlHandlerCfgDefn
extends ManagedObjectDefinition<DseeCompatAccessControlHandlerCfgClient,DseeCompatAccessControlHandlerCfg>

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

The DSEE Compatible Access Control Handler provides an implementation that uses syntax compatible with the Sun Java System Directory Server Enterprise Edition access control handlers.

Method Summary

Modifier and Type	Method	Description
DseeCompatAccessControlHandlerCfgClient	createClientConfiguration(ManagedObject<? extends DseeCompatAccessControlHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
DseeCompatAccessControlHandlerCfg	createServerConfiguration(ServerManagedObject<? extends DseeCompatAccessControlHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
AciPropertyDefinition	getGlobalAciPropertyDefinition()	Get the "global-aci" property definition.
static DseeCompatAccessControlHandlerCfgDefn	getInstance()	Get the DSEE Compatible Access Control Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<DseeCompatAccessControlHandlerCfg>	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 DseeCompatAccessControlHandlerCfgDefn getInstance()

Get the DSEE Compatible Access Control Handler configuration definition singleton.

Returns:

Returns the DSEE Compatible Access Control Handler configuration definition singleton.

createClientConfiguration

public DseeCompatAccessControlHandlerCfgClient createClientConfiguration(ManagedObject<? extends DseeCompatAccessControlHandlerCfgClient> 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<DseeCompatAccessControlHandlerCfgClient,DseeCompatAccessControlHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<DseeCompatAccessControlHandlerCfgClient,DseeCompatAccessControlHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<DseeCompatAccessControlHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<DseeCompatAccessControlHandlerCfgClient,DseeCompatAccessControlHandlerCfg>

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 DSEE Compatible 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.

getGlobalAciPropertyDefinition

public AciPropertyDefinition getGlobalAciPropertyDefinition()

Get the "global-aci" property definition.

Defines global access control rules.

Global access control rules apply to all entries anywhere in the data managed by the OpenDJ directory server. The global access control rules may be overridden by more specific access control rules placed in the data.

Returns:

Returns the "global-aci" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the DSEE Compatible Access Control Handler implementation.

Returns:

Returns the "java-class" property definition.