ktor-server-servlet-jakarta/io.ktor.server.servlet.jakarta

Package-level declarations

Types

open class AsyncServletApplicationCall(application: Application, servletRequest: HttpServletRequest, servletResponse: HttpServletResponse, engineContext: CoroutineContext, userContext: CoroutineContext, upgrade: ServletUpgrade, parentCoroutineContext: CoroutineContext, managedByEngineHeaders: Set<String> = emptySet(), idleTimeout: Duration? = null) : BaseApplicationCall, CoroutineScope

AsyncServletApplicationRequest

class AsyncServletApplicationRequest(call: PipelineCall, servletRequest: HttpServletRequest, val coroutineContext: CoroutineContext, idleTimeout: Duration? = null) : ServletApplicationRequest, CoroutineScope

AsyncServletApplicationResponse

open class AsyncServletApplicationResponse(call: AsyncServletApplicationCall, servletRequest: HttpServletRequest, servletResponse: HttpServletResponse, engineContext: CoroutineContext, userContext: CoroutineContext, servletUpgradeImpl: ServletUpgrade, val coroutineContext: CoroutineContext, idleTimeout: Duration? = null, managedByEngineHeaders: Set<String> = emptySet()) : ServletApplicationResponse, CoroutineScope

DefaultServletUpgrade

object DefaultServletUpgrade : ServletUpgrade

The default servlet upgrade implementation using Servlet API. Please note that some servlet containers may not support it or it may be broken.

KtorServlet

abstract class KtorServlet : HttpServlet, CoroutineScope

A base class for servlet engine implementations

KtorServletContainerInitializer

class KtorServletContainerInitializer : ServletContainerInitializer

Registers KtorServletContextListener so a servlet-hosted Ktor application is started and stopped in lockstep with the web application context lifecycle.

KtorServletContextListener

class KtorServletContextListener : ServletContextListener

Starts and stops a servlet-hosted Ktor application together with the web application context, independently of when (or whether) the ServletApplicationEngine servlet is initialized.

ServletApplicationEngine

open class ServletApplicationEngine : KtorServlet

This servlet need to be installed into a servlet container

ServletApplicationRequest

abstract class ServletApplicationRequest(call: PipelineCall, val servletRequest: HttpServletRequest) : BaseApplicationRequest

ServletApplicationRequestCookies

class ServletApplicationRequestCookies(servletRequest: HttpServletRequest, request: PipelineRequest) : RequestCookies

ServletApplicationRequestHeaders

class ServletApplicationRequestHeaders(servletRequest: HttpServletRequest) : Headers

ServletApplicationResponse

abstract class ServletApplicationResponse(call: PipelineCall, servletResponse: HttpServletResponse, managedByEngineHeaders: Set<String>) : BaseApplicationResponse

ServletUpgrade

interface ServletUpgrade

Servlet upgrade processing

ServletUpgradeHandler

class ServletUpgradeHandler : HttpUpgradeHandler, CoroutineScope

UpgradeRequest

class UpgradeRequest(val response: HttpServletResponse, val upgradeMessage: OutgoingContent.ProtocolUpgrade, val engineContext: CoroutineContext, val userContext: CoroutineContext, val disableAsyncInput: Boolean)

WebResourcesConfig

class WebResourcesConfig

Web resources serve configuration

Properties

javaSecurityPrincipal

val ApplicationRequest.javaSecurityPrincipal: Principal?

Returns Java's JAAS Principal

ServletContextAttribute

val ServletContextAttribute: AttributeKey<ServletContext>

Attribute that is added by ktor servlet to application attributes to hold ServletContext instance.

servletRequestAttributes

val ApplicationRequest.servletRequestAttributes: Map<String, Any>

Provides jakarta.servlet request attributes or fail it the underlying engine is not servlet-backed.

Functions

putServletAttributes

fun ApplicationCall.putServletAttributes(request: ServletRequest)

webResources

fun Route.webResources(subPath: String = "/", configure: WebResourcesConfig.() -> Unit = {})

Serve web resources (usually a directory named webapp containing WEB-INF/web.xml). Note that WEB-INF directory itself is not served by default.