kobweb-api/com.varabyte.kobweb.api.http/MutableRequest

MutableRequest

class MutableRequest(val connection: Request.Connection, var method: HttpMethod, params: Map<String, String>, queryParams: Map<String, String>, headers: Map<String, List<String>>, cookies: Map<String, String>, var body: ByteArray?, var contentType: String?) : Request(source)

Constructors

MutableRequest

constructor(request: Request)

constructor(connection: Request.Connection, method: HttpMethod, params: Map<String, String>, queryParams: Map<String, String>, headers: Map<String, List<String>>, cookies: Map<String, String>, body: ByteArray?, contentType: String?)

Properties

body

open override var body: ByteArray?

An (optional) payload sent with the request. Will only potentially be set with appropriate methods that are allowed to send data, i.e. HttpMethod.POST, HttpMethod.PUT, and HttpMethod.PATCH

connection

open override val connection: Request.Connection

Information about the connection that carried the request.

contentType

open override var contentType: String?

The content type of the body, if set and sent.

open override val cookies: MutableMap<String, String>

Any cookies sent with the request. Note the value of the cookies will be in a raw format, so you may need to decode them yourself.

headers

open override val headers: MutableMap<String, MutableList<String>>

All headers sent with the request.

method

open override var method: HttpMethod

The type of http method this call was sent with.

params

open override val params: MutableMap<String, String>

A list of key/value pairs extracted either from the user's query string or from any dynamic path parts.

queryParams

open override val queryParams: MutableMap<String, String>

Like params but only for the query string, just in case a user needs to disambiguate between a dynamic path part and a query parameter with the same name.

Functions

readBodyText

fun Request.readBodyText(): String?

Convenience method to pull body text out from a request.