ktor-server-servlet
Module Contents
alltypes
Module Contents
open
class
AsyncServletApplicationCall
:
BaseApplicationCall
,
CoroutineScope
Module Contents
AsyncServletApplicationCall
(
application
:
Application
,
servletRequest
:
HttpServletRequest
,
servletResponse
:
HttpServletResponse
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
,
upgrade
:
ServletUpgrade
,
parentCoroutineContext
:
<ERROR CLASS>
)
open
val
coroutineContext
:
<ERROR CLASS>
open
val
request
:
AsyncServletApplicationRequest
open
val
response
:
ServletApplicationResponse
class
AsyncServletApplicationRequest
:
ServletApplicationRequest
,
CoroutineScope
Module Contents
AsyncServletApplicationRequest
(
call
:
ApplicationCall
,
servletRequest
:
HttpServletRequest
,
coroutineContext
:
<ERROR CLASS>
)
val
coroutineContext
:
<ERROR CLASS>
fun
receiveChannel
(
)
:
ByteReadChannel
open
class
AsyncServletApplicationResponse
:
ServletApplicationResponse
,
CoroutineScope
Module Contents
AsyncServletApplicationResponse
(
call
:
AsyncServletApplicationCall
,
servletRequest
:
HttpServletRequest
,
servletResponse
:
HttpServletResponse
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
,
servletUpgradeImpl
:
ServletUpgrade
,
coroutineContext
:
<ERROR CLASS>
)
open
val
coroutineContext
:
<ERROR CLASS>
protected
open
fun
createResponseJob
(
)
:
ReaderJob
open
fun
push
(
builder
:
ResponsePushBuilder
)
:
Unit
suspend
fun
respondUpgrade
(
upgrade
:
ProtocolUpgrade
)
:
Unit
protected
val
servletRequest
:
HttpServletRequest
object
DefaultServletUpgrade
:
ServletUpgrade
Module Contents
suspend
fun
performUpgrade
(
upgrade
:
ProtocolUpgrade
,
servletRequest
:
HttpServletRequest
,
servletResponse
:
HttpServletResponse
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
)
:
Unit
abstract
class
KtorServlet
:
HttpServlet
,
CoroutineScope
Module Contents
KtorServlet
(
)
protected
abstract
val
application
:
Application
open
val
coroutineContext
:
<ERROR CLASS>
open
fun
destroy
(
)
:
Unit
protected
abstract
val
enginePipeline
:
EnginePipeline
open
fun
init
(
)
:
Unit
protected
open
val
logger
:
Logger
protected
open
fun
service
(
request
:
HttpServletRequest
,
response
:
HttpServletResponse
)
:
Unit
protected
abstract
val
upgrade
:
ServletUpgrade
open
class
ServletApplicationEngine
:
KtorServlet
Module Contents
ServletApplicationEngine
(
)
const
val
ApplicationEngineEnvironmentAttributeKey
:
String
const
val
ApplicationEnginePipelineAttributeKey
:
String
protected
open
val
application
:
Application
open
val
coroutineContext
:
<ERROR CLASS>
open
fun
destroy
(
)
:
Unit
protected
open
val
enginePipeline
:
EnginePipeline
open
fun
init
(
)
:
Unit
protected
open
val
logger
:
Logger
protected
open
val
upgrade
:
ServletUpgrade
abstract
class
ServletApplicationRequest
:
BaseApplicationRequest
Module Contents
ServletApplicationRequest
(
call
:
ApplicationCall
,
servletRequest
:
HttpServletRequest
)
open
val
cookies
:
RequestCookies
open
val
headers
:
Headers
open
val
local
:
RequestConnectionPoint
open
val
queryParameters
:
Parameters
val
servletRequest
:
HttpServletRequest
class
ServletApplicationRequestCookies
:
RequestCookies
Module Contents
ServletApplicationRequestCookies
(
servletRequest
:
HttpServletRequest
,
request
:
ApplicationRequest
)
protected
fun
fetchCookies
(
)
:
Map
<
String
,
String
>
class
ServletApplicationRequestHeaders
:
Headers
Module Contents
ServletApplicationRequestHeaders
(
servletRequest
:
HttpServletRequest
)
val
caseInsensitiveName
:
Boolean
fun
contains
(
name
:
String
)
:
Boolean
fun
entries
(
)
:
Set
<
Entry
<
String
,
List
<
String
>
>
>
fun
forEach
(
body
:
(
String
,
List
<
String
>
)
->
Unit
)
:
Unit
fun
get
(
name
:
String
)
:
String
?
fun
getAll
(
name
:
String
)
:
List
<
String
>
?
fun
isEmpty
(
)
:
Boolean
fun
names
(
)
:
Set
<
String
>
abstract
class
ServletApplicationResponse
:
BaseApplicationResponse
Module Contents
ServletApplicationResponse
(
call
:
ApplicationCall
,
servletResponse
:
HttpServletResponse
)
@Volatile
protected
var
completed
:
Boolean
protected
abstract
fun
createResponseJob
(
)
:
ReaderJob
open
val
headers
:
ResponseHeaders
suspend
fun
responseChannel
(
)
:
ByteWriteChannel
protected
val
servletResponse
:
HttpServletResponse
protected
open
fun
setStatus
(
statusCode
:
HttpStatusCode
)
:
Unit
interface
ServletUpgrade
Module Contents
abstract
suspend
fun
performUpgrade
(
upgrade
:
ProtocolUpgrade
,
servletRequest
:
HttpServletRequest
,
servletResponse
:
HttpServletResponse
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
)
:
Unit
class
ServletUpgradeHandler
:
HttpUpgradeHandler
,
CoroutineScope
Module Contents
ServletUpgradeHandler
(
)
val
coroutineContext
:
<ERROR CLASS>
fun
destroy
(
)
:
Unit
fun
init
(
webConnection
:
WebConnection
?
)
:
Unit
@Volatile
lateinit
var
up
:
UpgradeRequest
@Volatile
lateinit
var
upgradeJob
:
CompletableJob
class
UpgradeRequest
Module Contents
UpgradeRequest
(
response
:
HttpServletResponse
,
upgradeMessage
:
ProtocolUpgrade
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
,
disableAsyncInput
:
Boolean
)
val
disableAsyncInput
:
Boolean
val
engineContext
:
<ERROR CLASS>
val
response
:
HttpServletResponse
val
upgradeMessage
:
ProtocolUpgrade
val
userContext
:
<ERROR CLASS>
class
WebResourcesConfig
Module Contents
WebResourcesConfig
(
)
fun
exclude
(
predicate
:
(
path
:
String
)
->
Boolean
)
:
Unit
val
excludes
:
MutableList
<
(
String
)
->
Boolean
>
fun
include
(
predicate
:
(
path
:
String
)
->
Boolean
)
:
Unit
val
includes
:
MutableList
<
(
String
)
->
Boolean
>
var
mimeResolve
:
(
String
)
->
ContentType
io.ktor.application.ApplicationCall
Module Contents
fun
ApplicationCall
.
putServletAttributes
(
request
:
ServletRequest
)
:
Unit
io.ktor.request.ApplicationRequest
Module Contents
val
ApplicationRequest
.
javaSecurityPrincipal
:
Principal
?
val
ApplicationRequest
.
servletRequestAttributes
:
Map
<
String
,
Any
>
io.ktor.routing.Route
Module Contents
fun
Route
.
webResources
(
subPath
:
String
=
"/"
,
configure
:
WebResourcesConfig
.
(
)
->
Unit
=
{}
)
:
Unit
package
io.ktor.server.servlet
Module Contents
open
class
AsyncServletApplicationCall
:
BaseApplicationCall
,
CoroutineScope
Module Contents
AsyncServletApplicationCall
(
application
:
Application
,
servletRequest
:
HttpServletRequest
,
servletResponse
:
HttpServletResponse
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
,
upgrade
:
ServletUpgrade
,
parentCoroutineContext
:
<ERROR CLASS>
)
open
val
coroutineContext
:
<ERROR CLASS>
open
val
request
:
AsyncServletApplicationRequest
open
val
response
:
ServletApplicationResponse
class
AsyncServletApplicationRequest
:
ServletApplicationRequest
,
CoroutineScope
Module Contents
AsyncServletApplicationRequest
(
call
:
ApplicationCall
,
servletRequest
:
HttpServletRequest
,
coroutineContext
:
<ERROR CLASS>
)
val
coroutineContext
:
<ERROR CLASS>
fun
receiveChannel
(
)
:
ByteReadChannel
open
class
AsyncServletApplicationResponse
:
ServletApplicationResponse
,
CoroutineScope
Module Contents
AsyncServletApplicationResponse
(
call
:
AsyncServletApplicationCall
,
servletRequest
:
HttpServletRequest
,
servletResponse
:
HttpServletResponse
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
,
servletUpgradeImpl
:
ServletUpgrade
,
coroutineContext
:
<ERROR CLASS>
)
open
val
coroutineContext
:
<ERROR CLASS>
protected
open
fun
createResponseJob
(
)
:
ReaderJob
open
fun
push
(
builder
:
ResponsePushBuilder
)
:
Unit
suspend
fun
respondUpgrade
(
upgrade
:
ProtocolUpgrade
)
:
Unit
protected
val
servletRequest
:
HttpServletRequest
object
DefaultServletUpgrade
:
ServletUpgrade
Module Contents
suspend
fun
performUpgrade
(
upgrade
:
ProtocolUpgrade
,
servletRequest
:
HttpServletRequest
,
servletResponse
:
HttpServletResponse
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
)
:
Unit
abstract
class
KtorServlet
:
HttpServlet
,
CoroutineScope
Module Contents
KtorServlet
(
)
protected
abstract
val
application
:
Application
open
val
coroutineContext
:
<ERROR CLASS>
open
fun
destroy
(
)
:
Unit
protected
abstract
val
enginePipeline
:
EnginePipeline
open
fun
init
(
)
:
Unit
protected
open
val
logger
:
Logger
protected
open
fun
service
(
request
:
HttpServletRequest
,
response
:
HttpServletResponse
)
:
Unit
protected
abstract
val
upgrade
:
ServletUpgrade
open
class
ServletApplicationEngine
:
KtorServlet
Module Contents
ServletApplicationEngine
(
)
const
val
ApplicationEngineEnvironmentAttributeKey
:
String
const
val
ApplicationEnginePipelineAttributeKey
:
String
protected
open
val
application
:
Application
open
val
coroutineContext
:
<ERROR CLASS>
open
fun
destroy
(
)
:
Unit
protected
open
val
enginePipeline
:
EnginePipeline
open
fun
init
(
)
:
Unit
protected
open
val
logger
:
Logger
protected
open
val
upgrade
:
ServletUpgrade
abstract
class
ServletApplicationRequest
:
BaseApplicationRequest
Module Contents
ServletApplicationRequest
(
call
:
ApplicationCall
,
servletRequest
:
HttpServletRequest
)
open
val
cookies
:
RequestCookies
open
val
headers
:
Headers
open
val
local
:
RequestConnectionPoint
open
val
queryParameters
:
Parameters
val
servletRequest
:
HttpServletRequest
class
ServletApplicationRequestCookies
:
RequestCookies
Module Contents
ServletApplicationRequestCookies
(
servletRequest
:
HttpServletRequest
,
request
:
ApplicationRequest
)
protected
fun
fetchCookies
(
)
:
Map
<
String
,
String
>
class
ServletApplicationRequestHeaders
:
Headers
Module Contents
ServletApplicationRequestHeaders
(
servletRequest
:
HttpServletRequest
)
val
caseInsensitiveName
:
Boolean
fun
contains
(
name
:
String
)
:
Boolean
fun
entries
(
)
:
Set
<
Entry
<
String
,
List
<
String
>
>
>
fun
forEach
(
body
:
(
String
,
List
<
String
>
)
->
Unit
)
:
Unit
fun
get
(
name
:
String
)
:
String
?
fun
getAll
(
name
:
String
)
:
List
<
String
>
?
fun
isEmpty
(
)
:
Boolean
fun
names
(
)
:
Set
<
String
>
abstract
class
ServletApplicationResponse
:
BaseApplicationResponse
Module Contents
ServletApplicationResponse
(
call
:
ApplicationCall
,
servletResponse
:
HttpServletResponse
)
@Volatile
protected
var
completed
:
Boolean
protected
abstract
fun
createResponseJob
(
)
:
ReaderJob
open
val
headers
:
ResponseHeaders
suspend
fun
responseChannel
(
)
:
ByteWriteChannel
protected
val
servletResponse
:
HttpServletResponse
protected
open
fun
setStatus
(
statusCode
:
HttpStatusCode
)
:
Unit
val
ServletContextAttribute
:
AttributeKey
<
ServletContext
>
interface
ServletUpgrade
Module Contents
abstract
suspend
fun
performUpgrade
(
upgrade
:
ProtocolUpgrade
,
servletRequest
:
HttpServletRequest
,
servletResponse
:
HttpServletResponse
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
)
:
Unit
class
ServletUpgradeHandler
:
HttpUpgradeHandler
,
CoroutineScope
Module Contents
ServletUpgradeHandler
(
)
val
coroutineContext
:
<ERROR CLASS>
fun
destroy
(
)
:
Unit
fun
init
(
webConnection
:
WebConnection
?
)
:
Unit
@Volatile
lateinit
var
up
:
UpgradeRequest
@Volatile
lateinit
var
upgradeJob
:
CompletableJob
class
UpgradeRequest
Module Contents
UpgradeRequest
(
response
:
HttpServletResponse
,
upgradeMessage
:
ProtocolUpgrade
,
engineContext
:
<ERROR CLASS>
,
userContext
:
<ERROR CLASS>
,
disableAsyncInput
:
Boolean
)
val
disableAsyncInput
:
Boolean
val
engineContext
:
<ERROR CLASS>
val
response
:
HttpServletResponse
val
upgradeMessage
:
ProtocolUpgrade
val
userContext
:
<ERROR CLASS>
class
WebResourcesConfig
Module Contents
WebResourcesConfig
(
)
fun
exclude
(
predicate
:
(
path
:
String
)
->
Boolean
)
:
Unit
val
excludes
:
MutableList
<
(
String
)
->
Boolean
>
fun
include
(
predicate
:
(
path
:
String
)
->
Boolean
)
:
Unit
val
includes
:
MutableList
<
(
String
)
->
Boolean
>
var
mimeResolve
:
(
String
)
->
ContentType
io.ktor.application.ApplicationCall
Module Contents
fun
ApplicationCall
.
putServletAttributes
(
request
:
ServletRequest
)
:
Unit
io.ktor.request.ApplicationRequest
Module Contents
val
ApplicationRequest
.
javaSecurityPrincipal
:
Principal
?
val
ApplicationRequest
.
servletRequestAttributes
:
Map
<
String
,
Any
>
io.ktor.routing.Route
Module Contents
fun
Route
.
webResources
(
subPath
:
String
=
"/"
,
configure
:
WebResourcesConfig
.
(
)
->
Unit
=
{}
)
:
Unit
package
io.ktor.server.servlet.v4
Module Contents
fun
doPush
(
request
:
HttpServletRequest
,
builder
:
ResponsePushBuilder
)
:
Boolean