org.forgerock.opendj.server.config.meta

Class HTTPAnonymousAuthorizationMechanismCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<HTTPAnonymousAuthorizationMechanismCfgClient,HTTPAnonymousAuthorizationMechanismCfg>

org.forgerock.opendj.server.config.meta.HTTPAnonymousAuthorizationMechanismCfgDefn

public final class HTTPAnonymousAuthorizationMechanismCfgDefn
extends ManagedObjectDefinition<HTTPAnonymousAuthorizationMechanismCfgClient,HTTPAnonymousAuthorizationMechanismCfg>

An interface for querying the HTTP Anonymous Authorization Mechanism managed object definition meta information.

The HTTP Anonymous Authorization Mechanism is used to define static authorization.

Method Summary

Modifier and Type	Method and Description
HTTPAnonymousAuthorizationMechanismCfgClient	createClientConfiguration(ManagedObject<? extends HTTPAnonymousAuthorizationMechanismCfgClient> impl) Creates a client configuration view of the provided managed object.
HTTPAnonymousAuthorizationMechanismCfg	createServerConfiguration(ServerManagedObject<? extends HTTPAnonymousAuthorizationMechanismCfg> impl) Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static HTTPAnonymousAuthorizationMechanismCfgDefn	getInstance() Get the HTTP Anonymous Authorization Mechanism configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
Class<HTTPAnonymousAuthorizationMechanismCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object definition.
DNPropertyDefinition	getUserDNPropertyDefinition() Get the "user-dn" property definition.

Methods inherited from class org.forgerock.opendj.config.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 HTTPAnonymousAuthorizationMechanismCfgDefn getInstance()

Get the HTTP Anonymous Authorization Mechanism configuration definition singleton.

Returns:

Returns the HTTP Anonymous Authorization Mechanism configuration definition singleton.

createClientConfiguration

public HTTPAnonymousAuthorizationMechanismCfgClient createClientConfiguration(ManagedObject<? extends HTTPAnonymousAuthorizationMechanismCfgClient> 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<HTTPAnonymousAuthorizationMechanismCfgClient,HTTPAnonymousAuthorizationMechanismCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<HTTPAnonymousAuthorizationMechanismCfgClient,HTTPAnonymousAuthorizationMechanismCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<HTTPAnonymousAuthorizationMechanismCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<HTTPAnonymousAuthorizationMechanismCfgClient,HTTPAnonymousAuthorizationMechanismCfg>

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 HTTP Anonymous Authorization Mechanism 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 HTTP Anonymous Authorization Mechanism implementation.

Returns:

Returns the "java-class" property definition.

getUserDNPropertyDefinition

public DNPropertyDefinition getUserDNPropertyDefinition()

Get the "user-dn" property definition.

The authorization DN which will be used for performing anonymous operations.

Returns:

Returns the "user-dn" property definition.