play.mvc

Class BodyParser.FormUrlEncoded

java.lang.Object

play.mvc.BodyParser.MaxLengthBodyParser<A>

play.mvc.BodyParser.BufferingBodyParser<java.util.Map<java.lang.String,java.lang.String[]>>

play.mvc.BodyParser.FormUrlEncoded

All Implemented Interfaces:

BodyParser<java.util.Map<java.lang.String,java.lang.String[]>>

Enclosing interface:

BodyParser<A>

public static class BodyParser.FormUrlEncoded
extends BodyParser.BufferingBodyParser<java.util.Map<java.lang.String,java.lang.String[]>>

Parse the body as form url encoded if the Content-Type is application/x-www-form-urlencoded.

Nested Class Summary

Nested classes/interfaces inherited from interface play.mvc.BodyParser

BodyParser.AnyContent, BodyParser.BufferingBodyParser<A>, BodyParser.Bytes, BodyParser.CompletableBodyParser<A>, BodyParser.Default, BodyParser.DelegatingBodyParser<A,B>, BodyParser.DelegatingMultipartFormDataBodyParser<A>, BodyParser.Empty, BodyParser.FormUrlEncoded, BodyParser.Json, BodyParser.MaxLengthBodyParser<A>, BodyParser.MultipartFormData, BodyParser.Of, BodyParser.Raw, BodyParser.Text, BodyParser.TolerantJson, BodyParser.TolerantText, BodyParser.TolerantXml, BodyParser.Xml

Constructor Summary

Constructors

Constructor and Description
FormUrlEncoded(play.api.http.HttpConfiguration httpConfiguration, HttpErrorHandler errorHandler)
FormUrlEncoded(long maxLength, HttpErrorHandler errorHandler)

Method Summary

Modifier and Type	Method and Description
Accumulator<akka.util.ByteString,F.Either<Result,java.util.Map<java.lang.String,java.lang.String[]>>>	apply(Http.RequestHeader request) Return an accumulator to parse the body of the given HTTP request.
protected java.util.Map<java.lang.String,java.lang.String[]>	parse(Http.RequestHeader request, akka.util.ByteString bytes) Parse the body.

Methods inherited from class play.mvc.BodyParser.BufferingBodyParser

apply1

Methods inherited from class java.lang.Object

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

Constructor Detail

FormUrlEncoded

public FormUrlEncoded(long maxLength,
                      HttpErrorHandler errorHandler)

FormUrlEncoded

@Inject
public FormUrlEncoded(play.api.http.HttpConfiguration httpConfiguration,
                              HttpErrorHandler errorHandler)

Method Detail

apply

public Accumulator<akka.util.ByteString,F.Either<Result,java.util.Map<java.lang.String,java.lang.String[]>>> apply(Http.RequestHeader request)

Description copied from interface: BodyParser

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.

Specified by:

apply in interface BodyParser<java.util.Map<java.lang.String,java.lang.String[]>>

Overrides:

apply in class BodyParser.MaxLengthBodyParser<java.util.Map<java.lang.String,java.lang.String[]>>

Parameters:

request - The request to create the body parser for.

Returns:

The accumulator to parse the body.

parse

protected java.util.Map<java.lang.String,java.lang.String[]> parse(Http.RequestHeader request,
                                                                   akka.util.ByteString bytes)
                                                            throws java.lang.Exception

Description copied from class: BodyParser.BufferingBodyParser

Parse the body.

Specified by:

parse in class BodyParser.BufferingBodyParser<java.util.Map<java.lang.String,java.lang.String[]>>

Parameters:

request - The request associated with the body.

bytes - The bytes of the body.

Returns:

The body.

Throws:

java.lang.Exception - If the body failed to parse. It is assumed that any exceptions thrown by this method are the fault of the client, so a 400 bad request error will be returned if this method throws an exception.