com.unboundid.directory.sdk.ds.types
Enum AccountStatusNotificationType

java.lang.Object
  java.lang.Enum<AccountStatusNotificationType>
      com.unboundid.directory.sdk.ds.types.AccountStatusNotificationType

All Implemented Interfaces:

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

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

This class implements an enumeration that holds the possible event types that can trigger an account status notification.

Enum Constant Summary

ACCOUNT_DISABLED
Indicates that an account status message should be generated whenever a user account has been disabled by an administrator.

ACCOUNT_ENABLED
Indicates that an account status message should be generated whenever a user account has been enabled by an administrator.

ACCOUNT_EXPIRED
Indicates that an account status message should be generated whenever a user authentication has failed because the account has expired.

ACCOUNT_IDLE_LOCKED
Indicates that an account status message should be generated whenever a user account has been locked because it was idle for too long.

ACCOUNT_PERMANENTLY_LOCKED
Indicates that an account status message should be generated whenever a user account has been permanently locked (requiring an administrative password reset) after too many failed attempts.

ACCOUNT_RESET_LOCKED
Indicates that an account status message should be generated whenever a user account has been locked because it the password had been reset by an administrator but not changed by the user within the required interval.

ACCOUNT_TEMPORARILY_LOCKED
Indicates that an account status message should be generated whenever a user account has been temporarily locked after too many failed attempts.

ACCOUNT_UNLOCKED
Indicates that an account status message should be generated whenever a user account has been unlocked by an administrator.

PASSWORD_CHANGED
Indicates whether an account status notification message should be generated whenever a user changes his/her own password.

PASSWORD_EXPIRED
Indicates that an account status notification message should be generated whenever a user authentication has failed because the password has expired.

PASSWORD_EXPIRING
Indicates that an account status notification message should be generated the first time that a password expiration warning is encountered for a user password.

PASSWORD_RESET
Indicates that an account status notification message should be generated whenever a user's password is reset by an administrator.

Method Summary

java.lang.String	getName() Retrieves the name for this account status notification type.
java.lang.String	toString() Retrieves a string representation of this account status notification type.
static AccountStatusNotificationType	typeForName(java.lang.String name) Retrieves the account status notification type with the specified name.
static AccountStatusNotificationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AccountStatusNotificationType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACCOUNT_TEMPORARILY_LOCKED

public static final AccountStatusNotificationType ACCOUNT_TEMPORARILY_LOCKED

Indicates that an account status message should be generated whenever a user account has been temporarily locked after too many failed attempts.

ACCOUNT_PERMANENTLY_LOCKED

public static final AccountStatusNotificationType ACCOUNT_PERMANENTLY_LOCKED

Indicates that an account status message should be generated whenever a user account has been permanently locked (requiring an administrative password reset) after too many failed attempts.

ACCOUNT_UNLOCKED

public static final AccountStatusNotificationType ACCOUNT_UNLOCKED

Indicates that an account status message should be generated whenever a user account has been unlocked by an administrator.

ACCOUNT_IDLE_LOCKED

public static final AccountStatusNotificationType ACCOUNT_IDLE_LOCKED

Indicates that an account status message should be generated whenever a user account has been locked because it was idle for too long.

ACCOUNT_RESET_LOCKED

public static final AccountStatusNotificationType ACCOUNT_RESET_LOCKED

Indicates that an account status message should be generated whenever a user account has been locked because it the password had been reset by an administrator but not changed by the user within the required interval.

ACCOUNT_DISABLED

public static final AccountStatusNotificationType ACCOUNT_DISABLED

Indicates that an account status message should be generated whenever a user account has been disabled by an administrator.

ACCOUNT_ENABLED

public static final AccountStatusNotificationType ACCOUNT_ENABLED

Indicates that an account status message should be generated whenever a user account has been enabled by an administrator.

ACCOUNT_EXPIRED

public static final AccountStatusNotificationType ACCOUNT_EXPIRED

Indicates that an account status message should be generated whenever a user authentication has failed because the account has expired.

PASSWORD_EXPIRED

public static final AccountStatusNotificationType PASSWORD_EXPIRED

Indicates that an account status notification message should be generated whenever a user authentication has failed because the password has expired.

PASSWORD_EXPIRING

public static final AccountStatusNotificationType PASSWORD_EXPIRING

Indicates that an account status notification message should be generated the first time that a password expiration warning is encountered for a user password.

PASSWORD_RESET

public static final AccountStatusNotificationType PASSWORD_RESET

Indicates that an account status notification message should be generated whenever a user's password is reset by an administrator.

PASSWORD_CHANGED

public static final AccountStatusNotificationType PASSWORD_CHANGED

Indicates whether an account status notification message should be generated whenever a user changes his/her own password.

Method Detail

values

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

Returns:

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

valueOf

public static AccountStatusNotificationType 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

typeForName

public static AccountStatusNotificationType typeForName(java.lang.String name)

Retrieves the account status notification type with the specified name.

Parameters:

name - The name for the account status notification type to retrieve.

Returns:

The requested account status notification type, or null if there is no type with the given name.

getName

public java.lang.String getName()

Retrieves the name for this account status notification type.

Returns:

The name for this account status notification type.

toString

public java.lang.String toString()

Retrieves a string representation of this account status notification type.

Overrides:

toString in class java.lang.Enum<AccountStatusNotificationType>

Returns:

A string representation of this account status notification type.