Enum GeneratePasswordPolicySelectionType
- java.lang.Object
-
- java.lang.Enum<GeneratePasswordPolicySelectionType>
-
- com.unboundid.ldap.sdk.unboundidds.extensions.GeneratePasswordPolicySelectionType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<GeneratePasswordPolicySelectionType>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum GeneratePasswordPolicySelectionType extends java.lang.Enum<GeneratePasswordPolicySelectionType>
This enum describes the mechanism that the server should use when selecting the password policy to use (for its password generator and validators) while processing aGeneratePasswordExtendedRequest
.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DEFAULT_POLICY
The selection type that indicates that the server should use the default password policy as defined in the configuration.PASSWORD_POLICY_DN
The selection type that indicates that the server should use the password policy that is defined in a specified entry.TARGET_ENTRY_DN
The selection type that indicates that the server should use the password policy that governs a specified entry.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GeneratePasswordPolicySelectionType
forType(byte berType)
Retrieves the password policy selection type with the specified BER type.byte
getBERType()
Retrieves the BER type that will be used to identify this password policy selection type in aGeneratePasswordExtendedRequest
.static GeneratePasswordPolicySelectionType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static GeneratePasswordPolicySelectionType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
DEFAULT_POLICY
public static final GeneratePasswordPolicySelectionType DEFAULT_POLICY
The selection type that indicates that the server should use the default password policy as defined in the configuration.
-
PASSWORD_POLICY_DN
public static final GeneratePasswordPolicySelectionType PASSWORD_POLICY_DN
The selection type that indicates that the server should use the password policy that is defined in a specified entry.
-
TARGET_ENTRY_DN
public static final GeneratePasswordPolicySelectionType TARGET_ENTRY_DN
The selection type that indicates that the server should use the password policy that governs a specified entry.
-
-
Method Detail
-
values
public static GeneratePasswordPolicySelectionType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (GeneratePasswordPolicySelectionType c : GeneratePasswordPolicySelectionType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static GeneratePasswordPolicySelectionType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getBERType
public byte getBERType()
Retrieves the BER type that will be used to identify this password policy selection type in aGeneratePasswordExtendedRequest
.- Returns:
- The BER type that will be used to identify this password policy selection type in a generate password extended request.
-
forType
public static GeneratePasswordPolicySelectionType forType(byte berType)
Retrieves the password policy selection type with the specified BER type.- Parameters:
berType
- The BER type for the password policy selection type to retrieve.- Returns:
- The password policy selection type with the specified BER type,
or
null
if there is no selection type with the provided BER type.
-
-