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

Class HTTPBasicAuthorizationMechanismCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<HTTPBasicAuthorizationMechanismCfgClient,HTTPBasicAuthorizationMechanismCfg>

org.forgerock.opendj.server.config.meta.HTTPBasicAuthorizationMechanismCfgDefn

public final class HTTPBasicAuthorizationMechanismCfgDefn
extends ManagedObjectDefinition<HTTPBasicAuthorizationMechanismCfgClient,HTTPBasicAuthorizationMechanismCfg>

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

The HTTP Basic Authorization Mechanism authenticates the end-user using credentials extracted from the HTTP Basic 'Authorization' header.

Method Summary

Modifier and Type	Method	Description
HTTPBasicAuthorizationMechanismCfgClient	createClientConfiguration(ManagedObject<? extends HTTPBasicAuthorizationMechanismCfgClient> impl)	Creates a client configuration view of the provided managed object.
HTTPBasicAuthorizationMechanismCfg	createServerConfiguration(ServerManagedObject<? extends HTTPBasicAuthorizationMechanismCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getAltAuthenticationEnabledPropertyDefinition()	Get the "alt-authentication-enabled" property definition.
StringPropertyDefinition	getAltPasswordHeaderPropertyDefinition()	Get the "alt-password-header" property definition.
StringPropertyDefinition	getAltUsernameHeaderPropertyDefinition()	Get the "alt-username-header" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg>	getIdentityMapperPropertyDefinition()	Get the "identity-mapper" property definition.
static HTTPBasicAuthorizationMechanismCfgDefn	getInstance()	Get the HTTP Basic Authorization Mechanism configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<HTTPBasicAuthorizationMechanismCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object 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 HTTPBasicAuthorizationMechanismCfgDefn getInstance()

Get the HTTP Basic Authorization Mechanism configuration definition singleton.

Returns:

Returns the HTTP Basic Authorization Mechanism configuration definition singleton.

createClientConfiguration

public HTTPBasicAuthorizationMechanismCfgClient createClientConfiguration(ManagedObject<? extends HTTPBasicAuthorizationMechanismCfgClient> 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<HTTPBasicAuthorizationMechanismCfgClient,HTTPBasicAuthorizationMechanismCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<HTTPBasicAuthorizationMechanismCfgClient,HTTPBasicAuthorizationMechanismCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<HTTPBasicAuthorizationMechanismCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<HTTPBasicAuthorizationMechanismCfgClient,HTTPBasicAuthorizationMechanismCfg>

Returns:

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

getAltAuthenticationEnabledPropertyDefinition

public BooleanPropertyDefinition getAltAuthenticationEnabledPropertyDefinition()

Get the "alt-authentication-enabled" property definition.

Specifies whether user credentials may be provided using alternative headers to the standard 'Authorize' header.

Returns:

Returns the "alt-authentication-enabled" property definition.

getAltPasswordHeaderPropertyDefinition

public StringPropertyDefinition getAltPasswordHeaderPropertyDefinition()

Get the "alt-password-header" property definition.

Alternate HTTP headers to get the user's password from.

Returns:

Returns the "alt-password-header" property definition.

getAltUsernameHeaderPropertyDefinition

public StringPropertyDefinition getAltUsernameHeaderPropertyDefinition()

Get the "alt-username-header" property definition.

Alternate HTTP headers to get the user's name from.

Returns:

Returns the "alt-username-header" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the HTTP Basic Authorization Mechanism is enabled.

Returns:

Returns the "enabled" property definition.

getIdentityMapperPropertyDefinition

public AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg> getIdentityMapperPropertyDefinition()

Get the "identity-mapper" property definition.

> Specifies the name of the identity mapper used to get the user's entry corresponding to the user-id provided in the HTTP authentication header.

Returns:

Returns the "identity-mapper" 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 Basic Authorization Mechanism implementation.

Returns:

Returns the "java-class" property definition.