http4k-core/org.http4k.core/MemoryRequest

MemoryRequest

data class MemoryRequest(val method: Method, val uri: Uri, val headers: Headers = listOf(), val body: Body = EMPTY, val version: String = HTTP_1_1, val source: RequestSource? = null) : Request

Constructors

constructor(method: Method, uri: Uri, headers: Headers = listOf(), body: Body = EMPTY, version: String = HTTP_1_1, source: RequestSource? = null)

Properties

open override val body: Body

open override val headers: Headers

open override val method: Method

open override val source: RequestSource? = null

open override val uri: Uri

open override val version: String

Functions

fun Request.accept(): Accept?

fun Request.accept(accept: Accept): Request

basicAuthentication

fun Request.basicAuthentication(): Credentials?

fun Request.basicAuthentication(credentials: Credentials): Request

fun Request.bearerAuth(token: String, scheme: String = "Bearer"): Request

fun Request.bearerToken(): String?

open override fun body(body: String): MemoryRequest

open override fun body(body: Body): MemoryRequest

open override fun body(body: InputStream, length: Long?): MemoryRequest

(Copy &) sets the body content.

open fun bodyString(): String

This will realise any underlying stream.

open override fun close()

Closes the request. For server generated messages, this is called by all backend/client implementations, but when consuming external responses in streaming mode, this should be used.

fun HttpMessage.contentType(): ContentType?

fun Request.cookie(name: String): Cookie?

fun Request.cookie(new: Cookie): Request

fun Request.cookie(name: String, value: String): Request

fun Request.cookies(): List<Cookie>

open operator override fun equals(other: Any?): Boolean

fun Request.flash(): String?

fun Request.form(): Form

fun Request.form(vararg formData: Pair<String, String?>): Request

fun Request.form(name: String, value: String?): Request

fun Request.form(name: String): String?

Returns the first form parameter with name.

fun Request.formAsMap(): Map<String, List<String?>>

open fun header(name: String): String?

Retrieves the first header value with this name.

open override fun header(name: String, value: String?): MemoryRequest

(Copy &) Adds a header value with this name.

open override fun headers(headers: Headers): MemoryRequest

(Copy &) Add all passed headers.

open fun headerValues(name: String): List<String?>

Retrieves all header values with this name.

open override fun method(method: Method): Request

(Copy &) sets the method.

fun Request.path(name: String): String?

open override fun queries(name: String): List<String?>

Retrieves all query values with this name.

open override fun query(name: String): String?

Retrieves the first query value with this name.

open override fun query(name: String, value: String?): MemoryRequest

(Copy &) Adds a query value with this name.

fun Request.removeCookie(name: String): Request

open override fun removeHeader(name: String): MemoryRequest

(Copy &) remove headers with this name.

open override fun removeHeaders(prefix: String): MemoryRequest

(Copy &) remove headers with this prefix. Default removes all headers.

open override fun removeQueries(prefix: String): MemoryRequest

(Copy &) remove queries with this prefix. Default removes all queries.

open override fun removeQuery(name: String): MemoryRequest

(Copy &) remove queries with this name.

open override fun replaceHeader(name: String, value: String?): MemoryRequest

(Copy &) Adds a header value with this name, replacing any previously set values.

open override fun replaceHeaders(source: Headers): MemoryRequest

Replace all headers with ones passed.

open override fun source(source: RequestSource): MemoryRequest

(Copy &) sets request source.

fun Request.toCurl(truncateBodyLength: Int = 256): String

open override fun toMessage(): String

Returns a formatted wire representation of this message.

open override fun toString(): String

open override fun uri(uri: Uri): MemoryRequest

(Copy &) sets the Uri.

fun Request.withBasicAuth(credentials: Credentials, header: String = "Authorization"): Request

fun Request.withFlash(value: String): Request