org.opends.server.admin.std.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
 ManagedObjectDefinition<? extends PasswordModifyExtendedOperationHandlerCfgClient,? extends PasswordModifyExtendedOperationHandlerCfg> definition()
          Get the configuration definition associated with this Password Modify Extended Operation Handler.
 java.lang.String getIdentityMapper()
          Gets the "identity-mapper" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 void setIdentityMapper(java.lang.String value)
          Sets the "identity-mapper" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.std.client.ExtendedOperationHandlerCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

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

java.lang.String getIdentityMapper()
Gets the "identity-mapper" property.

Specifies the name of the identity mapper 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 value of the "identity-mapper" property.

setIdentityMapper

void setIdentityMapper(java.lang.String value)
                       throws IllegalPropertyValueException
Sets the "identity-mapper" property.

Specifies the name of the identity mapper 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:
value - The value of the "identity-mapper" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.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.

Specified by:
getJavaClass in interface ExtendedOperationHandlerCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.