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

Interface HttpBasicDnAuthorizationMechanismCfgClient

All Superinterfaces:

ConfigurationClient, HttpAuthorizationMechanismCfgClient

public interface HttpBasicDnAuthorizationMechanismCfgClient
extends HttpAuthorizationMechanismCfgClient

A client-side interface for reading and modifying 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
ManagedObjectDefinition<? extends HttpBasicDnAuthorizationMechanismCfgClient,? extends HttpBasicDnAuthorizationMechanismCfg>	definition()	Get the configuration definition associated with this HTTP Basic DN Authorization Mechanism.
ValueOrExpression<String>	getAltPasswordHeader()	Gets the "alt-password-header" property.
ValueOrExpression<String>	getAltUsernameHeader()	Gets the "alt-username-header" 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	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 HttpBasicDnAuthorizationMechanismCfgClient,? extends HttpBasicDnAuthorizationMechanismCfg> definition()

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

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface HttpAuthorizationMechanismCfgClient

Returns:

Returns the configuration definition associated with this HTTP Basic DN 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.

getJavaClass

@MandatoryProperty
ValueOrExpression<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 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 DN 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.