keel-core/com.keel.kernel.plugin

Package-level declarations

Types

data class ApplicationKtorInstaller(val pluginKey: String, val installer: Application.() -> Unit)

data class DefaultPluginRequestContext(val pluginId: String, val method: String, val rawPath: String, val pathParameters: Map<String, String>, val queryParameters: Map<String, List<String>>, val requestHeaders: Map<String, List<String>>, val requestId: String, val attributes: MutableMap<String, Any?> = linkedMapOf(), var principal: Any? = null, var tenant: Any? = null) : KeelRequestContext

EndpointExecutionPolicy

data class EndpointExecutionPolicy(val timeoutMs: Long? = null, val maxPayloadBytes: Long? = null, val allowChunkedTransfer: Boolean = false)

EndpointPlugin

interface EndpointPlugin

GeneratedKeelRouteInterceptorMetadata

data class GeneratedKeelRouteInterceptorMetadata(val method: String, val path: String, val clearDefaults: Boolean = false, val interceptorClassNames: List<String> = emptyList())

InterceptorMetadataSource

enum InterceptorMetadataSource : Enum<InterceptorMetadataSource>

JvmCommunicationMode

enum JvmCommunicationMode : Enum<JvmCommunicationMode>

JvmCommunicationStrategy

data class JvmCommunicationStrategy(val preferredMode: JvmCommunicationMode = JvmCommunicationMode.UDS, val fallbackMode: JvmCommunicationMode = JvmCommunicationMode.TCP, val maxAttempts: Int = 3)

KeelGeneratedInterceptorMetadataProvider

interface KeelGeneratedInterceptorMetadataProvider

KeelInterceptorResult

sealed interface KeelInterceptorResult

KeelPlugin

interface KeelPlugin

KeelRequestContext

interface KeelRequestContext

KeelRequestInterceptor

interface KeelRequestInterceptor

KtorScopedPlugin

interface KtorScopedPlugin

LifecyclePlugin

interface LifecyclePlugin

ModulePlugin

interface ModulePlugin

PluginApiException

class PluginApiException(val status: Int, val message: String) : RuntimeException

PluginAvailability

interface PluginAvailability

PluginChannelHealth

enum PluginChannelHealth : Enum<PluginChannelHealth>

PluginConfig

data class PluginConfig(val pluginId: String, val enabled: Boolean = true, val runtimeMode: PluginRuntimeMode = PluginRuntimeMode.IN_PROCESS, val communicationStrategy: JvmCommunicationStrategy = JvmCommunicationStrategy.DEFAULT, val recoveryPolicy: PluginRecoveryPolicy = PluginRecoveryPolicy(), val startupTimeoutMs: Long = 5000, val callTimeoutMs: Long = 3000, val stopTimeoutMs: Long = 3000, val healthCheckIntervalMs: Long = 10000, val maxConcurrentCalls: Int = 128, val eventLogRingBufferSize: Int = 4096, val criticalEventQueueSize: Int = 256, val reload: ReloadConfig = ReloadConfig(), val settings: JsonObject = buildJsonObject {})

Runtime configuration for a plugin instance, derived from its PluginDescriptor. This is no longer loaded from JSON files to ensure "Config-as-Code".

PluginDescriptor

data class PluginDescriptor(val pluginId: String, val version: String, val displayName: String, val defaultRuntimeMode: PluginRuntimeMode = PluginRuntimeMode.IN_PROCESS, val communicationStrategy: JvmCommunicationStrategy = JvmCommunicationStrategy.DEFAULT, val supportedRuntimeModes: Set<PluginRuntimeMode> = setOf( PluginRuntimeMode.IN_PROCESS, PluginRuntimeMode.EXTERNAL_JVM ), val supportedServices: Set<PluginServiceType> = setOf( PluginServiceType.ENDPOINT, PluginServiceType.SSE, PluginServiceType.STATIC_RESOURCE ), val recoveryPolicy: PluginRecoveryPolicy = PluginRecoveryPolicy(), val startupTimeoutMs: Long = 5000, val callTimeoutMs: Long = 3000, val stopTimeoutMs: Long = 3000, val healthCheckIntervalMs: Long = 10000, val maxConcurrentCalls: Int = 128, val eventLogRingBufferSize: Int = 4096, val criticalEventQueueSize: Int = 256, val nodeAssetMetadata: PluginNodeAssetMetadata? = null)

PluginDispatchDisposition

enum PluginDispatchDisposition : Enum<PluginDispatchDisposition>

PluginEndpointBuilders

object PluginEndpointBuilders

PluginEndpointDefinition

data class PluginEndpointDefinition<Req : Any, Res : Any>(val endpointId: String, val method: HttpMethod, val path: String, val requestType: KType?, val responseType: KType, val doc: OpenApiDoc = OpenApiDoc(), val executionPolicy: EndpointExecutionPolicy = EndpointExecutionPolicy(), val interceptors: List<KClass<out KeelRequestInterceptor>> = emptyList(), val interceptorSource: InterceptorMetadataSource = InterceptorMetadataSource.NONE, val handler: suspend KeelRequestContext.(Req?) -> PluginResult<Res>) : PluginRouteDefinition

