play.mvc

Class Http.RequestBody

java.lang.Object

play.mvc.Http.RequestBody

Enclosing class:

Http

public static final class Http.RequestBody
extends Object

The request body.

Constructor Summary

Constructors

Constructor and Description
RequestBody(Object body)

Method Summary

Modifier and Type	Method and Description
<T> T	as(Class<T> tType) Cast this RequestBody as T if possible.
ByteString	asBytes() The request content as a ByteString.
Map<String,String[]>	asFormUrlEncoded() The request content parsed as URL form-encoded.
com.fasterxml.jackson.databind.JsonNode	asJson() The request content as Json.
<A> Http.MultipartFormData<A>	asMultipartFormData() The request content parsed as multipart form data.
Http.RawBuffer	asRaw() The request content as Array bytes.
String	asText() The request content as text.
Document	asXml() The request content as XML.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestBody

public RequestBody(Object body)

Method Detail

asMultipartFormData

public <A> Http.MultipartFormData<A> asMultipartFormData()

The request content parsed as multipart form data.

Type Parameters:

A - the file type (e.g. play.api.libs.Files.TemporaryFile)

Returns:

the content parsed as multipart form data

asFormUrlEncoded

public Map<String,String[]> asFormUrlEncoded()

The request content parsed as URL form-encoded.

Returns:

the request content parsed as URL form-encoded.

asRaw

public Http.RawBuffer asRaw()

The request content as Array bytes.

Returns:

The request content as Array bytes.

asText

public String asText()

The request content as text.

Returns:

The request content as text.

asXml

public Document asXml()

The request content as XML.

Returns:

The request content as XML.

asJson

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

The request content as Json.

Returns:

The request content as Json.

asBytes

public ByteString asBytes()

The request content as a ByteString. This makes a best effort attempt to convert the parsed body to a ByteString, if it knows how. This includes String, json, XML and form bodies. It doesn't include multipart/form-data or raw bodies that don't fit in the configured max memory buffer, nor does it include custom output types from custom body parsers.

Returns:

the request content as a ByteString

as

public <T> T as(Class<T> tType)

Cast this RequestBody as T if possible.

Type Parameters:

T - type of the provided tType

Parameters:

tType - class that we are trying to cast the body as

Returns:

either a successful cast into T or null

toString

public String toString()

Overrides:

toString in class Object