001/*
002 * Copyright (c) 2010-2023 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.DebugHeaderInfo;
025import com.restfb.json.JsonObject;
026
027/**
028 * Abstract class to provide access to the JSON Facebook provides in case of an error
029 *
030 * Sometime a developer needs to access the plain error to get a more in depth view to the error.
031 */
032public abstract class FacebookErrorMessageException extends FacebookException {
033
034  private JsonObject rawErrorJson;
035
036  private DebugHeaderInfo debugHeaderInfo;
037
038  protected FacebookErrorMessageException(String message) {
039    super(message);
040  }
041
042  protected FacebookErrorMessageException(String message, Throwable cause) {
043    super(message, cause);
044  }
045
046  /**
047   * return the raw error as JSON, may be <code>null</code>
048   * 
049   * @return raw error
050   */
051  public JsonObject getRawErrorJson() {
052    return rawErrorJson;
053  }
054
055  protected void setRawErrorJson(JsonObject rawError) {
056    rawErrorJson = rawError;
057  }
058
059  /**
060   * returns the debug header info that is connected with this Facebook call.
061   *
062   * you can get information like trace ids, limits and more.
063   * 
064   * @return the DebugHeaderInfo or null
065   */
066  public DebugHeaderInfo getDebugHeaderInfo() {
067    return debugHeaderInfo;
068  }
069
070  public void setDebugHeaderInfo(DebugHeaderInfo debugHeaderInfo) {
071    this.debugHeaderInfo = debugHeaderInfo;
072  }
073}