play.libs.ws

Interface WSResponse

All Superinterfaces:

play.libs.ws.StandaloneWSResponse

All Known Implementing Classes:

AhcWSResponse

public interface WSResponse
extends play.libs.ws.StandaloneWSResponse

This is the WS response from the server.

Method Summary

Modifier and Type	Method and Description
byte[]	asByteArray() Gets the body as an array of bytes.
com.fasterxml.jackson.databind.JsonNode	asJson() Gets the body as JSON node.
org.w3c.dom.Document	asXml() return the body as XML.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAllHeaders() Deprecated.
java.lang.String	getBody()
<T> T	getBody(play.libs.ws.BodyReadable<T> readable) Gets the body of the response as a T, using a BodyReadable.
akka.util.ByteString	getBodyAsBytes()
akka.stream.javadsl.Source<akka.util.ByteString,?>	getBodyAsSource()
java.io.InputStream	getBodyAsStream() Deprecated. use getBody(BodyReadable) with WSBodyWritables.inputStream().
java.lang.String	getContentType()
java.util.Optional<play.libs.ws.WSCookie>	getCookie(java.lang.String name)
java.util.List<play.libs.ws.WSCookie>	getCookies()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders()
java.util.List<java.lang.String>	getHeaderValues(java.lang.String name)
java.util.Optional<java.lang.String>	getSingleHeader(java.lang.String name)
int	getStatus()
java.lang.String	getStatusText()
java.lang.Object	getUnderlying() Gets the underlying implementation response object, if any.

Method Detail

getHeaders

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

Specified by:

getHeaders in interface play.libs.ws.StandaloneWSResponse

getHeaderValues

java.util.List<java.lang.String> getHeaderValues(java.lang.String name)

Specified by:

getHeaderValues in interface play.libs.ws.StandaloneWSResponse

getSingleHeader

java.util.Optional<java.lang.String> getSingleHeader(java.lang.String name)

Specified by:

getSingleHeader in interface play.libs.ws.StandaloneWSResponse

getAllHeaders

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

Deprecated.

Gets all the headers from the response.

getUnderlying

java.lang.Object getUnderlying()

Gets the underlying implementation response object, if any.

Specified by:

getUnderlying in interface play.libs.ws.StandaloneWSResponse

getContentType

java.lang.String getContentType()

Specified by:

getContentType in interface play.libs.ws.StandaloneWSResponse

getStatus

int getStatus()

Specified by:

getStatus in interface play.libs.ws.StandaloneWSResponse

Returns:

the HTTP status code from the response.

getStatusText

java.lang.String getStatusText()

Specified by:

getStatusText in interface play.libs.ws.StandaloneWSResponse

Returns:

the text associated with the status code.

getCookies

java.util.List<play.libs.ws.WSCookie> getCookies()

Specified by:

getCookies in interface play.libs.ws.StandaloneWSResponse

Returns:

all the cookies from the response.

getCookie

java.util.Optional<play.libs.ws.WSCookie> getCookie(java.lang.String name)

Specified by:

getCookie in interface play.libs.ws.StandaloneWSResponse

Returns:

a single cookie from the response, if any.

getBody

java.lang.String getBody()

Specified by:

getBody in interface play.libs.ws.StandaloneWSResponse

Returns:

the body as a string.

getBodyAsBytes

akka.util.ByteString getBodyAsBytes()

Specified by:

getBodyAsBytes in interface play.libs.ws.StandaloneWSResponse

Returns:

the body as a ByteString

getBodyAsSource

akka.stream.javadsl.Source<akka.util.ByteString,?> getBodyAsSource()

Specified by:

getBodyAsSource in interface play.libs.ws.StandaloneWSResponse

Returns:

the body as a Source

getBody

<T> T getBody(play.libs.ws.BodyReadable<T> readable)

Gets the body of the response as a T, using a BodyReadable. See WSBodyReadables for convenient functions.

Specified by:

getBody in interface play.libs.ws.StandaloneWSResponse

Type Parameters:

T - the type to return, i.e. String.

Parameters:

readable - a transformation function from a response to a T.

Returns:

the body as an instance of T.

asXml

org.w3c.dom.Document asXml()

return the body as XML.

asJson

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

Gets the body as JSON node.

Returns:

json node.

getBodyAsStream

@Deprecated
java.io.InputStream getBodyAsStream()

Deprecated. use getBody(BodyReadable) with WSBodyWritables.inputStream().

Gets the body as a stream.

asByteArray

byte[] asByteArray()

Gets the body as an array of bytes.