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 and Description
ManagedObjectDefinition<? extends HTTPAnonymousAuthorizationMechanismCfgClient,? extends HTTPAnonymousAuthorizationMechanismCfg>	definition() Get the configuration definition associated with this HTTP Anonymous Authorization Mechanism.
String	getJavaClass() Gets the "java-class" property.
org.forgerock.opendj.ldap.DN	getUserDN() Gets the "user-dn" property.
void	setJavaClass(String value) Sets the "java-class" property.
void	setUserDN(org.forgerock.opendj.ldap.DN value) Sets the "user-dn" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.HTTPAuthorizationMechanismCfgClient

isEnabled, setEnabled

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

commit, properties

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

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the HTTP Anonymous 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 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

org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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.