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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ManagedObjectDefinition<? extends PasswordGeneratorCfgClient,? extends PasswordGeneratorCfg>
definition()
Get the configuration definition associated with this Password Generator.ValueOrExpression<String>
getJavaClass()
Gets the "java-class" property.ValueOrExpression<Boolean>
isEnabled()
Gets the "enabled" property.void
setEnabled(ValueOrExpression<Boolean> value)
Sets the "enabled" property.void
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.-
Methods inherited from interface org.forgerock.opendj.config.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 interfaceConfigurationClient
- Returns:
- Returns the configuration definition associated with this Password Generator.
-
isEnabled
@MandatoryProperty ValueOrExpression<Boolean> isEnabled()
Gets the "enabled" property.Indicates whether the Password Generator is enabled for use.
- Returns:
- Returns the value of the "enabled" property.
-
setEnabled
@MandatoryProperty void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
Sets the "enabled" property.Indicates whether the Password Generator is enabled for use.
- Parameters:
value
- The value of the "enabled" property.- Throws:
PropertyException
- If the new value is invalid.
-
getJavaClass
@MandatoryProperty ValueOrExpression<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
@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 Generator implementation.
- Parameters:
value
- The value of the "java-class" property.- Throws:
PropertyException
- If the new value is invalid.
-
-