Packages

sealed abstract case class Request 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.

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

Type Members

  1. type Self = Request
    Definition Classes
    RequestMessageMessageOps

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    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)
    Implicit
    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
    Definition Classes
    AnyRef → Any
  6. final def addCookie(name: String, content: String, expires: Option[HttpDate] = None): Self

    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

    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]

    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
    Definition Classes
    Any
  10. 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
  11. val attributes: AttributeMap
    Definition Classes
    RequestMessage
  12. lazy val authType: Option[AuthScheme]
  13. val body: EntityBody
    Definition Classes
    RequestMessage
  14. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[Task, String]
    Definition Classes
    Message
  15. def change(body: EntityBody, headers: Headers, attributes: AttributeMap): Self
    Attributes
    protected
    Definition Classes
    RequestMessage
  16. 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
  17. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def contentLength: Option[Long]
    Definition Classes
    Message
  19. def contentType: Option[Content-Type]
    Definition Classes
    Message
  20. 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
  21. 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
  22. 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
    RequestRequestOps
  23. def ensuring(cond: (Request) ⇒ Boolean, msg: ⇒ Any): Request
    Implicit
    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
    Implicit
    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
    Implicit
    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
    Implicit
    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
    Definition Classes
    AnyRef
  28. 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
  29. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. def formatted(fmtstr: String): String
    Implicit
    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[_]
    Definition Classes
    AnyRef → Any
  32. val headers: Headers
    Definition Classes
    RequestMessage
  33. val httpVersion: HttpVersion
    Definition Classes
    RequestMessage
  34. def isChunked: Boolean
    Definition Classes
    Message
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. lazy val isSecure: Option[Boolean]

    Whether the Request was received over a secure medium

  37. val method: Method
  38. 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.

  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  42. 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

  43. lazy val pathInfo: String
  44. lazy val pathTranslated: Option[File]
  45. 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
  46. def queryString: String
  47. lazy val remote: Option[InetSocketAddress]
  48. lazy val remoteAddr: Option[String]
  49. lazy val remoteHost: Option[String]
  50. lazy val remotePort: Option[Int]
  51. lazy val remoteUser: Option[String]
  52. final def removeHeader(key: HeaderKey): Self
    Definition Classes
    MessageOps
  53. final def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  54. 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
  55. lazy val scriptName: String
  56. lazy val server: Option[InetSocketAddress]
  57. lazy val serverAddr: String
  58. lazy val serverPort: Int
  59. def serverSoftware: ServerSoftware
  60. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  61. def toString(): String
    Definition Classes
    Request → AnyRef → Any
  62. 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
  63. def transformHeaders(f: (Headers) ⇒ Headers): Self
    Definition Classes
    MessageMessageOps
  64. val uri: Uri
  65. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. 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
  69. 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
  70. def withAttributes(attributes: AttributeMap): Request
  71. 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
  72. def withBodyStream(body: EntityBody): Request

    Sets the entity body without affecting headers such as Transfer-Encoding or Content-Length.

    Sets the entity body without affecting headers such as Transfer-Encoding or Content-Length. Most use cases are better served by withBody, which uses an EntityEncoder to maintain the headers.

    Definition Classes
    RequestMessage
  73. final def withContentType(contentType: Option[Content-Type]): Self
    Definition Classes
    MessageOps
  74. def withEmptyBody: Self

    Set an empty entity body on this message, and remove all payload headers that make no sense with an empty body.

    Set an empty entity body on this message, and remove all payload headers that make no sense with an empty body.

    Definition Classes
    Message
  75. def withHeaders(headers: Headers): Request
  76. def withHttpVersion(httpVersion: HttpVersion): Request
  77. def withMethod(method: Method): Request
  78. def withPathInfo(pi: String): Request
    Definition Classes
    RequestRequestOps
  79. final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self
    Definition Classes
    MessageOps
  80. 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
  81. def withUri(uri: Uri): Request
  82. def [B](y: B): (Request, B)
    Implicit
    This member is added by an implicit conversion from Request to ArrowAssoc[Request] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def copy(method: Method = this.method, uri: Uri = this.uri, httpVersion: HttpVersion = this.httpVersion, headers: Headers = this.headers, body: EntityBody = this.body, attributes: AttributeMap = this.attributes): Request
    Annotations
    @deprecated
    Deprecated

    (Since version 0.17.0-M3) Copy method is unsafe for setting path info. Use with... methods instead

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