Package org.forgerock.opendj.server.config.client

Interface HttpBasicAuthorizationMechanismCfgClient

All Superinterfaces:

ConfigurationClient, HttpAuthorizationMechanismCfgClient

public interface HttpBasicAuthorizationMechanismCfgClient
extends HttpAuthorizationMechanismCfgClient

A client-side interface for reading and modifying HTTP Basic Authorization Mechanism settings.

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
ManagedObjectDefinition<? extends HttpBasicAuthorizationMechanismCfgClient,? extends HttpBasicAuthorizationMechanismCfg>	definition()	Get the configuration definition associated with this HTTP Basic Authorization Mechanism.
ValueOrExpression<String>	getAltPasswordHeader()	Gets the "alt-password-header" property.
ValueOrExpression<String>	getAltUsernameHeader()	Gets the "alt-username-header" property.
SortedSet<ValueOrExpression<String>>	getIdentityMapper()	Gets the "identity-mapper" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isAltAuthenticationEnabled()	Gets the "alt-authentication-enabled" property.
void	setAltAuthenticationEnabled(ValueOrExpression<Boolean> value)	Sets the "alt-authentication-enabled" property.
void	setAltPasswordHeader(ValueOrExpression<String> value)	Sets the "alt-password-header" property.
void	setAltUsernameHeader(ValueOrExpression<String> value)	Sets the "alt-username-header" property.
void	setIdentityMapper(Collection<ValueOrExpression<String>> values)	Sets the "identity-mapper" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.HttpAuthorizationMechanismCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends HttpBasicAuthorizationMechanismCfgClient,? extends HttpBasicAuthorizationMechanismCfg> definition()

Get the configuration definition associated with this HTTP Basic Authorization Mechanism.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface HttpAuthorizationMechanismCfgClient

Returns:

Returns the configuration definition associated with this HTTP Basic Authorization Mechanism.

isAltAuthenticationEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isAltAuthenticationEnabled()

Gets the "alt-authentication-enabled" property.

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

Default value: false

Returns:

Returns the value of the "alt-authentication-enabled" property.

setAltAuthenticationEnabled

@MandatoryProperty
void setAltAuthenticationEnabled(ValueOrExpression<Boolean> value)
                          throws PropertyException

Sets the "alt-authentication-enabled" property.

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

Parameters:

value - The value of the "alt-authentication-enabled" property.

Throws:

PropertyException - If the new value is invalid.

getAltPasswordHeader

ValueOrExpression<String> getAltPasswordHeader()

Gets the "alt-password-header" property.

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

Default value is undefined

Returns:

Returns the value of the "alt-password-header" property.

setAltPasswordHeader

void setAltPasswordHeader(ValueOrExpression<String> value)
                   throws PropertyException

Sets the "alt-password-header" property.

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

Parameters:

value - The value of the "alt-password-header" property.

Throws:

PropertyException - If the new value is invalid.

getAltUsernameHeader

ValueOrExpression<String> getAltUsernameHeader()

Gets the "alt-username-header" property.

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

Default value is undefined

Returns:

Returns the value of the "alt-username-header" property.

setAltUsernameHeader

void setAltUsernameHeader(ValueOrExpression<String> value)
                   throws PropertyException

Sets the "alt-username-header" property.

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

Parameters:

value - The value of the "alt-username-header" property.

Throws:

PropertyException - If the new value is invalid.

getIdentityMapper

@MandatoryProperty
SortedSet<ValueOrExpression<String>> getIdentityMapper()

Gets the "identity-mapper" property.

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

Returns:

Returns the values of the "identity-mapper" property.

setIdentityMapper

@MandatoryProperty
void setIdentityMapper(Collection<ValueOrExpression<String>> values)
                throws PropertyException

Sets the "identity-mapper" property.

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

Parameters:

values - The values of the "identity-mapper" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the HTTP Basic Authorization Mechanism implementation.

Default value: org.opends.server.protocols.http.authz.HttpBasicAuthorizationMechanism

Specified by:

getJavaClass in interface HttpAuthorizationMechanismCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the HTTP Basic Authorization Mechanism implementation.

Specified by:

setJavaClass in interface HttpAuthorizationMechanismCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.