org.http4s

Request

case class Request(requestMethod: Method = Method.Get, requestUri: Uri = ..., protocol: ServerProtocol = ServerProtocol.HTTP/1.1, headers: Headers = Headers.empty, body: HttpBody = HttpBody.empty, attributes: AttributeMap = AttributeMap.empty) extends Message 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. A Request will be the only argument for a HttpService.

requestMethod

Method.Get, Method.Post, etc.

requestUri

representation of the request URI

protocol

HTTP protocol, eg ServerProtocol.HTTP/1.1

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, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Request
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Message
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Request(requestMethod: Method = Method.Get, requestUri: Uri = ..., protocol: ServerProtocol = ServerProtocol.HTTP/1.1, headers: Headers = Headers.empty, body: HttpBody = HttpBody.empty, attributes: AttributeMap = AttributeMap.empty)

    requestMethod

    Method.Get, Method.Post, etc.

    requestUri

    representation of the request URI

    protocol

    HTTP protocol, eg ServerProtocol.HTTP/1.1

    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

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 addHeader(header: Header): Self

    Definition Classes
    Message

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. val attributes: AttributeMap

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

  9. lazy val authType: Option[AuthScheme]

  10. val body: HttpBody

    scalaz.

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

  11. def charset: CharacterSet

    Definition Classes
    Message

  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  13. def contentLength: Option[Int]

    Definition Classes
    Message

  14. def contentType: Option[Content-Type]

    Definition Classes
    Message

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

    Definition Classes
    AnyRef

  16. def filterHeaders(f: (Header) ⇒ Boolean): Self

    Definition Classes
    Message

  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  19. val headers: Headers

    collection of Headers

  20. def isChunked: Boolean

    Definition Classes
    Message

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Representation of the URI query as a Map[String, Seq[String]]

    Representation of the URI query as a Map[String, Seq[String]]

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

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

    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  26. def params: Map[String, String]

    View of the head elements of the URI multiParams

    View of the head elements of the URI multiParams

    See also

    multiParams

  27. lazy val pathInfo: String

  28. lazy val pathTranslated: Option[File]

  29. val protocol: ServerProtocol

    HTTP protocol, eg ServerProtocol.

    HTTP protocol, eg ServerProtocol.HTTP/1.1

  30. def putHeader(header: Header): Self

    Definition Classes
    Message

  31. def queryString: String

  32. lazy val remote: Option[InetAddress]

  33. lazy val remoteAddr: Option[String]

  34. lazy val remoteHost: Option[String]

  35. lazy val remoteUser: Option[String]

  36. def removeHeader(key: HeaderKey): Self

    Definition Classes
    Message

  37. val requestMethod: Method

    Method.Get, Method.Post, etc.

  38. val requestUri: Uri

    representation of the request URI

  39. lazy val scriptName: String

  40. lazy val serverName: CharSequence

  41. lazy val serverPort: Any

  42. def serverSoftware: ServerSoftware

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

    Definition Classes
    AnyRef

  44. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  45. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  46. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. def withAttribute[T](key: AttributeKey[T], value: T): Request

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

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

    T

    type of the value to store

    key

    AttributeKey with which to associate the value

    value

    value associated with the key

    returns

    a new Request object with the key/value pair appended

  48. def withBody(body: HttpBody): Request

    Replace the body of the incoming Request object

    Replace the body of the incoming Request object

    body

    scalaz.stream.Process[Task,Chunk] representing the new body

    returns

    a new Request object

    Definition Classes
    Request → Message

  49. def withContentType(contentType: Option[Content-Type]): Self

    Definition Classes
    Message

  50. def withHeaders(headers: Headers): Request

    Replaces the org.http4s.Headers of the incoming Request object

    Replaces the org.http4s.Headers of the incoming Request object

    headers

    Headers containing the desired headers

    returns

    a new Request object

    Definition Classes
    Request → Message

  51. def withPathInfo(pi: String): Request

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Message

Inherited from AnyRef

Inherited from Any

Ungrouped