Class/Object

org.http4s

Request

Related Docs: object Request | package http4s

Permalink

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)

    Permalink

    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

    Permalink
    Definition Classes
    RequestMessageMessageOps

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Request to any2stringadd[Request] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Request, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Request to ArrowAssoc[Request] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def addCookie(name: String, content: String, expires: Option[Instant] = None): Self

    Permalink

    Add a Cookie header with the provided values

    Add a Cookie header with the provided values

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

    Permalink

    Add a Cookie header for the provided Cookie

    Add a Cookie header for the provided Cookie

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

    Permalink

    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
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def attemptAs[T](implicit decoder: EntityDecoder[T]): DecodeResult[T]

    Permalink

    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
  11. val attributes: AttributeMap

    Permalink

    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
  12. lazy val authType: Option[AuthScheme]

    Permalink
  13. val body: EntityBody

    Permalink

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    RequestMessage
  16. def charset: Option[Charset]

    Permalink

    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
  17. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def contentLength: Option[Long]

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

    Permalink
    Definition Classes
    Message
  20. final def decode[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

    Permalink

    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
  21. final def decodeStrict[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

    Permalink

    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
  22. def decodeWith[A](decoder: EntityDecoder[A], strict: Boolean)(f: (A) ⇒ Task[Response]): Task[Response]

    Permalink

    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
    RequestRequestOps
  23. def ensuring(cond: (Request) ⇒ Boolean, msg: ⇒ Any): Request

    Permalink
    Implicit information
    This member is added by an implicit conversion from Request to Ensuring[Request] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: (Request) ⇒ Boolean): Request

    Permalink
    Implicit information
    This member is added by an implicit conversion from Request to Ensuring[Request] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean, msg: ⇒ Any): Request

    Permalink
    Implicit information
    This member is added by an implicit conversion from Request to Ensuring[Request] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: Boolean): Request

    Permalink
    Implicit information
    This member is added by an implicit conversion from Request to Ensuring[Request] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def filterHeaders(f: (Header) ⇒ Boolean): Self

    Permalink

    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
  29. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Request to StringFormat[Request] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  31. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  32. val headers: Headers

    Permalink

    collection of Headers

    collection of Headers

    Definition Classes
    RequestMessage
  33. val httpVersion: HttpVersion

    Permalink

    the HTTP version

    the HTTP version

    Definition Classes
    RequestMessage
  34. def isBodyPure: Boolean

    Permalink

    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
  35. def isChunked: Boolean

    Permalink
    Definition Classes
    Message
  36. def isIdempotent: Boolean

    Permalink

    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.

  37. final def isInstanceOf[T0]: Boolean

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

    Permalink

    Whether the Request was received over a secure medium

  39. val method: Method

    Permalink

    Method.GET, Method.POST, etc.

  40. def multiParams: Map[String, Seq[String]]

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef
  42. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  43. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  44. def params: Map[String, String]

    Permalink

    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

  45. lazy val pathInfo: String

    Permalink
  46. lazy val pathTranslated: Option[File]

    Permalink
  47. final def putHeaders(headers: Header*): Self

    Permalink

    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
  48. def queryString: String

    Permalink
  49. lazy val remote: Option[InetSocketAddress]

    Permalink
  50. lazy val remoteAddr: Option[String]

    Permalink
  51. lazy val remoteHost: Option[String]

    Permalink
  52. lazy val remotePort: Option[Int]

    Permalink
  53. lazy val remoteUser: Option[String]

    Permalink
  54. final def removeHeader(key: HeaderKey): Self

    Permalink
    Definition Classes
    MessageOps
  55. final def replaceAllHeaders(headers: Header*): Self

    Permalink

    Replace the existing headers with those provided

    Replace the existing headers with those provided

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

    Permalink

    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
  57. lazy val scriptName: String

    Permalink
  58. lazy val server: Option[InetSocketAddress]

    Permalink
  59. lazy val serverAddr: String

    Permalink
  60. lazy val serverPort: Int

    Permalink
  61. def serverSoftware: ServerSoftware

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

    Permalink
    Definition Classes
    AnyRef
  63. def toString(): String

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

    Permalink

    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
  65. def transformHeaders(f: (Headers) ⇒ Headers): Self

    Permalink
    Definition Classes
    MessageMessageOps
  66. val uri: Uri

    Permalink

    representation of the request URI

  67. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. def withAttribute[A](key: AttributeKey[A], value: A): Self

    Permalink

    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
  71. def withAttribute[V](entry: AttributeEntry[V]): Self

    Permalink

    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
  72. def withBody[T](b: T)(implicit w: EntityEncoder[T]): Task[Self]

    Permalink

    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
  73. final def withContentType(contentType: Option[Content-Type]): Self

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

    Permalink
    Definition Classes
    RequestRequestOps
  75. final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

    Permalink
    Definition Classes
    MessageOps
  76. final def withType(t: MediaType): Self

    Permalink

    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
  77. def [B](y: B): (Request, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Request to ArrowAssoc[Request] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RequestOps

Inherited from Message

Inherited from MessageOps

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Request to any2stringadd[Request]

Inherited by implicit conversion StringFormat from Request to StringFormat[Request]

Inherited by implicit conversion Ensuring from Request to Ensuring[Request]

Inherited by implicit conversion ArrowAssoc from Request to ArrowAssoc[Request]

Ungrouped