/*
 * 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
 * docs/licenses/cddl.txt
 * or 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 and include the License file at
 * docs/licenses/cddl.txt.  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
 *
 *
 *      Copyright 2021 Ping Identity Corporation
 */
package com.unboundid.directory.sdk.ds.types;


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


/**
 * This class defines the set of result codes for use in
 * {@link PassThroughAuthenticationResult} objects.
 */
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public enum PassThroughAuthenticationResultCode
{
  /**
   * Indicates that pass-through authentication attempt succeeded.
   */
  SUCCESS("success"),



  /**
   * Indicates that the pass-through authentication attempt failed because the
   * pass-through authentication handler could not identify exactly one account
   * in the external service that corresponds to the account in the local
   * server.
   */
  NO_SUCH_USER("no-such-user"),



  /**
   * Indicates that the pass-through authentication attempt failed because the
   * client provided the wrong password for the target user.
   */
  WRONG_PASSWORD("wrong-password"),



  /**
   * Indicates that the pass-through authentication attempt failed because the
   * password for the mapped account must be changed before the account can be
   * used.
   */
  MUST_CHANGE_PASSWORD("must-change-password"),



  /**
   * Indicates that the pass-through authentication attempt filed because the
   * mapped account in the external authentication service is not in a usable
   * state (e.g., the password is expired, the account is locked, etc.).
   */
  ACCOUNT_NOT_USABLE("account-not-usable"),



  /**
   * Indicates that the pass-through authentication attempt failed, but the
   * server did not provide enough information to identify a specific reason
   * (e.g., whether the user doesn't exist, the wrong password was provided, the
   * account is in an unusable state, etc.).
   */
  NON_SPECIFIC_AUTHENTICATION_FAILURE("non-specific-authentication-failure"),



  /**
   * Indicates that the pass-through authentication attempt failed because the
   * external service reported an error result.
   */
  EXTERNAL_SERVICE_ERROR("external-service-error"),



  /**
   * Indicates that the pass-through authentication attempt failed because the
   * external service is unavailable.
   */
  EXTERNAL_SERVICE_UNAVAILABLE("external-service-unavailable"),



  /**
   * Indicates that the pass-through authentication attempt failed because the
   * external service did not return a response within an expected timeout
   * period.
   */
  TIMEOUT("timeout"),



  /**
   * Indicates that the pass-through authentication attempt failed for a reason
   * that is not suited to any other defined result code.
   */
  OTHER_FAILURE("other-failure");



  // The human-readable name for this result code.
  private final String name;



  /**
   * Creates a new {@code PassThroughAuthenticationResultCode} with the
   * specified name.
   *
   * @param  name  The human-readable name for this result code.  It must not be
   *               {@code null}.
   */
  PassThroughAuthenticationResultCode(@NotNull final String name)
  {
    this.name = name;
  }



  /**
   * Retrieves the human-readable name for this result code.
   *
   * @return  The human-readable name for this result code.
   */
  @NotNull()
  public String getName()
  {
    return name;
  }



  /**
   * Retrieves the {@code PassThroughAuthenticationResultCode} value that
   * corresponds to the provided name.
   *
   * @param  name  The name for which to retrieve the corresponding result code.
   *               It must not be {@code null}.
   *
   * @return  The requested result code value, or {@code null} if there is no
   *          result code with the provided name.
   */
  @Nullable()
  public static PassThroughAuthenticationResultCode forName(
              @NotNull final String name)
  {
    final String lowerName = StaticUtils.toLowerCase(name).replace('_', '-');
    switch (lowerName)
    {
      case "success":
        return SUCCESS;
      case "no-such-user":
        return NO_SUCH_USER;
      case "wrong-password":
        return WRONG_PASSWORD;
      case "must-change-password":
        return MUST_CHANGE_PASSWORD;
      case "account-not-usable":
        return ACCOUNT_NOT_USABLE;
      case "non-specific-authentication-failure":
        return NON_SPECIFIC_AUTHENTICATION_FAILURE;
      case "external-service-error":
        return EXTERNAL_SERVICE_ERROR;
      case "external-service-unavailable":
        return EXTERNAL_SERVICE_UNAVAILABLE;
      case "timeout":
        return TIMEOUT;
      case "other-failure":
        return OTHER_FAILURE;
      default:
        return null;
    }
  }



  /**
   * Retrieves the human-readable name for this {@code IndexType}.
   *
   * @return  The human-readable name for this {@code IndexType}.
   */
  @Override
  @NotNull()
  public String toString()
  {
    return name;
  }
}