RequestNotOkException.java

/*-
 * -\-\-
 * github-api
 * --
 * Copyright (C) 2016 - 2020 Spotify AB
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * -/-/-
 */

/**
 * Copyright 2016 Spotify AB. All rights reserved.
 *
 * <p>The contents of this file are licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy of the
 * License at
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.spotify.github.v3.exceptions;

import java.util.List;
import java.util.Map;

/** HTTP response with non-200 StatusCode. */
public class RequestNotOkException extends GithubException {
  private static final long serialVersionUID = 1L;


  private final int statusCode;
  private final String method;
  private final String path;
  private final String msg;
  private final Map<String, List<String>> headers;

  private static String decoratedMessage(
      final String method, final String path, final int statusCode, final String msg) {
    return String.format("%s %s %d: %s", method, path, statusCode, msg);
  }

  /**
   * Response to request came back with non-2xx status code
   *
   * @param method HTTP method
   * @param path URI path
   * @param statusCode status of repsonse
   * @param msg response body
   */
  public RequestNotOkException(
      final String method, final String path, final int statusCode, final String msg, final Map<String, List<String>> headers) {
    super(decoratedMessage(method, path, statusCode, msg));
    this.statusCode = statusCode;
    this.method = method;
    this.path = path;
    this.msg = msg;
    this.headers = headers;
  }

  /**
   * Get the raw message from github
   *
   * @return msg
   */
  public String getRawMessage() {
    return msg;
  }

  /**
   * Get the status code of the response
   *
   * @return status
   */
  public int statusCode() {
    return statusCode;
  }

  /**
   * Get request HTTP method
   *
   * @return method
   */
  public String method() {
    return method;
  }

  /**
   * Get request URI path
   *
   * @return path
   */
  public String path() {
    return path;
  }

  /**
   * Get response headers
   *
   * @return headers
   */
  public Map<String, List<String>> headers() {
    return headers;
  }
}