/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * http://www.opensource.org/licenses/cddl1.php.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file. If applicable, add the following below this CDDL HEADER,
 * with the fields enclosed by brackets "[]" replaced with your own
 * identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Portions Copyright 2008-2021 Ping Identity Corporation
 *      Portions Copyright 2008 Sun Microsystems, Inc.
 */
package com.unboundid.directory.sdk.ds.types;



import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;



/**
 * This class implements an enumeration that holds the possible set of
 * additional properties that can be included in an account status notification.
 */
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public enum AccountStatusNotificationProperty
{
  /**
   * The property whose value will be the name of the account status
   * notification type.  This will be available for all notification types.
   */
  NOTIFICATION_TYPE("notification-type"),



  /**
   * 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.
   */
  PASSWORD_POLICY_DN("password-policy-dn"),



  /**
   * The property whose value will be a generalized time representation of the
   * time that the account status notification was generated.  This will be
   * available for all notification types.
   */
  NOTIFICATION_TIME("notification-time"),



  /**
   * The property whose value will the DN of the account with which the
   * notification is associated.  This will be available for all notification
   * types.
   */
  ACCOUNT_DN("account-dn"),



  /**
   * The property whose value will be a generalized time representation of the
   * time that the account's password was last changed.  This will be available
   * for all notification types.
   */
  PASSWORD_CHANGED_TIME("password-changed-time"),



  /**
   * The property whose value will be the number of seconds since the account's
   * password was last changed.  This will be available for all notification
   * types.
   */
  SECONDS_SINCE_PASSWORD_CHANGE("seconds-since-password-change"),



  /**
   * The property whose value will be a localized, human-readable representation
   * of the time since the account's password was last changed.  This will be
   * available for all notification types.
   */
  TIME_SINCE_PASSWORD_CHANGE("time-since-password-change"),



  /**
   * The property whose value will be "true" if the associated account is in a
   * state that will allow it to authenticate when provided with appropriate
   * credentials, or "false" if the account is not usable for some reason.  This
   * will be available for all notification types.
   */
  ACCOUNT_IS_USABLE("account-is-usable"),



  /**
   * The property whose values will be human-readable messages about error
   * conditions affecting an account's usability.  This will be available for
   * all notification types.
   */
  ACCOUNT_USABILITY_ERRORS("account-usability-errors"),



  /**
   * The property whose values will be human-readable messages about warning
   * conditions that may affect an account's usability in the near future.  This
   * will be available for all notification types.
   */
  ACCOUNT_USABILITY_WARNINGS("account-usability-warnings"),



  /**
   * The property whose values will be human-readable messages about noteworthy
   * conditions regarding an account that do not necessarily represent a current
   * or imminent problem with the account.  This will be available for all
   * notification types.
   */
  ACCOUNT_USABILITY_NOTICES("account-usability-notices"),



  /**
   * The property whose value will be "true" if the associated account is
   * administratively disabled, or "false" if the account is enabled.  This will
   * be available for all notification types.
   */
  ACCOUNT_IS_DISABLED("account-is-disabled"),



  /**
   * The property whose value will be "true" if the associated account is
   * not yet active, or "false" if the account either does not have an
   * activation time or that time is in the past.  This will be available for
   * all notification types.
   */
  ACCOUNT_IS_NOT_YET_ACTIVE("account-is-not-yet-active"),



  /**
   * The property whose value will be a generalized time representation of the
   * activation time for the associated account, if available.  This will be
   * available for all notification types, if the account has an activation
   * time.
   */
  ACCOUNT_ACTIVATION_TIME("account-activation-time"),



  /**
   * The property whose value will be the number of seconds until the associated
   * account becomes active.  This will be available for all notification types,
   * if the account has an activation time in the future.
   */
  SECONDS_UNTIL_ACCOUNT_ACTIVATION("seconds-until-account-activation"),



  /**
   * The property whose value will be a localized, human-readable length of
   * time until the associated account becomes active.  This will be available
   * for all notification types, if the account has an activation time in the
   * future.
   */
  TIME_UNTIL_ACCOUNT_ACTIVATION("time-until-account-activation"),



  /**
   * The property whose value will be the number of seconds since the associated
   * account became active.  This will be available for all notification types,
   * if the account has an activation time in the past.
   */
  SECONDS_SINCE_ACCOUNT_ACTIVATION("seconds-since-account-activation"),



  /**
   * The property whose value will be a localized, human-readable length of
   * time since the associated account became active.  This will be available
   * for all notification types, if the account has an activation time in the
   * past.
   */
  TIME_SINCE_ACCOUNT_ACTIVATION("time-since-account-activation"),



  /**
   * The property whose value will be "true" if the associated account is
   * expired, or "false" if the account either does not have an expiration time
   * or that time is in the future.  This will be available for all notification
   * types.
   */
  ACCOUNT_IS_EXPIRED("account-is-expired"),



  /**
   * The property whose value will be a generalized time representation of the
   * expiration time for the associated account, if available.  This will be
   * available for all notification types, if the account has an expiration
   * time.
   */
  ACCOUNT_EXPIRATION_TIME("account-expiration-time"),



  /**
   * The property whose value will be the number of seconds until the associated
   * account expires.  This will be available for all notification types, if the
   * account has an expiration time in the future.
   */
  SECONDS_UNTIL_ACCOUNT_EXPIRATION("seconds-until-account-expiration"),



  /**
   * The property whose value will be a localized, human-readable length of
   * time until the associated account expires.  This will be available for all
   * notification types, if the account has an expiration time in the future.
   */
  TIME_UNTIL_ACCOUNT_EXPIRATION("time-until-account-expiration"),



  /**
   * The property whose value will be the number of seconds since the associated
   * account expired.  This will be available for all notification types, if the
   * account has an expiration time in the past.
   */
  SECONDS_SINCE_ACCOUNT_EXPIRATION("seconds-since-account-expiration"),



  /**
   * The property whose value will be a localized, human-readable length of
   * time since the associated account expired.  This will be available for all
   * notification types, if the account has an expiration  time in the past.
   */
  TIME_SINCE_ACCOUNT_EXPIRATION("time-since-account-expiration"),



  /**
   * The property whose value will be "true" if the associated account has been
   * temporarily or permanently locked as a result of too many authentication
   * failures, or "false" if the account is not failure-locked.  This will be
   * available for all notification types.
   */
  ACCOUNT_IS_FAILURE_LOCKED("account-is-failure-locked"),



  /**
   * The property whose value will be a generalized time representation of the
   * time that the account was locked as a result of too many authentication
   * failures.  This will be available for all notification types, if the
   * account is failure-locked.
   */
  FAILURE_LOCKED_TIME("failure-locked-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 all notification types, if an account is temporarily failure-locked.
   */
  ACCOUNT_UNLOCK_TIME("account-unlock-time"),



  /**
   * The property whose value will be the number of seconds until the user's
   * account is unlocked.  This will be available for all notification types, if
   * an account is temporarily failure-locked.
   */
  SECONDS_UNTIL_UNLOCK("seconds-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 all notification types, if an account is temporarily
   * failure-locked.
   */
  TIME_UNTIL_UNLOCK("time-until-unlock"),



  /**
   * The property whose value will be the number of failed authentication
   * attempts required to lock an account.  This will be available for all
   * notification types, if failure lockout is enabled.
   */
  FAILURE_LOCKOUT_COUNT("failure-lockout-count"),



  /**
   * The property whose value will be the number of seconds that an account will
   * remain locked as a result of too many authentication failures.  This will
   * be available for all notification types, if failure lockout is enabled with
   * a lockout duration.
   */
  FAILURE_LOCKOUT_DURATION_SECONDS("failure-lockout-duration-seconds"),



  /**
   * The property whose value will be a localized, human-readable representation
   * of the length of time that an account will remain locked as a result of too
   * many authentication failures.  This will be available for all notification
   * types, if failure lockout is enabled with a lockout duration.
   */
  FAILURE_LOCKOUT_DURATION("failure-lockout-duration"),



  /**
   * The property whose value will be "true" if the associated account has been
   * locked because it has been too long since the last successful
   * authentication, or "false" if the account is not idle-locked.  This will be
   * available for all notification types.
   */
  ACCOUNT_IS_IDLE_LOCKED("account-is-idle-locked"),



  /**
   * The property whose value will be the maximum number of seconds that may
   * pass between the last successful authentication on an account and that
   * account becoming locked for lack of use.  This will be available for all
   * notification types, if idle lockout is enabled.
   */
  IDLE_LOCKOUT_INTERVAL_SECONDS("idle-lockout-interval-seconds"),



  /**
   * The property whose value will be a localized, human-readable representation
   * of the maximum length of time that may pass between the last successful
   * authentication for an account and that account becoming locked for lack of
   * use.  This will be available for all notification types, if idle lockout
   * is enabled.
   */
  IDLE_LOCKOUT_INTERVAL("idle-lockout-interval"),



  /**
   * The property whose value will be a generalized time representation of the
   * time that the user last successfully authenticated, if available.  This
   * will be available for all notification types, if a last login time is
   * available for the user.
   */
  LAST_LOGIN_TIME("last-login-time"),



  /**
   * The property whose value will be the number of seconds since the user last
   * successfully authenticated, if available.  This will be available for all
   * notification types, if a last login time is available for the user.
   */
  SECONDS_SINCE_LAST_LOGIN("seconds-since-last-login"),



  /**
   * The property whose value will be a localized, human-readable representation
   * of the length of time since the user last successfully authenticated, if
   * available.  This will be available for all notification types, if a last
   * login time is available for the user.
   */
  TIME_SINCE_LAST_LOGIN("time-since-last-login"),



  /**
   * The property whose value will be the IP address of the client from which
   * the user last successfully authenticated, if available.  This will be
   * available for all notification types.
   */
  LAST_LOGIN_IP_ADDRESS("last-login-ip-address"),



  /**
   * The property whose value will be "true" if the associated account has been
   * locked because the user failed to choose a new password in a timely manner
   * after it was administratively reset, or "false" if the account is not
   * reset-locked.  This will be available for all notification types.
   */
  ACCOUNT_IS_RESET_LOCKED("account-is-reset-locked"),



  /**
   * The property whose value will be the maximum number of seconds that a user
   * has to change their password after an administrative reset before their
   * account will become locked.  This will be available for all notification
   * types, if reset lockout is enabled.
   */
  MAXIMUM_PASSWORD_RESET_AGE_SECONDS("maximum-password-reset-age-seconds"),



  /**
   * The property whose value will be a localized, human-readable representation
   * of the maximum length of time that a user has to change their password
   * after an administrative reset before their account will become locked.
   * This will be available for all notification types, if reset lockout is
   * enabled.
   */
  MAXIMUM_PASSWORD_RESET_AGE("maximum-password-reset-age"),



  /**
   * The property whose value will be "true" if the associated user must choose
   * a new password before they will be permitted to request any other
   * operations, or "false" if the user will not be required to change their
   * password.
   */
  MUST_CHANGE_PASSWORD("must-change-password"),



  /**
   * The property whose value will be "true" if the associated account has been
   * locked because it contains a password that did not satisfy all of the
   * configured password validators, or "false" if the account is not
   * validation-locked.  This will be available for all notification types.
   */
  ACCOUNT_IS_VALIDATION_LOCKED("account-is-validation-locked"),



  /**
   * The property whose value will be "true" if the associated account was
   * unlocked by the associated operation, or "false" if it was not unlocked.
   * This will be available for the
   * {@link AccountStatusNotificationType#PASSWORD_RESET} and
   * {@link AccountStatusNotificationType#PASSWORD_CHANGED} notification types.
   */
  ACCOUNT_WAS_UNLOCKED("account-was-unlocked"),



  /**
   * The property whose value will be "true" if the associated account has an
   * expired password, or "false" if the password is not expired.  This will be
   * available for all notification types.
   */
  PASSWORD_IS_EXPIRED("password-is-expired"),



  /**
   * The property whose value will be "true" if the associated account has a
   * password that is about to expire, or "false" if the account does not have
   * a password that is about to expire.  This will be available for all
   * notification types.
   */
  PASSWORD_IS_EXPIRING("password-is-expiring"),



  /**
   * The property whose value will be the maximum length of time in seconds that
   * an account will be permitted to continue using the same password before it
   * will expire.  This will be available for all notification types, if
   * password expiration is enabled.
   */
  MAXIMUM_PASSWORD_AGE_SECONDS("maximum-password-age-seconds"),



  /**
   * The property whose value will be a localized, human-readable representation
   * of the maximum length of time that an account will be permitted to continue
   * using the same password before it will expire.  This will be available for
   * all notification types, if password expiration is enabled.
   */
  MAXIMUM_PASSWORD_AGE("maximum-password-age"),



  /**
   * The property whose value will be the generalized time representation of the
   * time that the user's password will expire (if it is in the future) or that
   * it did expire (if it was in the past).  This will be available for all
   * notification types, if password expiration is enabled.
   */
  PASSWORD_EXPIRATION_TIME("password-expiration-time"),



  /**
   * The property whose value will be the number of seconds until the user's
   * password expires (if it is in the future).  This will be available for all
   * notification types, if there is an upcoming password expiration.
   */
  SECONDS_UNTIL_PASSWORD_EXPIRATION("seconds-until-password-expiration"),



  /**
   * The property whose value will be the number of seconds until the user's
   * password expires (if it is in the future).  This will be available for all
   * notification types, if there is an upcoming password expiration.
   *
   * @deprecated  Use {@link #SECONDS_UNTIL_PASSWORD_EXPIRATION} instead.
   */
  @Deprecated()
  SECONDS_UNTIL_EXPIRATION("seconds-until-expiration"),



  /**
   * The property whose value will be a localized, human-readable representation
   * of the length of time until the user's password expires (if it is in the
   * future).  This will be available for all notification types, if there is an
   * upcoming password expiration.
   */
  TIME_UNTIL_PASSWORD_EXPIRATION("time-until-password-expiration"),



  /**
   * The property whose value will be a localized, human-readable representation
   * of the length of time until the user's password expires (if it is in the
   * future).  This will be available for all notification types, if there is an
   * upcoming password expiration.
   *
   * @deprecated  Use {@link #TIME_UNTIL_PASSWORD_EXPIRATION} instead.
   */
  @Deprecated()
  TIME_UNTIL_EXPIRATION("time-until-expiration"),



  /**
   * The property whose value will be the number of seconds since the user's
   * password expired (if it is in the past).  This will be available for all
   * notification types, if there is an expired password.
   */
  SECONDS_SINCE_PASSWORD_EXPIRATION("seconds-since-password-expiration"),



  /**
   * The property whose value will be a localized, human-readable representation
   * of the length of time since the user's password expired (if it is in the
   * past).  This will be available for all notification types, if there is an
   * expired password.
   */
  TIME_SINCE_PASSWORD_EXPIRATION("time-since-password-expiration"),



  /**
   * The property whose value will be a clear-text representation of the user's
   * old password.  This may be (but is not guaranteed to be) available for the
   * {@link AccountStatusNotificationType#PASSWORD_RESET} and
   * {@link AccountStatusNotificationType#PASSWORD_CHANGED} notification types.
   */
  OLD_PASSWORD("old-password"),



  /**
   * The property whose value will be a clear-text representation of the user's
   * new password.  This may be (but is not guaranteed to be) available for the
   * {@link AccountStatusNotificationType#PASSWORD_RESET} and
   * {@link AccountStatusNotificationType#PASSWORD_CHANGED} notification types.
   */
  NEW_PASSWORD("new-password"),



  /**
   * The property whose value will be a clear-text representation of the user's
   * new password, but only if the new password was generated by the server
   * rather than provided by the client.  This may be (but is not guaranteed to
   * be) available for the
   * {@link AccountStatusNotificationType#PASSWORD_RESET} and
   * {@link AccountStatusNotificationType#PASSWORD_CHANGED} notification types.
   */
  NEW_GENERATED_PASSWORD("new-generated-password"),



  /**
   * The property whose value will be the IP address of the client that
   * requested the associated operation.  This will be available for all
   * notification types, if the request was initiated by an external client.
   */
  REQUESTER_IP_ADDRESS("requester-ip-address"),



  /**
   * The property whose value will be the DN of the authorization identity for
   * the associated operation.  This will be available for all notification
   * types.
   */
  REQUESTER_DN("requester-dn"),



  /**
   * The property whose value will be name of the operation type for the
   * associated operation.  This will be available for all notification types.
   */
  OPERATION_TYPE("operation-type"),



  /**
   * The property whose value will be the operation ID for the associated
   * operation.  This will be available for all notification types.
   */
  OPERATION_ID("operation-id"),



  /**
   * The property whose value will be the connection ID for the associated
   * operation.  This will be available for all notification types.
   */
  CONNECTION_ID("connection-id"),



  /**
   * The property whose value will be the server UUID value for the server in
   * which the notification was generated.  This will be available for all
   * notification types.
   */
  SERVER_UUID("server-uuid"),



  /**
   * The property whose value will be the server instance name for the server in
   * which the notification was generated.  This will be available for all
   * notification types.
   */
  INSTANCE_NAME("instance-name"),



  /**
   * The property whose values will be human-readable messages describing
   * why a provided password failed to satisfy one or more of the configured
   * password validators.  This will be available for the
   * {@link AccountStatusNotificationType#BIND_PASSWORD_FAILED_VALIDATION}
   * notification type.
   */
  PASSWORD_VALIDATION_FAILURE_REASONS("password-validation-failure-reasons");



  // The notification type name.
  private final String name;



  /**
   * Creates a new account status notification property with the provided name.
   *
   * @param  name  The name for this account status notification property.
   */
  AccountStatusNotificationProperty(final String name)
  {
    this.name = name;
  }



  /**
   * Retrieves the account status notification type with the specified name.
   *
   * @param  name  The name for the account status notification type to
   *               retrieve.
   *
   * @return  The requested account status notification type, or {@code null}
   *          if there is no type with the given name.
   */
  public static AccountStatusNotificationProperty forName(final String name)
  {
    final String lowerNameWithDashesInsteadOfUnderscores =
         StaticUtils.toLowerCase(name).replace('_', '-');
    for (final AccountStatusNotificationProperty p : values())
    {
      if (p.getName().equals(lowerNameWithDashesInsteadOfUnderscores))
      {
        return p;
      }
    }

    return null;
  }



  /**
   * Retrieves the name for this account status notification property.
   *
   * @return  The name for this account status notification property.
   */
  public String getName()
  {
    return name;
  }



  /**
   * Retrieves a string representation of this account status
   * notification property.
   *
   * @return  A string representation of this account status
   *          notification property.
   */
  @Override()
  public String toString()
  {
    return name;
  }
}