Class PasswordPolicyStateAccountUsabilityWarning
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.extensions.PasswordPolicyStateAccountUsabilityWarning
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordPolicyStateAccountUsabilityWarning extends java.lang.Object implements java.io.Serializable
This class defines a data structure that will provide information about warnings that may affect an account's usability. It includes a number of predefined warning types, but also allows for the possibility of additional warning types that have not been defined.
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.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
WARNING_NAME_ACCOUNT_EXPIRING
The name for the warning type that indicates the user's account is about to expire.static java.lang.String
WARNING_NAME_ACCOUNT_IDLE
The name for the warning type that indicates the user has not authenticated in some time, and the account may be locked in the near future if it remains idle.static java.lang.String
WARNING_NAME_DEPRECATED_PASSWORD_STORAGE_SCHEME
The numeric value for the warning type that indicates that the user's account has a password that is encoded with a deprecated password storage scheme.static java.lang.String
WARNING_NAME_OUTSTANDING_BIND_FAILURES
The name for the warning type that indicates the user has one or more failed authentication attempts since the last successful bind, and that the account may be locked if there are too many more failures.static java.lang.String
WARNING_NAME_PASSWORD_EXPIRING
The name for the warning type that indicates the user's password is about to expire.static java.lang.String
WARNING_NAME_REQUIRE_PASSWORD_CHANGE_BY_TIME
The name for the warning type that indicates the user user will be required to change his/her password by a specific time because the password policy requires all users to change their passwords by that time.static java.lang.String
WARNING_NAME_TOO_MANY_OUTSTANDING_BIND_FAILURES
The name for the warning type that indicates that although the user's account should be locked as a result of too many outstanding failed authentication attempts, their password policy is configured with a failure lockout action that will not prevent them from authenticating (although it may still have an effect on their account's usability).static int
WARNING_TYPE_ACCOUNT_EXPIRING
The numeric value for the warning type that indicates the user's account is about to expire.static int
WARNING_TYPE_ACCOUNT_IDLE
The numeric value for the warning type that indicates the user has not authenticated in some time, and the account may be locked in the near future if it remains idle.static int
WARNING_TYPE_DEPRECATED_PASSWORD_STORAGE_SCHEME
The numeric value for the warning type that indicates that the user's account has a password that is encoded with a deprecated password storage scheme.static int
WARNING_TYPE_OUTSTANDING_BIND_FAILURES
The numeric value for the warning type that indicates the user has one or more failed authentication attempts since the last successful bind, and that the account may be locked if there are too many more failures.static int
WARNING_TYPE_PASSWORD_EXPIRING
The numeric value for the warning type that indicates the user's password is about to expire.static int
WARNING_TYPE_REQUIRE_PASSWORD_CHANGE_BY_TIME
The numeric value for the warning type that indicates the user will be required to change his/her password by a specific time because the password policy requires all users to change their passwords by that time.static int
WARNING_TYPE_TOO_MANY_OUTSTANDING_BIND_FAILURES
The numeric value for the warning type that indicates that although the user's account should be locked as a result of too many outstanding failed authentication attempts, their password policy is configured with a failure lockout action that will not prevent them from authenticating (although it may still have an effect on their account's usability).
-
Constructor Summary
Constructors Constructor Description PasswordPolicyStateAccountUsabilityWarning(int intValue, java.lang.String name, java.lang.String message)
Creates a new account usability warning with the provided information.PasswordPolicyStateAccountUsabilityWarning(java.lang.String stringRepresentation)
Creates a new account usability warning that is decoded from the provided string representation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getIntValue()
Retrieves the integer value for this account usability warning.java.lang.String
getMessage()
Retrieves a human-readable message that provides specific details about this account usability warning.java.lang.String
getName()
Retrieves the name for this account usability warning.java.lang.String
toString()
Retrieves a string representation of this account usability warning.
-
-
-
Field Detail
-
WARNING_TYPE_ACCOUNT_EXPIRING
public static final int WARNING_TYPE_ACCOUNT_EXPIRING
The numeric value for the warning type that indicates the user's account is about to expire.- See Also:
- Constant Field Values
-
WARNING_NAME_ACCOUNT_EXPIRING
@NotNull public static final java.lang.String WARNING_NAME_ACCOUNT_EXPIRING
The name for the warning type that indicates the user's account is about to expire.- See Also:
- Constant Field Values
-
WARNING_TYPE_PASSWORD_EXPIRING
public static final int WARNING_TYPE_PASSWORD_EXPIRING
The numeric value for the warning type that indicates the user's password is about to expire.- See Also:
- Constant Field Values
-
WARNING_NAME_PASSWORD_EXPIRING
@NotNull public static final java.lang.String WARNING_NAME_PASSWORD_EXPIRING
The name for the warning type that indicates the user's password is about to expire.- See Also:
- Constant Field Values
-
WARNING_TYPE_OUTSTANDING_BIND_FAILURES
public static final int WARNING_TYPE_OUTSTANDING_BIND_FAILURES
The numeric value for the warning type that indicates the user has one or more failed authentication attempts since the last successful bind, and that the account may be locked if there are too many more failures.- See Also:
- Constant Field Values
-
WARNING_NAME_OUTSTANDING_BIND_FAILURES
@NotNull public static final java.lang.String WARNING_NAME_OUTSTANDING_BIND_FAILURES
The name for the warning type that indicates the user has one or more failed authentication attempts since the last successful bind, and that the account may be locked if there are too many more failures.- See Also:
- Constant Field Values
-
WARNING_TYPE_ACCOUNT_IDLE
public static final int WARNING_TYPE_ACCOUNT_IDLE
The numeric value for the warning type that indicates the user has not authenticated in some time, and the account may be locked in the near future if it remains idle.- See Also:
- Constant Field Values
-
WARNING_NAME_ACCOUNT_IDLE
@NotNull public static final java.lang.String WARNING_NAME_ACCOUNT_IDLE
The name for the warning type that indicates the user has not authenticated in some time, and the account may be locked in the near future if it remains idle.- See Also:
- Constant Field Values
-
WARNING_TYPE_REQUIRE_PASSWORD_CHANGE_BY_TIME
public static final int WARNING_TYPE_REQUIRE_PASSWORD_CHANGE_BY_TIME
The numeric value for the warning type that indicates the user will be required to change his/her password by a specific time because the password policy requires all users to change their passwords by that time.- See Also:
- Constant Field Values
-
WARNING_NAME_REQUIRE_PASSWORD_CHANGE_BY_TIME
@NotNull public static final java.lang.String WARNING_NAME_REQUIRE_PASSWORD_CHANGE_BY_TIME
The name for the warning type that indicates the user user will be required to change his/her password by a specific time because the password policy requires all users to change their passwords by that time.- See Also:
- Constant Field Values
-
WARNING_TYPE_TOO_MANY_OUTSTANDING_BIND_FAILURES
public static final int WARNING_TYPE_TOO_MANY_OUTSTANDING_BIND_FAILURES
The numeric value for the warning type that indicates that although the user's account should be locked as a result of too many outstanding failed authentication attempts, their password policy is configured with a failure lockout action that will not prevent them from authenticating (although it may still have an effect on their account's usability).- See Also:
- Constant Field Values
-
WARNING_NAME_TOO_MANY_OUTSTANDING_BIND_FAILURES
@NotNull public static final java.lang.String WARNING_NAME_TOO_MANY_OUTSTANDING_BIND_FAILURES
The name for the warning type that indicates that although the user's account should be locked as a result of too many outstanding failed authentication attempts, their password policy is configured with a failure lockout action that will not prevent them from authenticating (although it may still have an effect on their account's usability).- See Also:
- Constant Field Values
-
WARNING_TYPE_DEPRECATED_PASSWORD_STORAGE_SCHEME
public static final int WARNING_TYPE_DEPRECATED_PASSWORD_STORAGE_SCHEME
The numeric value for the warning type that indicates that the user's account has a password that is encoded with a deprecated password storage scheme.- See Also:
- Constant Field Values
-
WARNING_NAME_DEPRECATED_PASSWORD_STORAGE_SCHEME
@NotNull public static final java.lang.String WARNING_NAME_DEPRECATED_PASSWORD_STORAGE_SCHEME
The numeric value for the warning type that indicates that the user's account has a password that is encoded with a deprecated password storage scheme.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PasswordPolicyStateAccountUsabilityWarning
public PasswordPolicyStateAccountUsabilityWarning(int intValue, @NotNull java.lang.String name, @Nullable java.lang.String message)
Creates a new account usability warning with the provided information.- Parameters:
intValue
- The integer value for this account usability warning.name
- The name for this account usability warning. It must not benull
.message
- A human-readable message that provides specific details about this account usability warning. It may benull
if no message is available.
-
PasswordPolicyStateAccountUsabilityWarning
public PasswordPolicyStateAccountUsabilityWarning(@NotNull java.lang.String stringRepresentation) throws LDAPException
Creates a new account usability warning that is decoded from the provided string representation.- Parameters:
stringRepresentation
- The string representation of the account usability warning to decode. It must not benull
.- Throws:
LDAPException
- If the provided string cannot be decoded as a valid account usability warning.
-
-
Method Detail
-
getIntValue
public int getIntValue()
Retrieves the integer value for this account usability warning.- Returns:
- The integer value for this account usability warning.
-
getName
@NotNull public java.lang.String getName()
Retrieves the name for this account usability warning.- Returns:
- The name for this account usability warning.
-
getMessage
@Nullable public java.lang.String getMessage()
Retrieves a human-readable message that provides specific details about this account usability warning.- Returns:
- A human-readable message that provides specific details about this
account usability warning, or
null
if no message is available.
-
-