Package play.libs.ws

Class HttpResponse

java.lang.Object
play.libs.ws.HttpResponse
Direct Known Subclasses:
DummyHttpResponse, HttpAsyncResponse
public abstract class HttpResponse extends Object
An HTTP response wrapper

  • Constructor Details

    • HttpResponse

      public HttpResponse()

  • Method Details

    • getStatus

      public abstract Integer getStatus()
      the HTTP status code
      Returns:
      the status code of the http response

    • getStatusText

      public abstract String getStatusText()
      The HTTP status text
      Returns:
      the status text of the http response

    • success

      public boolean success()
      Returns:
      true if the status code is 20x, false otherwise

    • getContentType

      public String getContentType()
      The http response content type
      Returns:
      the content type of the http response

    • getEncoding

      public Charset getEncoding()

    • getHeader

      @Nullable public abstract String getHeader(String key)

    • getHeaders

      public abstract List<Http.Header> getHeaders()

    • getXml

      public Document getXml()
      Parse and get the response body as a DOM document
      Returns:
      a DOM document

    • getXml

      public Document getXml(Charset encoding)
      parse and get the response body as a DOM document
      Parameters:
      encoding - xml charset encoding
      Returns:
      a DOM document

    • getString

      public abstract String getString()
      get the response body as a string
      Returns:
      the body of the http response

    • getString

      public abstract String getString(Charset encoding)
      get the response body as a string
      Parameters:
      encoding - string charset encoding
      Returns:
      the body of the http response

    • getQueryString

      public Map<String,String> getQueryString()
      Parse the response string as a query string.
      Returns:
      The parameters as a Map. Return an empty map if the response is not formed as a query string.

    • getStream

      public abstract InputStream getStream()
      get the response as a stream

      + this method can only be called onced because async implementation does not allow it to be called + multiple times +

      Returns:
      an inputstream

    • getJson

      public com.google.gson.JsonElement getJson()
      get the response body as a JsonElement
      Returns:
      the json response