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

Interface HttpAnonymousAuthorizationMechanismCfgClient

All Superinterfaces:

ConfigurationClient, HttpAuthorizationMechanismCfgClient

public interface HttpAnonymousAuthorizationMechanismCfgClient
extends HttpAuthorizationMechanismCfgClient

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

The HTTP Anonymous Authorization Mechanism is used to define static authorization.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends HttpAnonymousAuthorizationMechanismCfgClient,? extends HttpAnonymousAuthorizationMechanismCfg>	definition()	Get the configuration definition associated with this HTTP Anonymous Authorization Mechanism.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Dn>	getUserDn()	Gets the "user-dn" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setUserDn(ValueOrExpression<Dn> value)	Sets the "user-dn" 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 HttpAnonymousAuthorizationMechanismCfgClient,? extends HttpAnonymousAuthorizationMechanismCfg> definition()

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

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface HttpAuthorizationMechanismCfgClient

Returns:

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

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

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

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

getUserDn

ValueOrExpression<Dn> getUserDn()

Gets the "user-dn" property.

The authorization DN which will be used for performing anonymous operations.

Returns:

Returns the value of the "user-dn" property.

setUserDn

void setUserDn(ValueOrExpression<Dn> value)
        throws PropertyException

Sets the "user-dn" property.

The authorization DN which will be used for performing anonymous operations.

Parameters:

value - The value of the "user-dn" property.

Throws:

PropertyException - If the new value is invalid.