org.http4s

Request

case class Request(method: Method = Method.GET, uri: Uri = ..., httpVersion: HttpVersion = HttpVersion.HTTP/1.1, headers: Headers = Headers.empty, body: EntityBody = http4s.this.`package`.EmptyBody, attributes: AttributeMap = AttributeMap.empty) extends Message with MessageOps 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

Linear Supertypes
Serializable, Serializable, Product, Equals, Message, MessageOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Request
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Message
  7. MessageOps
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Request(method: Method = Method.GET, uri: Uri = ..., httpVersion: HttpVersion = HttpVersion.HTTP/1.1, headers: Headers = Headers.empty, body: EntityBody = http4s.this.`package`.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
    RequestMessageMessageOps

Value Members

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

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

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

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

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

    Definition Classes
    Any
  6. 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
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. 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
    MessageMessageOps
  9. val attributes: AttributeMap

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

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

    Definition Classes
    RequestMessage
  10. lazy val authType: Option[AuthScheme]

  11. val body: EntityBody

    scalaz.

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

    Definition Classes
    RequestMessage
  12. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Process[Task, String]

    Definition Classes
    Message
  13. def change(body: EntityBody, headers: Headers, attributes: AttributeMap): Self

    Attributes
    protected
    Definition Classes
    RequestMessage
  14. 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
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def contentLength: Option[Int]

    Definition Classes
    Message
  17. def contentType: Option[Content-Type]

    Definition Classes
    Message
  18. 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, a BadRequest Response is generated.

  19. 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, a BadRequest Response is generated. If the decoder does not support the MediaType of the Request, a UnsupportedMediaType Response is generated instead.

  20. 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

  21. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. 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
    MessageMessageOps
  23. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  25. val headers: Headers

    collection of Headers

    collection of Headers

    Definition Classes
    RequestMessage
  26. val httpVersion: HttpVersion

    the HTTP version

    the HTTP version

    Definition Classes
    RequestMessage
  27. def isChunked: Boolean

    Definition Classes
    Message
  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  29. lazy val isSecure: Option[Boolean]

    Whether the Request was received over a secure medium

  30. val method: Method

    Method.GET, Method.POST, etc.

  31. 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.

  32. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  35. 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

  36. lazy val pathInfo: String

  37. lazy val pathTranslated: Option[File]

  38. def putHeaders(headers: Header*): Self

    Add the provided headers to the existing headers, replacing those of the same header name

    Add the provided headers to the existing headers, replacing those of the same header name

    Definition Classes
    MessageMessageOps
  39. def queryString: String

  40. lazy val remote: Option[InetSocketAddress]

  41. lazy val remoteAddr: Option[String]

  42. lazy val remoteHost: Option[String]

  43. lazy val remotePort: Option[Int]

  44. lazy val remoteUser: Option[String]

  45. def removeHeader(key: HeaderKey): Self

    Definition Classes
    MessageOps
  46. 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
    MessageMessageOps
  47. def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  48. lazy val scriptName: String

  49. lazy val server: Option[InetSocketAddress]

  50. lazy val serverAddr: String

  51. lazy val serverPort: Int

  52. def serverSoftware: ServerSoftware

  53. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  54. def toString(): String

    Definition Classes
    Request → AnyRef → Any
  55. def trailerHeaders: Task[Headers]

    The trailer headers, as specified in Section 3.

    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
  56. val uri: Uri

    representation of the request URI

  57. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. 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
    MessageMessageOps
  61. 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
  62. 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
  63. def withContentType(contentType: Option[Content-Type]): Self

    Definition Classes
    MessageOps
  64. def withPathInfo(pi: String): Request

  65. def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

    Definition Classes
    MessageOps
  66. def withType(t: MediaType): Self

    Added the `Content-Type` header to the response

    Added the `Content-Type` header to the response

    Definition Classes
    MessageOps

Deprecated Value Members

  1. final def withHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) Use replaceAllHeaders. Will be removed in 0.11.x

  2. final def withHeaders(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
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) Use replaceAllHeaders. Will be removed in 0.11.x

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Message

Inherited from MessageOps

Inherited from AnyRef

Inherited from Any

Ungrouped