Package com.unboundid.ldap.sdk.unboundidds.extensions

Enum GeneratePasswordPolicySelectionType

java.lang.Object

java.lang.Enum<GeneratePasswordPolicySelectionType>

com.unboundid.ldap.sdk.unboundidds.extensions.GeneratePasswordPolicySelectionType

All Implemented Interfaces:

Serializable, Comparable<GeneratePasswordPolicySelectionType>, java.lang.constant.Constable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum GeneratePasswordPolicySelectionType
extends 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 a GeneratePasswordExtendedRequest.

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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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

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 a GeneratePasswordExtendedRequest.
static GeneratePasswordPolicySelectionType	valueOf(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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static GeneratePasswordPolicySelectionType[] values()

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

Returns:

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

valueOf

public static GeneratePasswordPolicySelectionType valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

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 a GeneratePasswordExtendedRequest.

Returns:

The BER type that will be used to identify this password policy selection type in a generate password extended request.

forType

@Nullable
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.