Enum PasswordValidationDetailsResponseType
- java.lang.Object
-
- java.lang.Enum<PasswordValidationDetailsResponseType>
-
- com.unboundid.ldap.sdk.unboundidds.controls.PasswordValidationDetailsResponseType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<PasswordValidationDetailsResponseType>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum PasswordValidationDetailsResponseType extends java.lang.Enum<PasswordValidationDetailsResponseType>
This enum defines the set of response types that can be used in the password validation details response control.
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 MULTIPLE_PASSWORDS_PROVIDED
The response type that indicates that the server was unable to provide validation results because the associated request included multiple passwords.NO_PASSWORD_PROVIDED
The response type that indicates that the server was unable to provide validation results because the associated request did not include any password.NO_VALIDATION_ATTEMPTED
The response type that indicates that the server encountered a problem with the request that caused processing to end before any password validation was attempted.VALIDATION_DETAILS
The response type that indicates that the server was able to perform validation against the proposed password, and that the response includes a set of validation results.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PasswordValidationDetailsResponseType
forBERType(byte berType)
Retrieves the password validation details response type with the specified BER type.static PasswordValidationDetailsResponseType
forName(java.lang.String name)
Retrieves the password validation details response type with the specified name.byte
getBERType()
Retrieves the BER type that will be used for this response type in an encoded password validation details response control.static PasswordValidationDetailsResponseType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static PasswordValidationDetailsResponseType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
VALIDATION_DETAILS
public static final PasswordValidationDetailsResponseType VALIDATION_DETAILS
The response type that indicates that the server was able to perform validation against the proposed password, and that the response includes a set of validation results.
-
NO_PASSWORD_PROVIDED
public static final PasswordValidationDetailsResponseType NO_PASSWORD_PROVIDED
The response type that indicates that the server was unable to provide validation results because the associated request did not include any password.
-
MULTIPLE_PASSWORDS_PROVIDED
public static final PasswordValidationDetailsResponseType MULTIPLE_PASSWORDS_PROVIDED
The response type that indicates that the server was unable to provide validation results because the associated request included multiple passwords.
-
NO_VALIDATION_ATTEMPTED
public static final PasswordValidationDetailsResponseType NO_VALIDATION_ATTEMPTED
The response type that indicates that the server encountered a problem with the request that caused processing to end before any password validation was attempted.
-
-
Method Detail
-
values
public static PasswordValidationDetailsResponseType[] 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 (PasswordValidationDetailsResponseType c : PasswordValidationDetailsResponseType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PasswordValidationDetailsResponseType 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 for this response type in an encoded password validation details response control.- Returns:
- The BER type that will be used for this response type in an encoded password validation details response control.
-
forBERType
@Nullable public static PasswordValidationDetailsResponseType forBERType(byte berType)
Retrieves the password validation details response type with the specified BER type.- Parameters:
berType
- The BER type for the password validation details response type to retrieve.- Returns:
- The password validation details response type with the specified
BER type, or
null
if there is no response type with the specified BER type.
-
forName
@Nullable public static PasswordValidationDetailsResponseType forName(@NotNull java.lang.String name)
Retrieves the password validation details response type with the specified name.- Parameters:
name
- The name of the password validation details response type to retrieve. It must not benull
.- Returns:
- The requested password validation details response type, or
null
if no such type is defined.
-
-