Contains http request and connection details such as a host name used to connect, port, scheme and so on. No proxy headers could affect it. Use ApplicationRequest.origin if you need override headers support

pipeline

abstract val pipeline: ApplicationReceivePipeline

Pipeline for receiving content

queryParameters

abstract val queryParameters: <ERROR CLASS>

Decoded parameters provided in a URL

rawQueryParameters

abstract val rawQueryParameters: <ERROR CLASS>

Parameters provided in a URL

Inheritors

RoutingApplicationRequest

Extensions

fun ApplicationRequest.accept(): String?

Request's Accept header value

acceptCharset

fun ApplicationRequest.acceptCharset(): String?

Request's Accept-Charset header value

acceptCharsetItems

fun ApplicationRequest.acceptCharsetItems(): List<<ERROR CLASS>>

Parsed and sorted request's Accept-Charset header value

acceptEncoding

fun ApplicationRequest.acceptEncoding(): String?

Request's Accept-Encoding header value

acceptEncodingItems

fun ApplicationRequest.acceptEncodingItems(): List<<ERROR CLASS>>

Parsed and sorted request's Accept-Encoding header value

acceptItems

fun ApplicationRequest.acceptItems(): List<<ERROR CLASS>>

Parsed request's Accept header and sorted according to quality

acceptLanguage

fun ApplicationRequest.acceptLanguage(): String?

Request's Accept-Language header value

acceptLanguageItems

fun ApplicationRequest.acceptLanguageItems(): List<<ERROR CLASS>>

Parsed and sorted request's Accept-Language header value

authorization

fun ApplicationRequest.authorization(): String?

Request authorization header value

cacheControl

fun ApplicationRequest.cacheControl(): String?

Request's Cache-Control header value

contentCharset

fun ApplicationRequest.contentCharset(): <ERROR CLASS>?

Request's charset

contentType

fun ApplicationRequest.contentType(): <ERROR CLASS>

Request's content type or ContentType.Any

document

fun ApplicationRequest.document(): String

Request's document name (substring after the last slash but before query string)

encodeParameters

fun ApplicationRequest.encodeParameters(parameters: <ERROR CLASS>): <ERROR CLASS>

Internal helper function to encode raw parameters. Should not be used directly.

header

fun ApplicationRequest.header(name: String): String?

First header value for header with name or null if missing

host

fun ApplicationRequest.host(): String

Request's host without port

httpMethod

val ApplicationRequest.httpMethod: <ERROR CLASS>

Returns request HTTP method possibly overridden via header X-Http-Method-Override

httpVersion

val ApplicationRequest.httpVersion: String

Request's HTTP version

isChunked

fun ApplicationRequest.isChunked(): Boolean

Check if request's body is chunk-encoded

isMultipart

fun ApplicationRequest.isMultipart(): Boolean

Check if request body is multipart-encoded

location

fun ApplicationRequest.location(): String?

Request's Location header value

origin

val ApplicationRequest.origin: <ERROR CLASS>

Represents request and connection parameters possibly overridden via https headers. By default it fallbacks to ApplicationRequest.local

path

fun ApplicationRequest.path(): String

Request's path without query string

port

fun ApplicationRequest.port(): Int

Request's port extracted from Host header value

queryString

fun ApplicationRequest.queryString(): String

Request's query string or empty string if missing

ranges

fun ApplicationRequest.ranges(): <ERROR CLASS>?

Parsed request's Range header value

toLogString

fun ApplicationRequest.toLogString(): String

Generates a string representing this ApplicationRequest suitable for logging

uri

val ApplicationRequest.uri: String

Request's URI (including query string)

userAgent

fun ApplicationRequest.userAgent(): String?

Request's User-Agent header value