/*
 * 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
 * trunk/ds/resource/legal-notices/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
 * trunk/ds/resource/legal-notices/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 2013-2016 UnboundID Corp.
 */
package com.unboundid.directory.sdk.broker.types;

import com.unboundid.util.Extensible;


/**
 * This class provides a type of {@link Exception} which is used to indicate
 * an error when interfacing with an OAuth 2 extension.
 */
@Extensible()
public class OAuthException extends Exception
{
  private static final long serialVersionUID = 3679401569779402582L;

  /**
   * The access_denied OAuth 2 error code. Used when the resource
   * owner or authorization server denied the request.
   */
  public static final String ACCESS_DENIED = "access_denied";

  /**
   * The consent_required OAuth 2 error code. Used when the
   * Authorization Server requires End-User consent.
   */
  public static final String CONSENT_REQUIRED = "consent_required";

  /**
   * The invalid_client OAuth 2 error code. Used when client authentication
   * failed (e.g., unknown client, no client authentication included, or
   * unsupported authentication method).
   */
  public static final String INVALID_CLIENT = "invalid_client";

  /**
   * The invalid_grant OAuth 2 error code. Used when the provided
   * authorization grant (e.g., authorization code, resource owner
   * credentials) or refresh token is invalid, expired, revoked, does
   * not match the redirection URI used in the authorization request,
   * or was issued to another client.
   */
  public static final String INVALID_GRANT = "invalid_grant";

  /**
   * The invalid_request OAuth 2 error code. Used when the request is
   * missing a required parameter, includes an unsupported parameter
   * value (other than grant type), repeats a parameter, includes
   * multiple credentials, utilizes more than one mechanism for
   * authenticating the client, or is otherwise malformed.
   */
  public static final String INVALID_REQUEST = "invalid_request";

  /**
   * The invalid_scope OAuth 2 error code. Used when the requested
   * scope is invalid, unknown, or malformed
   */
  public static final String INVALID_SCOPE = "invalid_scope";

  /**
   * The invalid_token OAuth 2 error code. Used when the provided
   * access or refresh token value is invalid.
   */
  public static final String INVALID_TOKEN = "invalid_token";

  /**
   * The login_required OAuth 2 error code. Used when the Authorization
   * Server requires End-User authentication.
   */
  public static final String LOGIN_REQUIRED = "login_required";

  /**
   * The server_error OAuth 2 error code. Used when the authorization server
   * encountered an unexpected condition that prevented it from fulfilling
   * the request.
   */
  public static final String SERVER_ERROR = "server_error";

  /**
   * The temporarily_unavailable OAuth 2 error code. Used when the
   * authorization server is currently unable to handle the request due to
   * a temporary overloading or maintenance of the server.
   */
  public static final String TEMPORARILY_UNAVAILABLE =
      "temporarily_unavailable";

  /**
   * The unauthorized_client OAuth 2 error code. Used when the authenticated
   * client is not authorized to use this authorization grant type.
   */
        public static final String UNAUTHORIZED_CLIENT = "unauthorized_client";

  /**
   * The unsupported_grant_type OAuth 2 error code. Used when the
   * authorization grant type is not supported by the authorization
   * server.
   */
        public static final String UNSUPPORTED_GRANT_TYPE =
       "unsupported_grant_type";

  /**
   * The unsupported_response_type OAuth 2 error code. Used when the
   * authorization server does not support obtaining an authorization
   * code using this method.
   */
        public static final String UNSUPPORTED_RESPONSE_TYPE =
       "unsupported_response_type";

  private final String oauth2ErrorCode;
  private final String errorUri;

  /**
   * Creates a new OAuthException with the provided information.
   *
   * @param  oauth2ErrorCode   The OAuth 2 error code that should be returned
   *                           to the client application.
   */
  public OAuthException(final String oauth2ErrorCode)
  {
    this(oauth2ErrorCode, null, null, null);
  }



  /**
   * Creates a new OAuthException with the provided information.
   *
   * @param  oauth2ErrorCode   The OAuth 2 error code that should be returned
   *                           to the client application.
   * @param  message           The message that explains the problem that
   *                           occurred.
   */
  public OAuthException(final String oauth2ErrorCode, final String message)
  {
    this(oauth2ErrorCode, message, null, null);
  }



  /**
   * Creates a new OAuthException with the provided information.
   *
   * @param  oauth2ErrorCode   The OAuth 2 error code that should be returned
   *                           to the client application.
   * @param  cause             The underlying cause that triggered this
   *                           exception.
   */
  public OAuthException(final String oauth2ErrorCode, final Throwable cause)
  {
    this(oauth2ErrorCode, null, null, cause);
  }



  /**
   * Creates a new OAuthException with the provided information.
   *
   * @param  oauth2ErrorCode   The OAuth 2 error code that should be returned
   *                           to the client application.
   * @param  message           The message that explains the problem that
   *                           occurred.
   * @param  errorUri          A URI identifying a web page with information
   *                           about the error.
   * @param  cause             The underlying cause that triggered this
   *                           exception.
   */
  public OAuthException(final String oauth2ErrorCode,
                        final String message,
                        final String errorUri,
                        final Throwable cause)
  {
    super(message, cause);
    this.oauth2ErrorCode = oauth2ErrorCode;
    this.errorUri = errorUri;
    if(oauth2ErrorCode == null)
    {
      throw new NullPointerException("The OAuth2ErrorCode cannot be null.");
    }
  }

  /**
   * Retrieves the OAuth 2 error code that should be returned to the client
   * application.
   *
   * @return The OAuth 2 error code that should be returned to the client
   *         application.
   */
  public String getOauth2ErrorCode()
  {
    return oauth2ErrorCode;
  }

  /**
   * Retrieves the URI identifying a web page with information about the error
   * or {@code null} if not available.
   *
   * @return The URI identifying a web page with information about the error or
   * {@code null} if not available.
   */
  public String getErrorUri()
  {
    return errorUri;
  }
}