kobweb-api/com.varabyte.kobweb.api.intercept/ApiInterceptorContext

ApiInterceptorContext

class ApiInterceptorContext(val env: Environment, val dispatcher: Apis.Dispatcher, val path: String, val req: MutableRequest, val data: Data, val logger: Logger)(source)

A context for a method annotated with ApiInterceptor.

The classes can be used to help the user write interception logic, dispatching the request either to its original endpoint, an alternate one, or simply returning a custom response instead entirely. See ApiInterceptor for more information.

Constructors

constructor(env: Environment, dispatcher: Apis.Dispatcher, path: String, req: MutableRequest, data: Data, logger: Logger)

Properties

data

val data: Data

Readonly data store potentially populated by methods annotated with InitApi. See also: InitApiContext.

dispatcher

val dispatcher: Apis.Dispatcher

env

val env: Environment

The current server environment, in case you need to branch logic in development vs production environments.

logger

val logger: Logger

A logger which can be used to log messages into the log files.

path

val path: String

The path of the API endpoint being requested, including a leading slash.

req

val req: MutableRequest

Request information sent from the client. This instance of the request is mutable, meaning some fields (headers, cookies, body, and content-type) can still be changed.