ApplicationRequest
interface ApplicationRequest
Represents client’s request
Properties
abstract val call: ApplicationCall ApplicationCall instance this ApplicationRequest is attached to |
|
abstract val cookies: RequestCookies Cookies for this request |
|
abstract val headers: Headers Headers for this request |
|
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 |
|
abstract val pipeline: ApplicationReceivePipeline Pipeline for receiving content |
|
abstract val queryParameters: Parameters Parameters provided in an URL |
Functions
abstract fun receiveChannel(): ByteReadChannel Request’s body channel (for content only) |
Extension Properties
val ApplicationRequest.httpMethod: HttpMethod Returns request HTTP method possibly overridden via header X-Http-Method-Override |
|
val ApplicationRequest.httpVersion: String Request’s HTTP version |
|
val ApplicationRequest.javaSecurityPrincipal: Principal? Returns Java’s JAAS Principal |
|
val ApplicationRequest.origin: RequestConnectionPoint Represents request and connection parameters possibly overridden via https headers. By default it fallbacks to ApplicationRequest.local |
|
val ApplicationRequest.uri: String Request’s URI (including query string) |
Extension Functions
fun ApplicationRequest.accept(): String? Request’s |
|
fun ApplicationRequest.acceptCharset(): String? Request’s |
|
fun ApplicationRequest.acceptCharsetItems(): List<HeaderValue> Parsed and sorted request’s |
|
fun ApplicationRequest.acceptEncoding(): String? Request’s |
|
fun ApplicationRequest.acceptEncodingItems(): List<HeaderValue> Parsed and sorted request’s |
|
fun ApplicationRequest.acceptItems(): List<HeaderValue> Parsed request’s |
|
fun ApplicationRequest.acceptLanguage(): String? Request’s |
|
fun ApplicationRequest.acceptLanguageItems(): List<HeaderValue> Parsed and sorted request’s |
|
fun ApplicationRequest.authorization(): String? Request authorization header value |
|
fun ApplicationRequest.basicAuthenticationCredentials( Retrieves Basic authentication credentials for this ApplicationRequest |
|
fun ApplicationRequest.cacheControl(): String? Request’s |
|
fun ApplicationRequest.contentCharset(): Charset? Request’s charset |
|
fun ApplicationRequest.contentType(): ContentType Request’s content type or |
|
fun ApplicationRequest.document(): String Request’s document name (substring after the last slash but before query string) |
|
fun ApplicationRequest.header(name: String): String? First header value for header with name or |
|
fun ApplicationRequest.host(): String Request’s host without port |
|
fun ApplicationRequest.isChunked(): Boolean Check if request’s body is chunk-encoded |
|
fun ApplicationRequest.isMultipart(): Boolean Check if request body is multipart-encoded |
|
fun ApplicationRequest.location(): String? Request’s |
|
fun ApplicationRequest.parseAuthorizationHeader(): HttpAuthHeader? Parses an authorization header from a ApplicationRequest returning a HttpAuthHeader. |
|
fun ApplicationRequest.path(): String Request’s path without query string |
|
fun ApplicationRequest.port(): Int Request’s port extracted from |
|
fun ApplicationRequest.queryString(): String Request’s query string or empty string if missing |
|
fun ApplicationRequest.ranges(): RangesSpecifier? Parsed request’s |
|
fun ApplicationRequest.toLogString(): String Generates a string representing this ApplicationRequest suitable for logging |
|
fun ApplicationRequest.userAgent(): String? Request’s |
Inheritors
abstract class BaseApplicationRequest : ApplicationRequest Base class for implementing ApplicationRequest |
|
class RoutingApplicationRequest : ApplicationRequest Represents an application request being handled by Routing |