Interface RandomPasswordGeneratorCfgClient
-
- All Superinterfaces:
ConfigurationClient
,PasswordGeneratorCfgClient
public interface RandomPasswordGeneratorCfgClient extends PasswordGeneratorCfgClient
A client-side interface for reading and modifying Random Password Generator settings.The Random Password Generator creates random passwords based on fixed-length strings built from one or more character sets.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ManagedObjectDefinition<? extends RandomPasswordGeneratorCfgClient,? extends RandomPasswordGeneratorCfg>
definition()
Get the configuration definition associated with this Random Password Generator.ValueOrExpression<String>
getJavaClass()
Gets the "java-class" property.SortedSet<ValueOrExpression<String>>
getPasswordCharacterSet()
Gets the "password-character-set" property.ValueOrExpression<String>
getPasswordFormat()
Gets the "password-format" property.void
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.void
setPasswordCharacterSet(Collection<ValueOrExpression<String>> values)
Sets the "password-character-set" property.void
setPasswordFormat(ValueOrExpression<String> value)
Sets the "password-format" property.-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
Methods inherited from interface org.forgerock.opendj.server.config.client.PasswordGeneratorCfgClient
isEnabled, setEnabled
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends RandomPasswordGeneratorCfgClient,? extends RandomPasswordGeneratorCfg> definition()
Get the configuration definition associated with this Random Password Generator.- Specified by:
definition
in interfaceConfigurationClient
- Specified by:
definition
in interfacePasswordGeneratorCfgClient
- Returns:
- Returns the configuration definition associated with this Random Password Generator.
-
getJavaClass
@MandatoryProperty ValueOrExpression<String> getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the Random Password Generator implementation.
Default value:
org.opends.server.extensions.RandomPasswordGenerator
- Specified by:
getJavaClass
in interfacePasswordGeneratorCfgClient
- 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 Random Password Generator implementation.
- Specified by:
setJavaClass
in interfacePasswordGeneratorCfgClient
- Parameters:
value
- The value of the "java-class" property.- Throws:
PropertyException
- If the new value is invalid.
-
getPasswordCharacterSet
@MandatoryProperty SortedSet<ValueOrExpression<String>> getPasswordCharacterSet()
Gets the "password-character-set" property.Specifies one or more named character sets.
This is a multi-valued property, with each value defining a different character set. The format of the character set is the name of the set followed by a colon and the characters that are in that set. For example, the value "alpha:abcdefghijklmnopqrstuvwxyz" defines a character set named "alpha" containing all of the lower-case ASCII alphabetic characters.
- Returns:
- Returns the values of the "password-character-set" property.
-
setPasswordCharacterSet
@MandatoryProperty void setPasswordCharacterSet(Collection<ValueOrExpression<String>> values) throws PropertyException
Sets the "password-character-set" property.Specifies one or more named character sets.
This is a multi-valued property, with each value defining a different character set. The format of the character set is the name of the set followed by a colon and the characters that are in that set. For example, the value "alpha:abcdefghijklmnopqrstuvwxyz" defines a character set named "alpha" containing all of the lower-case ASCII alphabetic characters.
- Parameters:
values
- The values of the "password-character-set" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getPasswordFormat
@MandatoryProperty ValueOrExpression<String> getPasswordFormat()
Gets the "password-format" property.Specifies the format to use for the generated password.
The value is a comma-delimited list of elements in which each of those elements is comprised of the name of a character set defined in the password-character-set property, a colon, and the number of characters to include from that set. For example, a value of "alpha:3,numeric:2,alpha:3" generates an 8-character password in which the first three characters are from the "alpha" set, the next two are from the "numeric" set, and the final three are from the "alpha" set.
- Returns:
- Returns the value of the "password-format" property.
-
setPasswordFormat
@MandatoryProperty void setPasswordFormat(ValueOrExpression<String> value) throws PropertyException
Sets the "password-format" property.Specifies the format to use for the generated password.
The value is a comma-delimited list of elements in which each of those elements is comprised of the name of a character set defined in the password-character-set property, a colon, and the number of characters to include from that set. For example, a value of "alpha:3,numeric:2,alpha:3" generates an 8-character password in which the first three characters are from the "alpha" set, the next two are from the "numeric" set, and the final three are from the "alpha" set.
- Parameters:
value
- The value of the "password-format" property.- Throws:
PropertyException
- If the new value is invalid.
-
-