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

Interface WhoAmIExtendedOperationHandlerCfgClient

All Superinterfaces:

ConfigurationClient, ExtendedOperationHandlerCfgClient

public interface WhoAmIExtendedOperationHandlerCfgClient
extends ExtendedOperationHandlerCfgClient

A client-side interface for reading and modifying Who Am I Extended Operation Handler settings.

The Who Am I Extended Operation Handler provides the ability for clients to request their authorization identity using the "Who Am I?" extended operation as defined in RFC 4532.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends WhoAmIExtendedOperationHandlerCfgClient,? extends WhoAmIExtendedOperationHandlerCfg>	definition()	Get the configuration definition associated with this Who Am I Extended Operation Handler.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" 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.ExtendedOperationHandlerCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends WhoAmIExtendedOperationHandlerCfgClient,? extends WhoAmIExtendedOperationHandlerCfg> definition()

Get the configuration definition associated with this Who Am I Extended Operation Handler.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface ExtendedOperationHandlerCfgClient

Returns:

Returns the configuration definition associated with this Who Am I Extended Operation Handler.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Who Am I Extended Operation Handler implementation.

Default value: org.opends.server.extensions.WhoAmIExtendedOperation

Specified by:

getJavaClass in interface ExtendedOperationHandlerCfgClient

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 Who Am I Extended Operation Handler implementation.

Specified by:

setJavaClass in interface ExtendedOperationHandlerCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.