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.
String	getAltPasswordHeader()	Gets the "alt-password-header" property.
String	getAltUsernameHeader()	Gets the "alt-username-header" property.
String	getIdentityMapper()	Gets the "identity-mapper" property.
String	getJavaClass()	Gets the "java-class" property.
boolean	isAltAuthenticationEnabled()	Gets the "alt-authentication-enabled" property.
void	setAltAuthenticationEnabled(boolean value)	Sets the "alt-authentication-enabled" property.
void	setAltPasswordHeader(String value)	Sets the "alt-password-header" property.
void	setAltUsernameHeader(String value)	Sets the "alt-username-header" property.
void	setIdentityMapper(String value)	Sets the "identity-mapper" property.
void	setJavaClass(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

boolean isAltAuthenticationEnabled()

Gets the "alt-authentication-enabled" property.

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

Returns:

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

setAltAuthenticationEnabled

void setAltAuthenticationEnabled(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

String getAltPasswordHeader()

Gets the "alt-password-header" property.

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

Returns:

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

setAltPasswordHeader

void setAltPasswordHeader(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

String getAltUsernameHeader()

Gets the "alt-username-header" property.

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

Returns:

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

setAltUsernameHeader

void setAltUsernameHeader(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

String getIdentityMapper()

Gets the "identity-mapper" property.

> 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 value of the "identity-mapper" property.

setIdentityMapper

void setIdentityMapper(String value)
                throws PropertyException

Sets the "identity-mapper" property.

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface HTTPAuthorizationMechanismCfgClient

Returns:

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

setJavaClass

void setJavaClass(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.