com.github.fracpete.requests4j.response.AbstractResponse Maven / Gradle / Ivy

Go to download
/*
 * AbstractResponse.java
 * Copyright (C) 2019-2020 University of Waikato, Hamilton, NZ
 */

package com.github.fracpete.requests4j.response;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Ancestor for Response classes.
 *
 * @author FracPete (fracpete at waikato dot ac dot nz)
 */
public class AbstractResponse
  implements Serializable, Response {

  /** the raw response. */
  protected okhttp3.Response m_RawResponse;

  /** the status code. */
  protected int m_StatusCode;

  /** the status message. */
  protected String m_StatusMessage;

  /** the headers. */
  protected Map> m_Headers;

  /**
   * Initializes the response.
   */
  public AbstractResponse() {
    m_RawResponse   = null;
    m_StatusCode    = 200;
    m_StatusMessage = "";
    m_Headers       = new HashMap<>();
  }

  /**
   * Initializes the response object.
   *
   * @param response		the response
   */
  @Override
  public void init(okhttp3.Response response) {
    m_RawResponse   = response;
    m_StatusCode    = response.code();
    m_StatusMessage = response.message();
    m_Headers.clear();
    for (String header: response.headers().names()) {
      if (!m_Headers.containsKey(header))
        m_Headers.put(header, new ArrayList<>());
      m_Headers.get(header).add(response.header(header));
    }
  }

  /**
   * Returns the underlying, raw response.
   *
   * @return		the response
   */
  @Override
  public okhttp3.Response rawResponse() {
    return m_RawResponse;
  }

  /**
   * Returns the response headers.
   *
   * @return		the headers
   */
  public Map> headers() {
    return m_Headers;
  }

  /**
   * Returns the HTTP status code.
   *
   * @return		the code
   */
  @Override
  public int statusCode() {
    return m_StatusCode;
  }

  /**
   * Returns the HTTP status message.
   *
   * @return		the message
   */
  @Override
  public String statusMessage() {
    return m_StatusMessage;
  }

  /**
   * Whether the request has a code of less than 400.
   *
   * @return		true if <400
   */
  @Override
  public boolean ok() {
    return (statusCode() < 400);
  }

  /**
   * Outputs a short description of the response.
   *
   * @return		the description
   */
  @Override
  public String toString() {
    return "status code: " + statusCode() + ", status message: " + statusMessage();
  }
}