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

Interface PasswordModifyExtendedOperationHandlerCfgClient

All Superinterfaces:

ConfigurationClient, ExtendedOperationHandlerCfgClient

public interface PasswordModifyExtendedOperationHandlerCfgClient
extends ExtendedOperationHandlerCfgClient

A client-side interface for reading and modifying Password Modify Extended Operation Handler settings.

The Password Modify Extended Operation Handler allows end users to change their own passwords, or administrators to reset user passwords.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends PasswordModifyExtendedOperationHandlerCfgClient,? extends PasswordModifyExtendedOperationHandlerCfg>	definition()	Get the configuration definition associated with this Password Modify Extended Operation Handler.
SortedSet<ValueOrExpression<String>>	getIdentityMapper()	Gets the "identity-mapper" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setIdentityMapper(Collection<ValueOrExpression<String>> values)	Sets the "identity-mapper" 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 PasswordModifyExtendedOperationHandlerCfgClient,? extends PasswordModifyExtendedOperationHandlerCfg> definition()

Get the configuration definition associated with this Password Modify Extended Operation Handler.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface ExtendedOperationHandlerCfgClient

Returns:

Returns the configuration definition associated with this Password Modify Extended Operation Handler.

getIdentityMapper

@MandatoryProperty
SortedSet<ValueOrExpression<String>> getIdentityMapper()

Gets the "identity-mapper" property.

Specifies the name(s) of the identity mapper(s) that should be used in conjunction with the password modify extended operation.

This property is used to identify a user based on an authorization ID in the 'u:' form. Changes to this property take effect immediately.

Returns:

Returns the values of the "identity-mapper" property.

setIdentityMapper

@MandatoryProperty
void setIdentityMapper(Collection<ValueOrExpression<String>> values)
                throws PropertyException

Sets the "identity-mapper" property.

Specifies the name(s) of the identity mapper(s) that should be used in conjunction with the password modify extended operation.

This property is used to identify a user based on an authorization ID in the 'u:' form. Changes to this property take effect immediately.

Parameters:

values - The values of the "identity-mapper" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Password Modify Extended Operation Handler implementation.

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

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 Password Modify 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.