Packages

final case class Request(method: Method = Method.GET, uri: Uri = Uri(path = "/"), httpVersion: HttpVersion = HttpVersion.`HTTP/1.1`, headers: Headers = Headers.empty, body: EntityBody = EmptyBody, attributes: AttributeMap = AttributeMap.empty) extends Message with RequestOps with Product with Serializable

Representation of an incoming HTTP message

A Request encapsulates the entirety of the incoming HTTP request including the status line, headers, and a possible request body.

method

Method.GET, Method.POST, etc.

uri

representation of the request URI

httpVersion

the HTTP version

headers

collection of Headers

body

scalaz.stream.Process[Task,Chunk] defining the body of the request

attributes

Immutable Map used for carrying additional information in a type safe fashion

Source
Message.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, RequestOps, Message, MessageOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Request
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RequestOps
  7. Message
  8. MessageOps
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Request(method: Method = Method.GET, uri: Uri = Uri(path = "/"), httpVersion: HttpVersion = HttpVersion.`HTTP/1.1`, headers: Headers = Headers.empty, body: EntityBody = EmptyBody, attributes: AttributeMap = AttributeMap.empty)

    method

    Method.GET, Method.POST, etc.

    uri

    representation of the request URI

    httpVersion

    the HTTP version

    headers

    collection of Headers

    body

    scalaz.stream.Process[Task,Chunk] defining the body of the request

    attributes

    Immutable Map used for carrying additional information in a type safe fashion

Type Members

  1. type Self = Request
    Definition Classes
    Request → Message → MessageOps

