Request

Instance Constructors

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

type Self = Request

Definition Classes
Request → Message → MessageOps

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

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

Definition Classes
Any
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
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
Request → Message
lazy val authType: Option[AuthScheme]
val body: EntityBody

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

Definition Classes
Request → Message
final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Process[Task, String]

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

Attributes
protected
Definition Classes
Request → Message
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
def clone(): AnyRef

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

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

Definition Classes
Message
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
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
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
final def eq(arg0: AnyRef): Boolean

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

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

Definition Classes
AnyRef → Any
val headers: Headers

collection of Headers
collection of Headers

Definition Classes
Request → Message
val httpVersion: HttpVersion

the HTTP version
the HTTP version

Definition Classes
Request → Message
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
def isChunked: Boolean

Definition Classes
Message
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.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val isSecure: Option[Boolean]

Whether the Request was received over a secure medium
val method: Method

Method.GET, Method.POST, etc.

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

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 String	Map
`?param=v`	`Map("param" -> Seq("v"))`
`?param=`	`Map("param" -> Seq(""))`
`?param`	`Map("param" -> Seq())`
`?=value`	`Map("" -> Seq("value"))`
`?p1=v1&p1=v2&p2=v3&p2=v3`	`Map("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.

final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
lazy val pathInfo: String
lazy val pathTranslated: Option[File]
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
def queryString: String
lazy val remote: Option[InetSocketAddress]
lazy val remoteAddr: Option[String]
lazy val remoteHost: Option[String]
lazy val remotePort: Option[Int]
lazy val remoteUser: Option[String]
final def removeHeader(key: HeaderKey): Self

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

Replace the existing headers with those provided
Replace the existing headers with those provided

Definition Classes
MessageOps
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
lazy val scriptName: String
lazy val server: Option[InetSocketAddress]
lazy val serverAddr: String
lazy val serverPort: Int
def serverSoftware: ServerSoftware
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Request → AnyRef → Any
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
def transformHeaders(f: (Headers) ⇒ Headers): Self

Definition Classes
Message → MessageOps
val uri: Uri

representation of the request URI
final def wait(): Unit

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

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

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

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

Definition Classes
Request → RequestOps
final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

Definition Classes
MessageOps
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

Instance Constructors

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)

Type Members

type Self = Request

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

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

final def addCookie(cookie: Cookie): Self

final def as[T](implicit decoder: EntityDecoder[T]): Task[T]

final def asInstanceOf[T0]: T0

def attemptAs[T](implicit decoder: EntityDecoder[T]): DecodeResult[T]

val attributes: AttributeMap

lazy val authType: Option[AuthScheme]

val body: EntityBody

final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Process[Task, String]

def change(body: EntityBody, headers: Headers, attributes: AttributeMap): Self

def charset: Option[Charset]

def clone(): AnyRef

def contentLength: Option[Long]

def contentType: Option[Content-Type]

final def decode[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

final def decodeStrict[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

def decodeWith[A](decoder: EntityDecoder[A], strict: Boolean)(f: (A) ⇒ Task[Response]): Task[Response]

final def eq(arg0: AnyRef): Boolean

final def filterHeaders(f: (Header) ⇒ Boolean): Self

def finalize(): Unit

final def getClass(): Class[_]

val headers: Headers

val httpVersion: HttpVersion

def isBodyPure: Boolean

def isChunked: Boolean

def isIdempotent: Boolean

final def isInstanceOf[T0]: Boolean

lazy val isSecure: Option[Boolean]

val method: Method

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

Examples

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def params: Map[String, String]

lazy val pathInfo: String

lazy val pathTranslated: Option[File]

final def putHeaders(headers: Header*): Self

def queryString: String

lazy val remote: Option[InetSocketAddress]

lazy val remoteAddr: Option[String]

lazy val remoteHost: Option[String]

lazy val remotePort: Option[Int]

lazy val remoteUser: Option[String]

final def removeHeader(key: HeaderKey): Self

final def replaceAllHeaders(headers: Header*): Self

final def replaceAllHeaders(headers: Headers): Self

lazy val scriptName: String

lazy val server: Option[InetSocketAddress]

lazy val serverAddr: String

lazy val serverPort: Int

def serverSoftware: ServerSoftware

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

def toString(): String

def trailerHeaders: Task[Headers]

def transformHeaders(f: (Headers) ⇒ Headers): Self

val uri: Uri

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withAttribute[A](key: AttributeKey[A], value: A): Self

def withAttribute[V](entry: AttributeEntry[V]): Self

def withBody[T](b: T)(implicit w: EntityEncoder[T]): Task[Self]

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

def withPathInfo(pi: String): Request

final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

final def withType(t: MediaType): Self

Inherited from Serializable

Inherited from Serializable