root/fi.utu.tech.serverkit/AppBase

AppBase

abstract class AppBase(val auth: Auth, val logger: SystemLogger, val debugMode: Boolean, val configuration: ServerConfiguration, val shutdownHook: () -> Unit = {}) : Closeable

Inheritors

TaskBackend

TaskFrontend

Constructors

AppBase

constructor(auth: Auth, logger: SystemLogger, debugMode: Boolean, configuration: ServerConfiguration, shutdownHook: () -> Unit = {})

Properties

app

abstract val app: <Error class: unknown class>

auth

val auth: Auth

configuration

val configuration: ServerConfiguration

debugMode

val debugMode: Boolean

logger

val logger: SystemLogger

prefix

val prefix: String

requireLogin

val requireLogin: <Error class: unknown class>

securityConfig

val securityConfig: Nothing?

shutdownHook

val shutdownHook: () -> Unit

Functions

authHandler

fun authHandler(ctx: <Error class: unknown class>)

Throws ForbiddenResponse / UnauthorizedResponse / etc. if needed

checkAccess

fun checkAccess(permittedRoles: Collection<<Error class: unknown class>>, userEntry: UserEntry?): Boolean

open override fun close()

currentPrincipal

fun currentPrincipal(ctx: <Error class: unknown class>): Principal?

getProfiles

fun getProfiles(ctx: <Error class: unknown class>): List<<Error class: unknown class>>

initialize

fun initialize(config: <Error class: unknown class>)

launch

open fun launch()

localLogout

fun localLogout(): <Error class: unknown class>

logErrors

fun logErrors(handler: (<Error class: unknown class>) -> Unit): <Error class: unknown class>

oidcUserId

fun oidcUserId(profile: <Error class: unknown class>): String

permissionAnyone

abstract fun permissionAnyone(): PermissionRole

permissionRegisteredUser

open fun permissionRegisteredUser(): PermissionRole?

principalFromBasic

fun principalFromBasic(ctx: <Error class: unknown class>): Principal?

principalFromOidc

fun principalFromOidc(ctx: <Error class: unknown class>): Principal?

sanitizeReturnTo

fun sanitizeReturnTo(rt: String?): String

shutdown

fun shutdown(): <Error class: unknown class>

testPrincipal

open fun testPrincipal(): Principal?