AccountStatusNotificationType (UnboundID Server SDK)

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

Enum Constants
Enum Constant and Description
`ACCOUNT_CREATED` Indicates that an account has been created with an add request that matches a defined set of criteria.
`ACCOUNT_DISABLED` Indicates that an account has been disabled by an administrator.
`ACCOUNT_ENABLED` Indicates that an account has been enabled by an administrator.
`ACCOUNT_EXPIRED` Indicates than an authentication attempt failed because the account has an expiration time that is in the past.
`ACCOUNT_IDLE_LOCKED` Indicates than an authentication attempt failed because too much time had elapsed since the account last successfully authenticated.
`ACCOUNT_NOT_YET_ACTIVE` Indicates than an authentication attempt failed because the account has an activation time that is in the future.
`ACCOUNT_PERMANENTLY_LOCKED` Indicates that an account has been permanently locked as a result of too many failed authentication attempts.
`ACCOUNT_RESET_LOCKED` Indicates than an authentication attempt failed because the user was required to change their password after an administrative password reset, but that they did not do so within the required interval.
`ACCOUNT_TEMPORARILY_LOCKED` Indicates that an account has been temporarily locked as a result of too many failed authentication attempts.
`ACCOUNT_UNLOCKED` Indicates that a failure-locked, idle-locked, or reset-locked account has been unlocked by an administrator (e.g., by a password reset).
`ACCOUNT_UPDATED` Indicates that an account has been updated with a modify or modify DN request that matches a defined set of criteria.
`BIND_PASSWORD_FAILED_VALIDATION` Indicates that a bind attempt failed because it used a password that did not satisfy all of the configured password validators.
`MUST_CHANGE_PASSWORD` Indicates that a user successfully authenticated, but their account is in a "must change password" state, and the user must choose a new password before being allowed to perform any other type of operation.
`PASSWORD_CHANGED` Indicates that a user has changed their own password.
`PASSWORD_EXPIRED` Indicates than an authentication attempt failed because the account has an expired password.
`PASSWORD_EXPIRING` Indicates that an authentication attempt succeeded, but that the password will expire in the near future.
`PASSWORD_RESET` Indicates that a user's password has been reset by an administrator.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 has been temporarily locked as a result of too many failed authentication attempts. The account will remain locked until the lockout period expires or until it is manually unlocked by an administrator (e.g., by a password reset).
  - ACCOUNT_PERMANENTLY_LOCKED
```
public static final AccountStatusNotificationType ACCOUNT_PERMANENTLY_LOCKED
```
    Indicates that an account has been permanently locked as a result of too many failed authentication attempts. The account will remain locked until it is manually unlocked by an administrator (e.g., by a password reset).
  - ACCOUNT_UNLOCKED
```
public static final AccountStatusNotificationType ACCOUNT_UNLOCKED
```
    Indicates that a failure-locked, idle-locked, or reset-locked account has been unlocked by an administrator (e.g., by a password reset).
  - ACCOUNT_IDLE_LOCKED
```
public static final AccountStatusNotificationType ACCOUNT_IDLE_LOCKED
```
    Indicates than an authentication attempt failed because too much time had elapsed since the account last successfully authenticated.
  - ACCOUNT_RESET_LOCKED
```
public static final AccountStatusNotificationType ACCOUNT_RESET_LOCKED
```
    Indicates than an authentication attempt failed because the user was required to change their password after an administrative password reset, but that they did not do so within the required interval.
  - ACCOUNT_DISABLED
```
public static final AccountStatusNotificationType ACCOUNT_DISABLED
```
    Indicates that an account has been disabled by an administrator.
  - ACCOUNT_ENABLED
```
public static final AccountStatusNotificationType ACCOUNT_ENABLED
```
    Indicates that an account has been enabled by an administrator.
  - ACCOUNT_NOT_YET_ACTIVE
```
public static final AccountStatusNotificationType ACCOUNT_NOT_YET_ACTIVE
```
    Indicates than an authentication attempt failed because the account has an activation time that is in the future.
  - ACCOUNT_EXPIRED
```
public static final AccountStatusNotificationType ACCOUNT_EXPIRED
```
    Indicates than an authentication attempt failed because the account has an expiration time that is in the past.
  - PASSWORD_EXPIRED
```
public static final AccountStatusNotificationType PASSWORD_EXPIRED
```
    Indicates than an authentication attempt failed because the account has an expired password.
  - PASSWORD_EXPIRING
```
public static final AccountStatusNotificationType PASSWORD_EXPIRING
```
    Indicates that an authentication attempt succeeded, but that the password will expire in the near future. This notification will only be generated the first time that an expiration warning is generated for a password.
  - PASSWORD_RESET
```
public static final AccountStatusNotificationType PASSWORD_RESET
```
    Indicates that a user's password has been reset by an administrator.
  - PASSWORD_CHANGED
```
public static final AccountStatusNotificationType PASSWORD_CHANGED
```
    Indicates that a user has changed their own password.
  - ACCOUNT_CREATED
```
public static final AccountStatusNotificationType ACCOUNT_CREATED
```
    Indicates that an account has been created with an add request that matches a defined set of criteria.
  - ACCOUNT_UPDATED
```
public static final AccountStatusNotificationType ACCOUNT_UPDATED
```
    Indicates that an account has been updated with a modify or modify DN request that matches a defined set of criteria.
  - BIND_PASSWORD_FAILED_VALIDATION
```
public static final AccountStatusNotificationType BIND_PASSWORD_FAILED_VALIDATION
```
    Indicates that a bind attempt failed because it used a password that did not satisfy all of the configured password validators.
  - MUST_CHANGE_PASSWORD
```
public static final AccountStatusNotificationType MUST_CHANGE_PASSWORD
```
    Indicates that a user successfully authenticated, but their account is in a "must change password" state, and the user must choose a new password before being allowed to perform any other type of operation.
- 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.

Enum AccountStatusNotificationType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ACCOUNT_TEMPORARILY_LOCKED

ACCOUNT_PERMANENTLY_LOCKED

ACCOUNT_UNLOCKED

ACCOUNT_IDLE_LOCKED

ACCOUNT_RESET_LOCKED

ACCOUNT_DISABLED

ACCOUNT_ENABLED

ACCOUNT_NOT_YET_ACTIVE

ACCOUNT_EXPIRED

PASSWORD_EXPIRED

PASSWORD_EXPIRING

PASSWORD_RESET

PASSWORD_CHANGED

ACCOUNT_CREATED

ACCOUNT_UPDATED

BIND_PASSWORD_FAILED_VALIDATION

MUST_CHANGE_PASSWORD

Method Detail

values

valueOf

typeForName

getName

toString