com.unboundid.ldap.sdk.unboundidds.extensions

Enum GetPasswordQualityRequirementsTargetType

java.lang.Object

java.lang.Enum<GetPasswordQualityRequirementsTargetType>

com.unboundid.ldap.sdk.unboundidds.extensions.GetPasswordQualityRequirementsTargetType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GetPasswordQualityRequirementsTargetType>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum GetPasswordQualityRequirementsTargetType
extends java.lang.Enum<GetPasswordQualityRequirementsTargetType>

This enum specifies the modes in which the get password quality requirements extended operation may determine the type of password update operation that will be performed and the way in which the server should determine which password policy to use in order to obtain the password quality requirements.

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 and Description
ADD_WITH_DEFAULT_PASSWORD_POLICY Indicates that the Directory Server should return the password quality requirements that the server's default password policy will impose for an add operation.
ADD_WITH_SPECIFIED_PASSWORD_POLICY Indicates that the Directory Server should return the password quality requirements that the server will impose for an add operation for an entry governed by a specific password policy.
ADMINISTRATIVE_RESET_FOR_SPECIFIED_USER Indicates that the Directory Server should return the password quality requirements that the server will impose for an administrative password reset for a specific user, identified by DN.
SELF_CHANGE_FOR_AUTHORIZATION_IDENTITY Indicates that the Directory Server should return the password quality requirements that the server will impose for a self password change for the authorization identity used for the get password quality requirements extended request.
SELF_CHANGE_FOR_SPECIFIED_USER Indicates that the Directory Server should return the password quality requirements that the server will impose for a self password change for a specific user, identified by DN.

Method Summary

Modifier and Type	Method and Description
static GetPasswordQualityRequirementsTargetType	forBERType(byte berType) Retrieves the get password quality requirements target type with the specified BER type.
static GetPasswordQualityRequirementsTargetType	forName(java.lang.String name) Retrieves the get password quality requirements target type with the specified name.
byte	getBERType() Retrieves the BER type that will be used for this target type in an encoded get password quality requirements extended request.
static GetPasswordQualityRequirementsTargetType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GetPasswordQualityRequirementsTargetType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADD_WITH_DEFAULT_PASSWORD_POLICY

public static final GetPasswordQualityRequirementsTargetType ADD_WITH_DEFAULT_PASSWORD_POLICY

Indicates that the Directory Server should return the password quality requirements that the server's default password policy will impose for an add operation.

ADD_WITH_SPECIFIED_PASSWORD_POLICY

public static final GetPasswordQualityRequirementsTargetType ADD_WITH_SPECIFIED_PASSWORD_POLICY

Indicates that the Directory Server should return the password quality requirements that the server will impose for an add operation for an entry governed by a specific password policy. The password policy will be identified by the DN of the entry containing the password policy definition.

SELF_CHANGE_FOR_AUTHORIZATION_IDENTITY

public static final GetPasswordQualityRequirementsTargetType SELF_CHANGE_FOR_AUTHORIZATION_IDENTITY

Indicates that the Directory Server should return the password quality requirements that the server will impose for a self password change for the authorization identity used for the get password quality requirements extended request.

SELF_CHANGE_FOR_SPECIFIED_USER

public static final GetPasswordQualityRequirementsTargetType SELF_CHANGE_FOR_SPECIFIED_USER

Indicates that the Directory Server should return the password quality requirements that the server will impose for a self password change for a specific user, identified by DN.

ADMINISTRATIVE_RESET_FOR_SPECIFIED_USER

public static final GetPasswordQualityRequirementsTargetType ADMINISTRATIVE_RESET_FOR_SPECIFIED_USER

Indicates that the Directory Server should return the password quality requirements that the server will impose for an administrative password reset for a specific user, identified by DN.

Method Detail

values

public static GetPasswordQualityRequirementsTargetType[] 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 (GetPasswordQualityRequirementsTargetType c : GetPasswordQualityRequirementsTargetType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GetPasswordQualityRequirementsTargetType 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 name

java.lang.NullPointerException - if the argument is null

getBERType

public byte getBERType()

Retrieves the BER type that will be used for this target type in an encoded get password quality requirements extended request.

Returns:

The BER type that will be used for this target type in an encoded get password quality requirements extended request.

forBERType

@Nullable
public static GetPasswordQualityRequirementsTargetType forBERType(byte berType)

Retrieves the get password quality requirements target type with the specified BER type.

Parameters:

berType - The BER type for the target type to retrieve.

Returns:

The get password quality requirements target type with the specified BER type, or null if there is no target type with the specified BER type.

forName

@Nullable
public static GetPasswordQualityRequirementsTargetType forName(@NotNull
                                                                         java.lang.String name)

Retrieves the get password quality requirements target type with the specified name.

Parameters:

name - The name of the get password quality requirements target type to retrieve. It must not be null.

Returns:

The requested get password quality requirements target type, or null if no such type is defined.