play.api.mvc.BodyParsers

parse

object parse extends AnyRef

Default body parsers.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. parse
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. lazy val DEFAULT_MAX_TEXT_LENGTH : Int

    Default max length allowed for text based body.

    Default max length allowed for text based body.

    You can configure it in application.conf:

    parsers.text.maxLength = 512k
    
  7. object Multipart extends AnyRef

  8. val UNLIMITED : Int

    Unlimited size.

  9. def anyContent : BodyParser[AnyContent]

    Guess the body content by checking the Content-Type header.

  10. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  11. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. def empty : BodyParser[Option[Any]]

    Don't parse the body content.

  13. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  14. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  15. def error [A] (result: Result): BodyParser[A]

    A body parser that always returns an error.

  16. def file (to: File): BodyParser[File]

    Store the body content into a file.

    Store the body content into a file.

    to

    The file used to store the content.

  17. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  18. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  19. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  20. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  21. def json : BodyParser[JsValue]

    Parse the body as Json if the Content-Type is text/json or application/json.

  22. def json (maxLength: Int): BodyParser[JsValue]

    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.

    maxLength

    Max length allowed or returns EntityTooLarge HTTP response.

  23. def maxLength [A] (maxLength: Int, parser: BodyParser[A]): BodyParser[Either[MaxSizeExceeded, A]]

    Wrap an existing BodyParser with a maxLength constraints.

    Wrap an existing BodyParser with a maxLength constraints.

    maxLength

    The max length allowed

    parser

    The BodyParser to wrap

  24. def multipartFormData [A] (filePartHandler: PartHandler[FilePart[A]]): BodyParser[MultipartFormData[A]]

    Parse the content as multipart/form-data

    Parse the content as multipart/form-data

    filePartHandler

    Handles file parts.

  25. def multipartFormData : BodyParser[MultipartFormData[TemporaryFile]]

    Parse the content as multipart/form-data

  26. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  27. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  28. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  29. def raw : BodyParser[RawBuffer]

    Store the body content in a RawBuffer.

  30. def raw (memoryThreshold: Int): BodyParser[RawBuffer]

    Store the body content in a RawBuffer.

    Store the body content in a RawBuffer.

    memoryThreshold

    If the content size is bigger than this limit, the content is stored as file.

  31. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  32. def temporaryFile : BodyParser[TemporaryFile]

    Store the body content into a temporary file.

  33. def text : BodyParser[String]

    Parse the body as text if the Content-Type is text/plain.

  34. def text (maxLength: Int): BodyParser[String]

    Parse the body as text if the Content-Type is text/plain.

    Parse the body as text if the Content-Type is text/plain.

    maxLength

    Max length allowed or returns EntityTooLarge HTTP response.

  35. def toString (): String

    Definition Classes
    AnyRef → Any
  36. def tolerantFormUrlEncoded : BodyParser[Map[String, Seq[String]]]

    Parse the body as form url encoded without checking the Content-Type.

  37. def tolerantFormUrlEncoded (maxLength: Int): BodyParser[Map[String, Seq[String]]]

    Parse the body as Form url encoded without checking the Content-Type.

    Parse the body as Form url encoded without checking the Content-Type.

    maxLength

    Max length allowed or returns EntityTooLarge HTTP response.

  38. def tolerantJson : BodyParser[JsValue]

    Parse the body as Json without checking the Content-Type.

  39. def tolerantJson (maxLength: Int): BodyParser[JsValue]

    Parse the body as Json without checking the Content-Type.

    Parse the body as Json without checking the Content-Type.

    maxLength

    Max length allowed or returns EntityTooLarge HTTP response.

  40. def tolerantText : BodyParser[String]

    Parse the body as text without checking the Content-Type.

  41. def tolerantText (maxLength: Int): BodyParser[String]

    Parse the body as text without checking the Content-Type.

    Parse the body as text without checking the Content-Type.

    maxLength

    Max length allowed or returns EntityTooLarge HTTP response.

  42. def tolerantXml : BodyParser[NodeSeq]

    Parse the body as Xml without checking the Content-Type.

  43. def tolerantXml (maxLength: Int): BodyParser[NodeSeq]

    Parse the body as Xml without checking the Content-Type.

    Parse the body as Xml without checking the Content-Type.

    maxLength

    Max length allowed or returns EntityTooLarge HTTP response.

  44. def urlFormEncoded : BodyParser[Map[String, Seq[String]]]

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

  45. def urlFormEncoded (maxLength: Int): BodyParser[Map[String, Seq[String]]]

    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.

    maxLength

    Max length allowed or returns EntityTooLarge HTTP response.

  46. def using [A] (f: (RequestHeader) ⇒ BodyParser[A]): BodyParser[A]

    Allow to choose the right BodyParser parser to use by examining the request headers.

  47. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  48. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  49. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  50. def when [A] (predicate: (RequestHeader) ⇒ Boolean, parser: BodyParser[A], badResult: (RequestHeader) ⇒ Result): BodyParser[A]

    Create a conditional BodyParser.

  51. def xml : BodyParser[NodeSeq]

    Parse the body as Xml if the Content-Type is text/xml.

  52. def xml (maxLength: Int): BodyParser[NodeSeq]

    Parse the body as Xml if the Content-Type is text/xml.

    Parse the body as Xml if the Content-Type is text/xml.

    maxLength

    Max length allowed or returns EntityTooLarge HTTP response.

Inherited from AnyRef

Inherited from Any