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

Class PolicyBasedAccessControlHandlerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<PolicyBasedAccessControlHandlerCfgClient,PolicyBasedAccessControlHandlerCfg>

org.forgerock.opendj.server.config.meta.PolicyBasedAccessControlHandlerCfgDefn

public final class PolicyBasedAccessControlHandlerCfgDefn
extends ManagedObjectDefinition<PolicyBasedAccessControlHandlerCfgClient,PolicyBasedAccessControlHandlerCfg>

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

A policy based access control handler implements a coarse grained access control model suitable for use in proxies.

Method Summary

Modifier and Type	Method	Description
PolicyBasedAccessControlHandlerCfgClient	createClientConfiguration(ManagedObject<? extends PolicyBasedAccessControlHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
PolicyBasedAccessControlHandlerCfg	createServerConfiguration(ServerManagedObject<? extends PolicyBasedAccessControlHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
InstantiableRelationDefinition<GlobalAccessControlPolicyCfgClient,GlobalAccessControlPolicyCfg>	getGlobalAccessControlPoliciesRelationDefinition()	Get the "global-access-control-policies" relation definition.
static PolicyBasedAccessControlHandlerCfgDefn	getInstance()	Get the Policy Based Access Control Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<PolicyBasedAccessControlHandlerCfg>	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 PolicyBasedAccessControlHandlerCfgDefn getInstance()

Get the Policy Based Access Control Handler configuration definition singleton.

Returns:

Returns the Policy Based Access Control Handler configuration definition singleton.

createClientConfiguration

public PolicyBasedAccessControlHandlerCfgClient createClientConfiguration(ManagedObject<? extends PolicyBasedAccessControlHandlerCfgClient> 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<PolicyBasedAccessControlHandlerCfgClient,PolicyBasedAccessControlHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<PolicyBasedAccessControlHandlerCfgClient,PolicyBasedAccessControlHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<PolicyBasedAccessControlHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<PolicyBasedAccessControlHandlerCfgClient,PolicyBasedAccessControlHandlerCfg>

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

Returns:

Returns the "java-class" property definition.

getGlobalAccessControlPoliciesRelationDefinition

public InstantiableRelationDefinition<GlobalAccessControlPolicyCfgClient,GlobalAccessControlPolicyCfg> getGlobalAccessControlPoliciesRelationDefinition()

Get the "global-access-control-policies" relation definition.

Returns:

Returns the "global-access-control-policies" relation definition.