Value Members

  1. final def addCookie(name: String, content: String, expires: Option[Instant] = None): Self

    Add a Cookie header with the provided values

    Add a Cookie header with the provided values

    Definition Classes
    RequestOps
  2. final def addCookie(cookie: Cookie): Self

    Add a Cookie header for the provided Cookie

    Add a Cookie header for the provided Cookie

    Definition Classes
    RequestOps
  3. final def as[T](implicit decoder: EntityDecoder[T]): Task[T]

    Decode the Message to the specified type

    Decode the Message to the specified type

    If no valid Status has been described, allow Ok

    T

    type of the result

    decoder

    EntityDecoder used to decode the Message

    returns

    the Task which will generate the T

    Definition Classes
    MessageOps
  4. def attemptAs[T](implicit decoder: EntityDecoder[T]): DecodeResult[T]

    Decode the Message to the specified type

    Decode the Message to the specified type

    T

    type of the result

    decoder

    EntityDecoder used to decode the Message

    returns

    the Task which will generate the DecodeResult[T]

    Definition Classes
    Message → MessageOps
  5. val attributes: AttributeMap
    Definition Classes
    Request → Message
  6. lazy val authType: Option[AuthScheme]
  7. val body: EntityBody
    Definition Classes
    Request → Message
  8. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Process[Task, String]
    Definition Classes
    Message
  9. def charset: Option[Charset]

    Returns the charset parameter of the Content-Type header, if present.

    Returns the charset parameter of the Content-Type header, if present. Does not introspect the body for media types that define a charset internally.

    Definition Classes
    Message
  10. def contentLength: Option[Long]
    Definition Classes
    Message
  11. def contentType: Option[Content-Type]
    Definition Classes
    Message
  12. final def decode[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

    Helper method for decoding Requests

    Helper method for decoding Requests

    Attempt to decode the Request and, if successful, execute the continuation to get a Response. If decoding fails, an UnprocessableEntity Response is generated.

    Definition Classes
    RequestOps
  13. final def decodeStrict[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

    Helper method for decoding Requests

    Helper method for decoding Requests

    Attempt to decode the Request and, if successful, execute the continuation to get a Response. If decoding fails, an UnprocessableEntity Response is generated. If the decoder does not support the MediaType of the Request, a UnsupportedMediaType Response is generated instead.

    Definition Classes
    RequestOps
  14. def decodeWith[A](decoder: EntityDecoder[A], strict: Boolean)(f: (A) ⇒ Task[Response]): Task[Response]

    Like decode, but with an explicit decoder.

    Like decode, but with an explicit decoder.

    strict

    If strict, will return a Status.UnsupportedMediaType http Response if this message's MediaType is not supported by the provided decoder

    Definition Classes
    Request → RequestOps
  15. final def filterHeaders(f: (Header) ⇒ Boolean): Self

    Remove headers that satisfy the predicate

    Remove headers that satisfy the predicate

    f

    predicate

    returns

    a new message object which lacks the specified headers

    Definition Classes
    MessageOps
  16. val headers: Headers
    Definition Classes
    Request → Message
  17. val httpVersion: HttpVersion
    Definition Classes
    Request → Message
  18. def isBodyPure: Boolean

    True if and only if the body is composed solely of Emits and Halt.

    True if and only if the body is composed solely of Emits and Halt. This indicates that the body can be re-run without side-effects.

    Definition Classes
    Message
  19. def isChunked: Boolean
    Definition Classes
    Message
  20. def isIdempotent: Boolean

    A request is idempotent if and only if its method is idempotent and its body is pure.

    A request is idempotent if and only if its method is idempotent and its body is pure. If true, this request can be submitted multipe times.

  21. lazy val isSecure: Option[Boolean]

    Whether the Request was received over a secure medium

  22. val method: Method
  23. def multiParams: Map[String, Seq[String]]

    Representation of the query string as a map

    Representation of the query string as a map

    In case a parameter is available in query string but no value is there the sequence will be empty. If the value is empty the the sequence contains an empty string.

    Examples

    Query StringMap
    ?param=vMap("param" -> Seq("v"))
    ?param=Map("param" -> Seq(""))
    ?paramMap("param" -> Seq())
    ?=valueMap("" -> Seq("value"))
    ?p1=v1&p1=v2&p2=v3&p2=v3Map("p1" -> Seq("v1","v2"), "p2" -> Seq("v3","v4"))

    The query string is lazily parsed. If an error occurs during parsing an empty Map is returned.

  24. def params: Map[String, String]

    View of the head elements of the URI parameters in query string.

    View of the head elements of the URI parameters in query string.

    In case a parameter has no value the map returns an empty string.

    See also

    multiParams

  25. lazy val pathInfo: String
  26. lazy val pathTranslated: Option[File]
  27. final def putHeaders(headers: Header*): Self

    Add the provided headers to the existing headers, replacing those of the same header name The passed headers are assumed to contain no duplicate Singleton headers.

    Add the provided headers to the existing headers, replacing those of the same header name The passed headers are assumed to contain no duplicate Singleton headers.

    Definition Classes
    MessageOps
  28. def queryString: String
  29. lazy val remote: Option[InetSocketAddress]
  30. lazy val remoteAddr: Option[String]
  31. lazy val remoteHost: Option[String]
  32. lazy val remotePort: Option[Int]
  33. lazy val remoteUser: Option[String]
  34. final def removeHeader(key: HeaderKey): Self
    Definition Classes
    MessageOps
  35. final def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  36. final def replaceAllHeaders(headers: Headers): Self

    Replaces the Headers of the incoming Request object

    Replaces the Headers of the incoming Request object

    headers

    Headers containing the desired headers

    returns

    a new Request object

    Definition Classes
    MessageOps
  37. lazy val scriptName: String
  38. lazy val server: Option[InetSocketAddress]
  39. lazy val serverAddr: String
  40. lazy val serverPort: Int
  41. def serverSoftware: ServerSoftware
  42. def toString(): String
    Definition Classes
    Request → AnyRef → Any
  43. def trailerHeaders: Task[Headers]

    The trailer headers, as specified in Section 3.6.1 of RFC 2616.

    The trailer headers, as specified in Section 3.6.1 of RFC 2616. The resulting task might not complete unless the entire body has been consumed.

    Definition Classes
    Message
  44. def transformHeaders(f: (Headers) ⇒ Headers): Self
    Definition Classes
    Message → MessageOps
  45. val uri: Uri
  46. def withAttribute[A](key: AttributeKey[A], value: A): Self

    Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap

    Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap

    A

    type of the value to store

    key

    AttributeKey with which to associate the value

    value

    value associated with the key

    returns

    a new message object with the key/value pair appended

    Definition Classes
    Message → MessageOps
  47. def withAttribute[V](entry: AttributeEntry[V]): Self

    Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap

    Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap

    V

    type of the value to store

    entry

    AttributeEntry entry to add

    returns

    a new message object with the key/value pair appended

    Definition Classes
    MessageOps
  48. def withBody[T](b: T)(implicit w: EntityEncoder[T]): Task[Self]

    Replace the body of this message with a new body

    Replace the body of this message with a new body

    T

    type of the Body

    b

    body to attach to this method

    w

    EntityEncoder with which to convert the body to an EntityBody

    returns

    a new message with the new body

    Definition Classes
    Message
  49. final def withContentType(contentType: Option[Content-Type]): Self
    Definition Classes
    MessageOps
  50. def withPathInfo(pi: String): Request
    Definition Classes
    Request → RequestOps
  51. final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self
    Definition Classes
    MessageOps
  52. final def withType(t: MediaType): Self

    Added the org.http4s.headers.Content-Type header to the response

    Added the org.http4s.headers.Content-Type header to the response

    Definition Classes
    MessageOps