play.libs.ws.WSResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of play-ws_3 Show documentation
Play-WS
The newest version!
/*
 * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. 
 */

package play.libs.ws;

import com.fasterxml.jackson.databind.JsonNode;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import org.apache.pekko.stream.javadsl.Source;
import org.apache.pekko.util.ByteString;
import org.w3c.dom.Document;

/** This is the WS response from the server. */
public interface WSResponse extends StandaloneWSResponse {

  @Override
  Map> getHeaders();

  @Override
  List getHeaderValues(String name);

  @Override
  Optional getSingleHeader(String name);

  /** Gets all the headers from the response. */
  @Deprecated
  Map> getAllHeaders();

  /** Gets the underlying implementation response object, if any. */
  @Override
  Object getUnderlying();

  @Override
  String getContentType();

  /** @return the HTTP status code from the response. */
  @Override
  int getStatus();

  /** @return the text associated with the status code. */
  @Override
  String getStatusText();

  /** @return all the cookies from the response. */
  @Override
  List getCookies();

  /** @return a single cookie from the response, if any. */
  @Override
  Optional getCookie(String name);

  // ----------------------------------
  // Body methods
  // ----------------------------------

  /** @return the body as a string. */
  @Override
  String getBody();

  /** @return the body as a ByteString */
  @Override
  ByteString getBodyAsBytes();

  /** @return the body as a Source */
  @Override
  Source getBodyAsSource();

  /**
   * Gets the body of the response as a T, using a {@link BodyReadable}.
   *
   * See {@link WSBodyReadables} for convenient functions.
   *
   * @param readable a transformation function from a response to a T.
   * @param  the type to return, i.e. String.
   * @return the body as an instance of T.
   */
  @Override
   T getBody(BodyReadable readable);

  /** return the body as XML. */
  Document asXml();

  /**
   * Gets the body as JSON node.
   *
   * @return json node.
   */
  JsonNode asJson();

  /**
   * Gets the body as a stream.
   *
   * @deprecated use {@link #getBody(BodyReadable)} with {@code WSBodyWritables.inputStream()}.
   */
  @Deprecated
  InputStream getBodyAsStream();

  /** Gets the body as an array of bytes. */
  byte[] asByteArray();
}