Package org.opends.server.types
Enum AccountStatusNotificationProperty
- java.lang.Object
-
- java.lang.Enum<AccountStatusNotificationProperty>
-
- org.opends.server.types.AccountStatusNotificationProperty
-
- All Implemented Interfaces:
Serializable
,Comparable<AccountStatusNotificationProperty>
@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public enum AccountStatusNotificationProperty extends Enum<AccountStatusNotificationProperty>
This class implements an enumeration that holds the possible set of additional properties that can be included in an account status notification.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACCOUNT_UNLOCK_TIME
The property whose value will be a generalized time representation of the time at which the user's account will be unlocked.NEW_PASSWORD
The property whose value will be a clear-text representation of the user's new password.OLD_PASSWORD
The property whose value will be a clear-text representation of the user's old password.PASSWORD_EXPIRATION_TIME
The property whose value will be the generalized time representation of the time that the user's password will expire.PASSWORD_POLICY_DN
The property whose value will be the string representation of the DN of the password policy for the target user.SECONDS_UNTIL_EXPIRATION
The property whose value will be the number of seconds until the user's password expires.SECONDS_UNTIL_UNLOCK
The property whose value will be the number of seconds until the user's account is unlocked.TIME_UNTIL_EXPIRATION
The property whose value will be a localized, human-readable representation of the length of time until the user's password expires.TIME_UNTIL_UNLOCK
The property whose value will be a localized, human-readable representation of the length of time until the user's account is unlocked.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AccountStatusNotificationProperty
forName(String name)
Retrieves the account status notification type with the specified name.String
getName()
Retrieves the name for this account status notification property.String
toString()
static AccountStatusNotificationProperty
valueOf(String name)
Returns the enum constant of this type with the specified name.static AccountStatusNotificationProperty[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
PASSWORD_POLICY_DN
public static final AccountStatusNotificationProperty PASSWORD_POLICY_DN
The property whose value will be the string representation of the DN of the password policy for the target user. This will be available for all notification types.
-
ACCOUNT_UNLOCK_TIME
public static final AccountStatusNotificationProperty ACCOUNT_UNLOCK_TIME
The property whose value will be a generalized time representation of the time at which the user's account will be unlocked. This will be available for theACCOUNT_TEMPORARILY_LOCKED
notification type.
-
SECONDS_UNTIL_UNLOCK
public static final AccountStatusNotificationProperty SECONDS_UNTIL_UNLOCK
The property whose value will be the number of seconds until the user's account is unlocked. This will be available for theACCOUNT_TEMPORARILY_LOCKED
notification type.
-
TIME_UNTIL_UNLOCK
public static final AccountStatusNotificationProperty TIME_UNTIL_UNLOCK
The property whose value will be a localized, human-readable representation of the length of time until the user's account is unlocked. This will be available for theACCOUNT_TEMPORARILY_LOCKED
notification type.
-
PASSWORD_EXPIRATION_TIME
public static final AccountStatusNotificationProperty PASSWORD_EXPIRATION_TIME
The property whose value will be the generalized time representation of the time that the user's password will expire. This will be available for thePASSWORD_EXPIRING
notification type.
-
SECONDS_UNTIL_EXPIRATION
public static final AccountStatusNotificationProperty SECONDS_UNTIL_EXPIRATION
The property whose value will be the number of seconds until the user's password expires. This will be available for thePASSWORD_EXPIRING
notification type.
-
TIME_UNTIL_EXPIRATION
public static final AccountStatusNotificationProperty TIME_UNTIL_EXPIRATION
The property whose value will be a localized, human-readable representation of the length of time until the user's password expires. This will be available for thePASSWORD_EXPIRING
notification type.
-
OLD_PASSWORD
public static final AccountStatusNotificationProperty OLD_PASSWORD
The property whose value will be a clear-text representation of the user's old password. This may be available for thePASSWORD_RESET
andPASSWORD_CHANGED
notification types.
-
NEW_PASSWORD
public static final AccountStatusNotificationProperty NEW_PASSWORD
The property whose value will be a clear-text representation of the user's new password. This may be available for thePASSWORD_RESET
andPASSWORD_CHANGED
notification types.
-
-
Method Detail
-
values
public static AccountStatusNotificationProperty[] 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 (AccountStatusNotificationProperty c : AccountStatusNotificationProperty.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AccountStatusNotificationProperty 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 nameNullPointerException
- if the argument is null
-
forName
public static AccountStatusNotificationProperty forName(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 String getName()
Retrieves the name for this account status notification property.- Returns:
- The name for this account status notification property.
-
toString
public String toString()
- Overrides:
toString
in classEnum<AccountStatusNotificationProperty>
-
-