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.
- Value parameters:
- attributes
Immutable Map used for carrying additional information in a type safe fashion
- body
fs2.Stream[F, Byte] defining the body of the request
- headers
collection of Headers
- httpVersion
the HTTP version
- method
Method.GET, Method.POST, etc.
- uri
representation of the request URI
- Companion:
- object
Type members
Value members
Concrete methods
Add a Cookie header for the provided org.http4s.headers.Cookie
Add a Cookie header for the provided org.http4s.headers.Cookie
cURL representation of the request.
cURL representation of the request.
Supported cURL-Parameters are: --request, --url, --header.
Note that asCurl
will not print the request body.
Parses all available org.http4s.headers.Cookie headers into a list of RequestCookie objects. This implementation is compatible with cookie headers formatted per HTTP/1 and HTTP/2, or even both at the same time.
Parses all available org.http4s.headers.Cookie headers into a list of RequestCookie objects. This implementation is compatible with cookie headers formatted per HTTP/1 and HTTP/2, or even both at the same time.
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.
Returns the the X-Forwarded-For value if present, else the remote address.
Returns the the X-Forwarded-For value if present, else the remote address.
A request is idempotent if its method is idempotent or it contains
an Idempotency-Key
header.
A request is idempotent if its method is idempotent or it contains
an Idempotency-Key
header.
Whether the Request was received over a secure medium
Whether the Request was received over a secure medium
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 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=v4 | 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.
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
Deprecated methods
- Deprecated
[Since version 0.22.0-M1]
Use {withPathInfo(Uri.Path)} instead
Inherited methods
Add a header to these headers. The header should be a type with a
recurring Header
instance to ensure that the new value can be
appended to any existing values.
Add a header to these headers. The header should be a type with a
recurring Header
instance to ensure that the new value can be
appended to any existing values.
>>> import cats.effect.IO
>>> import org.http4s.headers.Accept
>>> val req = Request[IO]().addHeader(Accept(MediaRange.`application/*`))
>>> req.headers.get[Accept]
Some(Accept(NonEmptyList(application/*)))
>>> val req2 = req.addHeader(Accept(MediaRange.`text/*`))
>>> req2.headers.get[Accept]
Some(Accept(NonEmptyList(application/*, text/*)))
////*/
- Inherited from:
- Message
Decode the Media to the specified type
Decode the Media to the specified type
- Type parameters:
- T
type of the result
- Value parameters:
- decoder
EntityDecoder used to decode the Media
- Returns:
the effect which will generate the
DecodeResult[T]
- Inherited from:
- Media
Keep headers that satisfy the predicate
Keep headers that satisfy the predicate
- Value parameters:
- f
predicate
- Returns:
a new message object which has only headers that satisfy the predicate
- Inherited from:
- Message
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
>>> import cats.effect.IO
>>> import org.http4s.headers.Accept
>>> val req = Request[IO]().putHeaders(Accept(MediaRange.`application/*`))
>>> req.headers.get[Accept]
Some(Accept(NonEmptyList(application/*)))
>>> val req2 = req.putHeaders(Accept(MediaRange.`text/*`))
>>> req2.headers.get[Accept]
Some(Accept(NonEmptyList(text/*)))
////
- Inherited from:
- Message
Compiles the body stream to a single chunk and sets it as the
body. Replaces any Transfer-Encoding: chunked
with a
Content-Length
header. It is the caller's responsibility to
assure there is enough memory to materialize the entity body and
control the time limits of that materialization.
Compiles the body stream to a single chunk and sets it as the
body. Replaces any Transfer-Encoding: chunked
with a
Content-Length
header. It is the caller's responsibility to
assure there is enough memory to materialize the entity body and
control the time limits of that materialization.
- Value parameters:
- maxBytes
maximum length of the entity stream. If the stream exceeds the limit then processing fails with the Message.EntityStreamException. Pass the scala.None if you don't want to limit the entity body.
- Inherited from:
- Message
The trailer headers, as specified in Section 3.6.1 of RFC 2616. The resulting F might not complete until the entire body has been consumed.
The trailer headers, as specified in Section 3.6.1 of RFC 2616. The resulting F might not complete until the entire body has been consumed.
- Inherited from:
- Message
Generates a new message object with the specified key/value pair appended to the attributes.
Generates a new message object with the specified key/value pair appended to the attributes.
- Type parameters:
- A
type of the value to store
- Value parameters:
- key
org.typelevel.vault.Key with which to associate the value
- value
value associated with the key
- Returns:
a new message object with the key/value pair appended
- Inherited from:
- Message
Sets the entity body without affecting headers such as Transfer-Encoding
or Content-Length
. Most use cases are better served by withEntity,
which uses an EntityEncoder to maintain the headers.
Sets the entity body without affecting headers such as Transfer-Encoding
or Content-Length
. Most use cases are better served by withEntity,
which uses an EntityEncoder to maintain the headers.
WARNING: this method does not modify the headers of the message, and as a consequence headers may be incoherent with the body.
- Inherited from:
- Message
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.
- Inherited from:
- Message
Replace the body of this message with a new body
Replace the body of this message with a new body
- Type parameters:
- T
type of the Body
- Value parameters:
- 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
- Inherited from:
- Message
Returns a new message object without the specified key in the attributes.
Returns a new message object without the specified key in the attributes.
- Value parameters:
- key
org.typelevel.vault.Key to remove
- Returns:
a new message object without the key
- Inherited from:
- Message