play.mvc

Interface BodyParser<A>

All Known Implementing Classes:

BodyParser.AnyContent, BodyParser.BufferingBodyParser, BodyParser.Bytes, BodyParser.Default, BodyParser.DelegatingBodyParser, BodyParser.Empty, BodyParser.FormUrlEncoded, BodyParser.Json, BodyParser.MaxLengthBodyParser, BodyParser.MultipartFormData, BodyParser.Raw, BodyParser.Text, BodyParser.TolerantJson, BodyParser.TolerantText, BodyParser.TolerantXml, BodyParser.Xml

public interface BodyParser<A>

A body parser parses the HTTP request body content.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BodyParser.AnyContent Guess the body content by checking the Content-Type header.
static class	BodyParser.BufferingBodyParser<A> A body parser that first buffers
static class	BodyParser.Bytes Parse the body as a byte string.
static class	BodyParser.Default If PATCH, POST, or PUT, guess the body content by checking the Content-Type header.
static class	BodyParser.DelegatingBodyParser<A,B> A body parser that delegates to a Scala body parser, and uses the supplied function to transform its result to a Java body.
static class	BodyParser.Empty Don't parse the body.
static class	BodyParser.FormUrlEncoded Parse the body as form url encoded if the Content-Type is application/x-www-form-urlencoded.
static class	BodyParser.Json Parse the body as Json if the Content-Type is text/json or application/json.
static class	BodyParser.MaxLengthBodyParser<A> Abstract body parser that enforces a maximum length.
static class	BodyParser.MultipartFormData Parse the body as multipart form-data without checking the Content-Type.
static interface	BodyParser.Of Specify the body parser to use for an Action method.
static class	BodyParser.Raw Store the body content in a RawBuffer.
static class	BodyParser.Text Parse the body as text if the Content-Type is text/plain.
static class	BodyParser.TolerantJson Parse the body as Json without checking the Content-Type.
static class	BodyParser.TolerantText Parse the body as text without checking the Content-Type.
static class	BodyParser.TolerantXml Parse the body as Xml without checking the Content-Type.
static class	BodyParser.Xml Parse the body as Xml if the Content-Type is application/xml.

Method Summary

Modifier and Type	Method and Description
Accumulator<akka.util.ByteString,F.Either<Result,A>>	apply(Http.RequestHeader request) Return an accumulator to parse the body of the given HTTP request.

Method Detail

apply

Accumulator<akka.util.ByteString,F.Either<Result,A>> apply(Http.RequestHeader request)

Return an accumulator to parse the body of the given HTTP request. The accumulator should either produce a result if an error was encountered, or the parsed body.

Parameters:

request - The request to create the body parser for.

Returns:

The accumulator to parse the body.