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

Interface HttpBasicDnAuthorizationMechanismCfg

All Superinterfaces:

Configuration, HttpAuthorizationMechanismCfg

public interface HttpBasicDnAuthorizationMechanismCfg
extends HttpAuthorizationMechanismCfg

A server-side interface for querying HTTP Basic DN Authorization Mechanism settings.

The HTTP Basic DN Authorization Mechanism is used to define static authorization.

Method Summary

Modifier and Type	Method	Description
void	addHttpBasicDnAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpBasicDnAuthorizationMechanismCfg> listener)	Register to be notified when this HTTP Basic DN Authorization Mechanism is changed.
Class<? extends HttpBasicDnAuthorizationMechanismCfg>	configurationClass()	Gets the configuration class associated with this HTTP Basic DN Authorization Mechanism.
String	getAltPasswordHeader()	Gets the "alt-password-header" property.
String	getAltUsernameHeader()	Gets the "alt-username-header" property.
String	getJavaClass()	Gets the "java-class" property.
boolean	isAltAuthenticationEnabled()	Gets the "alt-authentication-enabled" property.
void	removeHttpBasicDnAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpBasicDnAuthorizationMechanismCfg> listener)	Deregister an existing HTTP Basic DN 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 HttpBasicDnAuthorizationMechanismCfg> configurationClass()

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

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface HttpAuthorizationMechanismCfg

Returns:

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

addHttpBasicDnAuthorizationMechanismChangeListener

void addHttpBasicDnAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpBasicDnAuthorizationMechanismCfg> listener)

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

Parameters:

listener - The HTTP Basic DN Authorization Mechanism configuration change listener.

removeHttpBasicDnAuthorizationMechanismChangeListener

void removeHttpBasicDnAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpBasicDnAuthorizationMechanismCfg> listener)

Deregister an existing HTTP Basic DN Authorization Mechanism configuration change listener.

Parameters:

listener - The HTTP Basic DN 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.

Default value: false

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.

Default value is undefined

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.

Default value is undefined

Returns:

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

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

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

Specified by:

getJavaClass in interface HttpAuthorizationMechanismCfg

Returns:

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