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 static java.lang.String.format;
025
026/**
027 * Indicates that a network error occurred while trying to connect to the Facebook API endpoint.
028 * <p>
029 * Examples: No network adapter available, API endpoint is down.
030 * 
031 * @author <a href="http://restfb.com">Mark Allen</a>
032 */
033public class FacebookNetworkException extends FacebookException {
034  /**
035   * The HTTP response status code.
036   */
037  private final Integer httpStatusCode;
038
039  private static final long serialVersionUID = 1L;
040
041  private static final String MESSAGE = "Facebook request failed";
042
043  /**
044   * Creates an exception with the given message and cause.
045   * 
046   * @param cause
047   *          The exception that caused this exception to be thrown.
048   */
049  public FacebookNetworkException(Throwable cause) {
050    this(cause, null);
051  }
052
053  /**
054   * Creates an exception with the given message and HTTP status code.
055   * 
056   * @param httpStatusCode
057   *          The HTTP response status code.
058   */
059  public FacebookNetworkException(Integer httpStatusCode) {
060    this(null, httpStatusCode);
061  }
062
063  /**
064   * Creates an exception with the given message, cause, and HTTP status code.
065   * 
066   * @param cause
067   *          The exception that caused this exception to be thrown.
068   * @param httpStatusCode
069   *          The HTTP response status code.
070   */
071  public FacebookNetworkException(Throwable cause, Integer httpStatusCode) {
072    super(format("A network error occurred while trying to communicate with Facebook: %s (HTTP status code %d)",
073      MESSAGE, httpStatusCode), cause);
074    this.httpStatusCode = httpStatusCode;
075  }
076
077  /**
078   * Gets the HTTP response status code.
079   * 
080   * @return The HTTP response status code.
081   */
082  public Integer getHttpStatusCode() {
083    return httpStatusCode;
084  }
085}