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

Interface HTTPBasicAuthorizationMechanismCfg

All Superinterfaces:

Configuration, HTTPAuthorizationMechanismCfg

public interface HTTPBasicAuthorizationMechanismCfg
extends HTTPAuthorizationMechanismCfg

A server-side interface for querying 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
void	addHTTPBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPBasicAuthorizationMechanismCfg> listener)	Register to be notified when this HTTP Basic Authorization Mechanism is changed.
Class<? extends HTTPBasicAuthorizationMechanismCfg>	configurationClass()	Gets the configuration class 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.
org.forgerock.opendj.ldap.DN	getIdentityMapperDN()	Gets the "identity-mapper" property as a DN.
String	getJavaClass()	Gets the "java-class" property.
boolean	isAltAuthenticationEnabled()	Gets the "alt-authentication-enabled" property.
void	removeHTTPBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPBasicAuthorizationMechanismCfg> listener)	Deregister an existing HTTP Basic Authorization Mechanism configuration change listener.

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

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.HTTPAuthorizationMechanismCfg

addChangeListener, isEnabled, removeChangeListener

Method Detail

configurationClass

Class<? extends HTTPBasicAuthorizationMechanismCfg> configurationClass()

Gets the configuration class associated with this HTTP Basic Authorization Mechanism.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface HTTPAuthorizationMechanismCfg

Returns:

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

addHTTPBasicAuthorizationMechanismChangeListener

void addHTTPBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPBasicAuthorizationMechanismCfg> listener)

Register to be notified when this HTTP Basic Authorization Mechanism is changed.

Parameters:

listener - The HTTP Basic Authorization Mechanism configuration change listener.

removeHTTPBasicAuthorizationMechanismChangeListener

void removeHTTPBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPBasicAuthorizationMechanismCfg> listener)

Deregister an existing HTTP Basic Authorization Mechanism configuration change listener.

Parameters:

listener - The HTTP Basic Authorization Mechanism configuration change listener.

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.

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.

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.

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.

getIdentityMapperDN

org.forgerock.opendj.ldap.DN getIdentityMapperDN()

Gets the "identity-mapper" property as a DN.

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

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 HTTPAuthorizationMechanismCfg

Returns:

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