play.libs.ws.ahc

Class StandaloneAhcWSResponse

java.lang.Object

play.libs.ws.ahc.StandaloneAhcWSResponse

All Implemented Interfaces:

StandaloneWSResponse

public class StandaloneAhcWSResponse
extends java.lang.Object
implements StandaloneWSResponse

A WS response.

Constructor Summary

Constructors

Constructor and Description
StandaloneAhcWSResponse(play.shaded.ahc.org.asynchttpclient.Response ahcResponse)
StandaloneAhcWSResponse(play.shaded.ahc.org.asynchttpclient.Response ahcResponse, com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method and Description
byte[]	asByteArray() Get the response body as a byte array
com.fasterxml.jackson.databind.JsonNode	asJson() Get the response body as a JsonNode
org.w3c.dom.Document	asXml() Get the response body as a DOM document
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAllHeaders() Get all the HTTP headers of the response as a case-insensitive map
java.lang.String	getBody()
java.io.InputStream	getBodyAsStream() Get the response body as a stream
WSCookie	getCookie(java.lang.String name) Get only one cookie, using the cookie name.
java.util.List<WSCookie>	getCookies() Get all the cookies.
java.lang.String	getHeader(java.lang.String key) Get the given HTTP header of the response
int	getStatus() Get the HTTP status code of the response
java.lang.String	getStatusText() Get the HTTP status text of the response
java.lang.Object	getUnderlying()
java.net.URI	getUri() Return the request URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandaloneAhcWSResponse

public StandaloneAhcWSResponse(play.shaded.ahc.org.asynchttpclient.Response ahcResponse,
                               com.fasterxml.jackson.databind.ObjectMapper mapper)

StandaloneAhcWSResponse

public StandaloneAhcWSResponse(play.shaded.ahc.org.asynchttpclient.Response ahcResponse)

Method Detail

getUnderlying

public java.lang.Object getUnderlying()

Specified by:

getUnderlying in interface StandaloneWSResponse

Returns:

the underlying implementation response object, if any.

getStatus

public int getStatus()

Get the HTTP status code of the response

Specified by:

getStatus in interface StandaloneWSResponse

Returns:

the HTTP status code from the response.

getStatusText

public java.lang.String getStatusText()

Get the HTTP status text of the response

Specified by:

getStatusText in interface StandaloneWSResponse

Returns:

the text associated with the status code.

getAllHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllHeaders()

Get all the HTTP headers of the response as a case-insensitive map

Specified by:

getAllHeaders in interface StandaloneWSResponse

Returns:

all the headers from the response.

getHeader

public java.lang.String getHeader(java.lang.String key)

Get the given HTTP header of the response

Specified by:

getHeader in interface StandaloneWSResponse

Parameters:

key - the header's name

Returns:

a single header value from the response.

getCookies

public java.util.List<WSCookie> getCookies()

Get all the cookies.

Specified by:

getCookies in interface StandaloneWSResponse

Returns:

all the cookies from the response.

getCookie

public WSCookie getCookie(java.lang.String name)

Get only one cookie, using the cookie name.

Specified by:

getCookie in interface StandaloneWSResponse

Parameters:

name - the cookie name

Returns:

a single cookie from the response, if any.

getBody

public java.lang.String getBody()

Specified by:

getBody in interface StandaloneWSResponse

Returns:

the body as a string.

asXml

public org.w3c.dom.Document asXml()

Get the response body as a DOM document

Specified by:

asXml in interface StandaloneWSResponse

Returns:

a DOM document

asJson

public com.fasterxml.jackson.databind.JsonNode asJson()

Get the response body as a JsonNode

Specified by:

asJson in interface StandaloneWSResponse

Returns:

the json response

getBodyAsStream

public java.io.InputStream getBodyAsStream()

Get the response body as a stream

Specified by:

getBodyAsStream in interface StandaloneWSResponse

Returns:

The stream to read the response body from

asByteArray

public byte[] asByteArray()

Get the response body as a byte array

Specified by:

asByteArray in interface StandaloneWSResponse

Returns:

The byte array

getUri

public java.net.URI getUri()

Return the request URI. Note that if the request got redirected, the value of the URI will be the last valid redirect url.

Specified by:

getUri in interface StandaloneWSResponse

Returns:

the request URI.