io.ktor.application / ApplicationFeature

ApplicationFeature

interface ApplicationFeature<in TPipeline : Pipeline<*, ApplicationCall>, out TConfiguration : Any, TFeature : Any>

Defines an installable Application Feature

Parameters

TPipeline - is the type of the pipeline this feature is compatible with

TConfiguration - is the type for the configuration object for this Feature

TFeature - is the type for the instance of the Feature object

Properties

key	`abstract val key: AttributeKey<TFeature>` Unique key that identifies a feature

Functions

install

abstract fun install(
    pipeline: TPipeline, 
    configure: TConfiguration.() -> Unit
): TFeature

Feature installation script

Inheritors

ApplicationCallFeature	`object ApplicationCallFeature : ApplicationFeature<ApplicationCallPipeline, Configuration, ShutDownUrl>` A feature to install into application call pipeline
AutoHeadResponse	`object AutoHeadResponse : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>` A feature that automatically respond to HEAD requests
EngineFeature	`object EngineFeature : ApplicationFeature<EnginePipeline, Configuration, ShutDownUrl>` A feature to install into engine pipeline
Feature	`companion object Feature : ApplicationFeature<Application, Configuration, Authentication>` Installable feature for Authentication.
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, FreeMarker>` A feature installing companion object
Feature	`companion object Feature : ApplicationFeature<Application, Configuration, Locations>` Installable feature for Locations.
Feature	`companion object Feature : ApplicationFeature<Application, Configuration, MicrometerMetrics>` Micrometer feature installation object
Feature	`companion object Feature : ApplicationFeature<Application, Configuration, DropwizardMetrics>` Metrics feature companion
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, Mustache>`
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, Sessions>` Feature installation object
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, TemplateEngine, Thymeleaf>` A feature installing companion object
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, VelocityEngine, Velocity>` A companion object for installing feature
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, Webjars>`
Feature	`companion object Feature : ApplicationFeature<Application, WebSocketOptions, WebSockets>` Feature installation object
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, CORS>` Feature object for installation
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, CachingHeaders>` `ApplicationFeature` implementation for ConditionalHeaders
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, CallId>` Installable feature for CallId
Feature	`companion object Feature : ApplicationFeature<Application, Configuration, CallLogging>` Installable feature for CallLogging.
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, Compression>` `ApplicationFeature` implementation for Compression
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, ConditionalHeaders>` `ApplicationFeature` implementation for ConditionalHeaders
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, ContentNegotiation>` Implementation of an ApplicationFeature for the ContentNegotiation
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, DataConversion>` Object for installing feature
Feature	`companion object Feature : ApplicationFeature<Application, Configuration, DefaultHeaders>` Installable feature for DefaultHeaders.
Feature	`companion object Feature : ApplicationFeature<Application, Configuration, DoubleReceive>` DoubleReceive feature’s installation object.
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, HSTS>` Feature installation object
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, HttpsRedirect>` Feature installation object
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, PartialContent>` `ApplicationFeature` implementation for PartialContent
Feature	`companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, StatusPages>` Feature installation object
Feature	`companion object Feature : ApplicationFeature<Application, Routing, Routing>` Installable feature for Routing
ForwardedHeaderSupport	`object ForwardedHeaderSupport : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>` Forwarded header support. See RFC 7239 https://tools.ietf.org/html/rfc7239
XForwardedHeaderSupport	`object XForwardedHeaderSupport : ApplicationFeature<ApplicationCallPipeline, Config, Config>` `X-Forwarded-*` headers support See http://ktor.io/servers/features/forward-headers.html for details