001/*
002 * Copyright (c) 2010-2024 Mark Allen, Norbert Bartels.
003 *
004 * Permission is hereby granted, free of charge, to any person obtaining a copy
005 * of this software and associated documentation files (the "Software"), to deal
006 * in the Software without restriction, including without limitation the rights
007 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
008 * copies of the Software, and to permit persons to whom the Software is
009 * furnished to do so, subject to the following conditions:
010 *
011 * The above copyright notice and this permission notice shall be included in
012 * all copies or substantial portions of the Software.
013 *
014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
015 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
017 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
019 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
020 * THE SOFTWARE.
021 */
022package com.restfb.exception;
023
024import com.restfb.json.JsonObject;
025
026/**
027 * Indicates that the Facebook Graph API endpoint returned JSON which indicates an error condition related to the OAuth
028 * token included in the request.
029 * <p>
030 * Example:<code>
031  {
032      "error": {
033        "type": "OAuthException",
034        "message": "(#210) User not visible",
035        "code": 210,
036        "error_subcode": 123,
037        "error_user_title": "A title",
038        "error_user_msg": "A message"
039      }
040  } </code>
041 * 
042 * @author <a href="http://restfb.com">Mark Allen</a>
043 * @since 1.6
044 */
045public class FacebookOAuthException extends FacebookGraphException {
046  private static final long serialVersionUID = 2L;
047
048  /**
049   * Creates an exception with the given error type and message.
050   * 
051   * @param errorType
052   *          Value of the Facebook response attribute {@code error.type}.
053   * @param errorMessage
054   *          Value of the Facebook response attribute {@code error.message}.
055   * @param errorCode
056   *          Value of the Facebook response attribute {@code error.code}.
057   * @param errorSubcode
058   *          Value of the Facebook response attribute {@code error.error_subcode}.
059   * @param httpStatusCode
060   *          The HTTP status code returned by the server, e.g. 500.
061   * @param userTitle
062   *          Value of the Facebook response attribute {@code error.error_user_title}.
063   * @param userMessage
064   *          Value of the Facebook response attribute {@code error.error_user_message}.
065   */
066  public FacebookOAuthException(String errorType, String errorMessage, Integer errorCode, Integer errorSubcode,
067      Integer httpStatusCode, String userTitle, String userMessage, Boolean isTransient, JsonObject rawError) {
068    super(errorType, errorMessage, errorCode, errorSubcode, httpStatusCode, userTitle, userMessage, isTransient,
069      rawError);
070  }
071}