Interface RandomPasswordGeneratorCfg
-
- All Superinterfaces:
Configuration
,PasswordGeneratorCfg
public interface RandomPasswordGeneratorCfg extends PasswordGeneratorCfg
A server-side interface for querying 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 void
addRandomChangeListener(ConfigurationChangeListener<RandomPasswordGeneratorCfg> listener)
Register to be notified when this Random Password Generator is changed.Class<? extends RandomPasswordGeneratorCfg>
configurationClass()
Gets the configuration class associated with this Random Password Generator.String
getJavaClass()
Gets the "java-class" property.SortedSet<String>
getPasswordCharacterSet()
Gets the "password-character-set" property.String
getPasswordFormat()
Gets the "password-format" property.void
removeRandomChangeListener(ConfigurationChangeListener<RandomPasswordGeneratorCfg> listener)
Deregister an existing Random Password Generator configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.PasswordGeneratorCfg
addChangeListener, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends RandomPasswordGeneratorCfg> configurationClass()
Gets the configuration class associated with this Random Password Generator.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfacePasswordGeneratorCfg
- Returns:
- Returns the configuration class associated with this Random Password Generator.
-
addRandomChangeListener
void addRandomChangeListener(ConfigurationChangeListener<RandomPasswordGeneratorCfg> listener)
Register to be notified when this Random Password Generator is changed.- Parameters:
listener
- The Random Password Generator configuration change listener.
-
removeRandomChangeListener
void removeRandomChangeListener(ConfigurationChangeListener<RandomPasswordGeneratorCfg> listener)
Deregister an existing Random Password Generator configuration change listener.- Parameters:
listener
- The Random Password Generator configuration change listener.
-
getJavaClass
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 interfacePasswordGeneratorCfg
- Returns:
- Returns the value of the "java-class" property.
-
getPasswordCharacterSet
SortedSet<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 an unmodifiable set containing the values of the "password-character-set" property.
-
getPasswordFormat
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.
-
-