org.opends.server.admin.std.client
Interface PasswordGeneratorCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
RandomPasswordGeneratorCfgClient

public interface PasswordGeneratorCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Password Generator settings.

Password Generators are used by the password modify extended operation to construct a new password for the user.


Method Summary
 ManagedObjectDefinition<? extends PasswordGeneratorCfgClient,? extends PasswordGeneratorCfg> definition()
          Get the configuration definition associated with this Password Generator.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends PasswordGeneratorCfgClient,? extends PasswordGeneratorCfg> definition()
Get the configuration definition associated with this Password Generator.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Password Generator.

isEnabled

java.lang.Boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Password Generator is enabled for use.

Returns:
Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets the "enabled" property.

Indicates whether the Password Generator is enabled for use.

Parameters:
value - The value of the "enabled" 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 Generator implementation.

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 Generator implementation.

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.