ApplicationRequest

interface ApplicationRequest

Represents client’s request

Properties

call	`abstract val call: ApplicationCall` ApplicationCall instance this ApplicationRequest is attached to
cookies	`abstract val cookies: RequestCookies` Cookies for this request
headers	`abstract val headers: Headers` Headers for this request
local	`abstract val local: RequestConnectionPoint` 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: Parameters` Parameters provided in an URL

Functions

receiveChannel

abstract fun receiveChannel(): ByteReadChannel

Request’s body channel (for content only)

Extension Properties

httpMethod	`val ApplicationRequest.httpMethod: HttpMethod` Returns request HTTP method possibly overridden via header X-Http-Method-Override
httpVersion	`val ApplicationRequest.httpVersion: String` Request’s HTTP version
javaSecurityPrincipal	`val ApplicationRequest.javaSecurityPrincipal: Principal?` Returns Java’s JAAS Principal
origin	`val ApplicationRequest.origin: RequestConnectionPoint` Represents request and connection parameters possibly overridden via https headers. By default it fallbacks to ApplicationRequest.local
uri	`val ApplicationRequest.uri: String` Request’s URI (including query string)

Extension Functions

accept	`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<HeaderValue>` 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<HeaderValue>` Parsed and sorted request’s `Accept-Encoding` header value
acceptItems	`fun ApplicationRequest.acceptItems(): List<HeaderValue>` 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<HeaderValue>` Parsed and sorted request’s `Accept-Language` header value
authorization	`fun ApplicationRequest.authorization(): String?` Request authorization header value
basicAuthenticationCredentials	`fun ApplicationRequest.basicAuthenticationCredentials( charset: Charset? = null ): UserPasswordCredential?` Retrieves Basic authentication credentials for this ApplicationRequest
cacheControl	`fun ApplicationRequest.cacheControl(): String?` Request’s `Cache-Control` header value
contentCharset	`fun ApplicationRequest.contentCharset(): Charset?` Request’s charset
contentType	`fun ApplicationRequest.contentType(): ContentType` 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)
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
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
parseAuthorizationHeader	`fun ApplicationRequest.parseAuthorizationHeader(): HttpAuthHeader?` Parses an authorization header from a ApplicationRequest returning a HttpAuthHeader.
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(): RangesSpecifier?` Parsed request’s `Range` header value
toLogString	`fun ApplicationRequest.toLogString(): String` Generates a string representing this ApplicationRequest suitable for logging
userAgent	`fun ApplicationRequest.userAgent(): String?` Request’s `User-Agent` header value

Inheritors

BaseApplicationRequest	`abstract class BaseApplicationRequest : ApplicationRequest` Base class for implementing ApplicationRequest
RoutingApplicationRequest	`class RoutingApplicationRequest : ApplicationRequest` Represents an application request being handled by Routing