Body parsers officially supported by Play (i.e. built-in to Play)
Attributes
- Companion
- object
- Graph
-
- Supertypes
- Known subtypes
-
class DefaultPlayBodyParsers
Members list
Value members
Concrete methods
If empty file uploads are allowed (no matter if filename or file is empty)
If empty file uploads are allowed (no matter if filename or file is empty)
You can configure it in application.conf:
play.http.parser.allowEmptyFiles = true
Attributes
Default max length allowed for disk based body.
Default max length allowed for disk based body.
You can configure it in application.conf:
play.http.parser.maxDiskBuffer = 512k
Attributes
Default max length allowed for text based body.
Default max length allowed for text based body.
You can configure it in application.conf:
play.http.parser.maxMemoryBuffer = 100k
Attributes
Guess the body content by checking the Content-Type header.
Guess the body content by checking the Content-Type header.
Attributes
Guess the body content by checking the Content-Type header.
Guess the body content by checking the Content-Type header.
Attributes
Buffer the body as a simple org.apache.pekko.util.ByteString.
Buffer the body as a simple org.apache.pekko.util.ByteString.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Buffer the body as a simple org.apache.pekko.util.ByteString.
Buffer the body as a simple org.apache.pekko.util.ByteString.
Will buffer up to the configured max memory buffer amount, after which point, it will return an EntityTooLarge HTTP response.
Attributes
If the request has a body, parse the body content by checking the Content-Type header.
If the request has a body, parse the body content by checking the Content-Type header.
Attributes
If the request has a body, parse the body content by checking the Content-Type header.
If the request has a body, parse the body content by checking the Content-Type header.
Attributes
Store the body content into a file.
Store the body content into a file.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
- to
-
The file used to store the content.
Attributes
Store the body content into a file.
Store the body content into a file.
Value parameters
- to
-
The file used to store the content.
Attributes
Parse the body and binds it to a given form model.
Parse the body and binds it to a given form model.
case class User(name: String)
val userForm: Form[User] = Form(mapping("name" -> nonEmptyText)(User.apply)(User.unapply))
Action(parse.form(userForm)) { request =>
Ok(s"Hello, ${request.body.name}!")
}
Value parameters
- form
-
Form model
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response. If
None, the defaultplay.http.parser.maxMemoryBufferconfiguration value is used. - onErrors
-
The result to reply in case of errors during the form binding process
Attributes
Parse the body as form url encoded if the Content-Type is application/x-www-form-urlencoded.
Parse the body as form url encoded if the Content-Type is application/x-www-form-urlencoded.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the body as form url encoded if the Content-Type is application/x-www-form-urlencoded.
Parse the body as form url encoded if the Content-Type is application/x-www-form-urlencoded.
Attributes
Parse the body as Json if the Content-Type is text/json or application/json.
Parse the body as Json if the Content-Type is text/json or application/json.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the body as Json if the Content-Type is text/json or application/json.
Parse the body as Json if the Content-Type is text/json or application/json.
Attributes
Parse the body as Json if the Content-Type is text/json or application/json, validating the result with the Json reader.
Parse the body as Json if the Content-Type is text/json or application/json, validating the result with the Json reader.
Type parameters
- A
-
the type to read and validate from the body.
Value parameters
- reader
-
a Json reader for type A.
Attributes
Parse the content as multipart/form-data
Parse the content as multipart/form-data
Attributes
Parse the content as multipart/form-data
Parse the content as multipart/form-data
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the content as multipart/form-data
Parse the content as multipart/form-data
Value parameters
- allowEmptyFiles
-
If empty file uploads are allowed (no matter if filename or file is empty)
Attributes
Parse the content as multipart/form-data
Parse the content as multipart/form-data
Value parameters
- allowEmptyFiles
-
If empty file uploads are allowed (no matter if filename or file is empty)
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the content as multipart/form-data
Parse the content as multipart/form-data
Value parameters
- allowEmptyFiles
-
If empty file uploads are allowed (no matter if filename or file is empty)
- filePartHandler
-
Handles file parts.
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
- See also
Store the body content in a RawBuffer.
Store the body content in a RawBuffer.
Value parameters
- memoryThreshold
-
If the content size is bigger than this limit, the content is stored as file.
Attributes
- See also
Store the body content in a RawBuffer.
Store the body content in a RawBuffer.
Attributes
Store the body content into a temporary file.
Store the body content into a temporary file.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Store the body content into a temporary file.
Store the body content into a temporary file.
Attributes
Parse the body as text if the Content-Type is text/plain.
Parse the body as text if the Content-Type is text/plain.
If the charset is not explicitly declared, then the default "charset" parameter value is US-ASCII, per https://tools.ietf.org/html/rfc6657#section-4. Use tolerantText if more flexible character decoding is desired.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the body as text if the Content-Type is text/plain.
Parse the body as text if the Content-Type is text/plain.
Attributes
Parse the body as Form url encoded without checking the Content-Type.
Parse the body as Form url encoded without checking the Content-Type.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the body as form url encoded without checking the Content-Type.
Parse the body as form url encoded without checking the Content-Type.
Attributes
Parse the body as Json without checking the Content-Type.
Parse the body as Json without checking the Content-Type.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the body as Json without checking the Content-Type.
Parse the body as Json without checking the Content-Type.
Attributes
Parse the body as Json without checking the Content-Type, validating the result with the Json reader.
Parse the body as Json without checking the Content-Type, validating the result with the Json reader.
Type parameters
- A
-
the type to read and validate from the body.
Value parameters
- reader
-
a Json reader for type A.
Attributes
Parses the body as text without checking the Content-Type.
Parses the body as text without checking the Content-Type.
Will attempt to parse content with an explicit charset, but will fallback to UTF-8, ISO-8859-1, and finally US-ASCII if incorrect characters are detected.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the body as text without checking the Content-Type.
Parse the body as text without checking the Content-Type.
Attributes
Parse the body as Xml without checking the Content-Type.
Parse the body as Xml without checking the Content-Type.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the body as Xml without checking the Content-Type.
Parse the body as Xml without checking the Content-Type.
Attributes
Parse the body as Xml if the Content-Type is application/xml, text/xml or application/XXX+xml.
Parse the body as Xml if the Content-Type is application/xml, text/xml or application/XXX+xml.
Value parameters
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
Parse the body as Xml if the Content-Type is application/xml, text/xml or application/XXX+xml.
Parse the body as Xml if the Content-Type is application/xml, text/xml or application/XXX+xml.
Attributes
Deprecated methods
Parse the content as multipart/form-data
Parse the content as multipart/form-data
Value parameters
- filePartHandler
-
Handles file parts.
- maxLength
-
Max length (in bytes) allowed or returns EntityTooLarge HTTP response.
Attributes
- See also
- Deprecated
-
Since 2.9.0. Use the overloaded multipartFormData method that takes the allowEmptyFiles flag.
Inherited methods
Don't parse the body content.
A body parser that always returns an error.
A body parser that flattens a future BodyParser.
Attributes
- Inherited from:
- BodyParserUtils
Wrap an existing BodyParser with a maxLength constraints.
Wrap an existing BodyParser with a maxLength constraints.
Value parameters
- maxLength
-
The max length allowed
- parser
-
The BodyParser to wrap
Attributes
- Inherited from:
- BodyParserUtils
Allows to choose the right BodyParser parser to use by examining the request headers.
Allows to choose the right BodyParser parser to use by examining the request headers.
Attributes
- Inherited from:
- BodyParserUtils
Creates a conditional BodyParser.