PluginEndpointDsl

class PluginEndpointDsl

PluginFailureRecord

data class PluginFailureRecord(val timestamp: Long, val source: String, val message: String)

PluginGeneration

@JvmInline

value class PluginGeneration(val value: Long)

PluginHealthState

enum PluginHealthState : Enum<PluginHealthState>

PluginInitContext

interface PluginInitContext

PluginKtorConfig

class PluginKtorConfig

PluginLifecycleState

enum PluginLifecycleState : Enum<PluginLifecycleState>

PluginNodeAssetMetadata

@Serializable

data class PluginNodeAssetMetadata(val assetId: String? = null, val address: String? = null, val zone: String? = null, val region: String? = null, val role: String? = null, val roleDescription: String? = null, val featured: Boolean = false)

PluginProcessState

enum PluginProcessState : Enum<PluginProcessState>

PluginRecoveryPolicy

data class PluginRecoveryPolicy(val maxRestarts: Int = 5, val baseBackoffMs: Long = 250, val maxBackoffMs: Long = 5000, val resetWindowMs: Long = 60000)

PluginResult

data class PluginResult<T>(val status: Int = 200, val headers: Map<String, List<String>> = emptyMap(), val body: T? = null)

PluginRouteDefinition

sealed interface PluginRouteDefinition

PluginRuntimeContext

interface PluginRuntimeContext : PluginInitContext

PluginRuntimeDiagnostics

data class PluginRuntimeDiagnostics(val processAlive: Boolean? = null, val adminChannelHealth: PluginChannelHealth = PluginChannelHealth.UNKNOWN, val eventChannelHealth: PluginChannelHealth = PluginChannelHealth.UNKNOWN, val activeCommunicationMode: JvmCommunicationMode? = null, val fallbackActivated: Boolean = false, val lastFallbackReason: String? = null, val droppedLogCount: Long = 0, val eventQueueDepth: Int = 0, val eventOverflowed: Boolean = false, val lastHealthLatencyMs: Long? = null, val lastAdminLatencyMs: Long? = null, val lastEventAtEpochMs: Long? = null, val inflightInvocations: Int = 0, val processCpuLoadPercent: Double? = null, val heapUsedBytes: Long? = null, val heapMaxBytes: Long? = null, val heapUsedPercent: Double? = null, val assetMetadata: PluginNodeAssetMetadata? = null)

PluginRuntimeMode

enum PluginRuntimeMode : Enum<PluginRuntimeMode>

PluginRuntimeSnapshot

data class PluginRuntimeSnapshot(val pluginId: String, val displayName: String, val version: String, val runtimeMode: PluginRuntimeMode, val lifecycleState: PluginLifecycleState, val healthState: PluginHealthState, val generation: PluginGeneration, val processState: PluginProcessState?, val processId: Long?, val processHandleAlive: Boolean? = null, val diagnostics: PluginRuntimeDiagnostics, val lastFailure: PluginFailureRecord? = null)

PluginServiceType

enum PluginServiceType : Enum<PluginServiceType>

PluginSseDefinition

data class PluginSseDefinition(val path: String, val doc: OpenApiDoc = OpenApiDoc(), val handler: suspend PluginSseSession.() -> Unit) : PluginRouteDefinition

PluginSseSession

class PluginSseSession

PluginStaticResourceDefinition

data class PluginStaticResourceDefinition(val path: String, val basePackage: String, val doc: OpenApiDoc = OpenApiDoc(), val index: String? = null) : PluginRouteDefinition

PluginTeardownRegistry

class PluginTeardownRegistry

ReloadConfig

data class ReloadConfig(val watchEnabled: Boolean = false, val debounceMs: Long = 500, val replaceOnArtifactChange: Boolean = true, val reloadOnConfigChange: Boolean = true)

ServiceKtorInstaller

data class ServiceKtorInstaller(val pluginKey: String, val installer: Route.() -> Unit)

ServiceKtorPluginConfig

class ServiceKtorPluginConfig

StandardKeelPlugin

interface StandardKeelPlugin : KeelPlugin, LifecyclePlugin, EndpointPlugin, ModulePlugin, KtorScopedPlugin

UnifiedPluginManager

class UnifiedPluginManager(kernelKoin: Koin, runtimeRoot: File = File("/tmp/keel"), currentClasspath: String = System.getProperty("java.class.path"), observabilityHub: ObservabilityHub? = null) : PluginAvailability

Functions

buildEndpointId

fun buildEndpointId(pluginId: String, method: HttpMethod, path: String): String

toConfig

fun PluginDescriptor.toConfig(enabled: Boolean = true): PluginConfig