LifecycleHookedFeature

Features that require special hooking

Functions

Link copied to clipboard

Called just before an application is started (after onConfigurationLoaded, before the startAll call).

Link copied to clipboard
abstract fun createConfigObject(): T

Create an object that will be used as the receiver parameter for install(MyFeature) { HERE }

Link copied to clipboard
abstract fun ExtensibleContextBuilderDsl.install(configuration: T)

Callback when this feature is installed onto an environment.

Link copied to clipboard
open fun onConfigurationLoaded(configuration: RootConfig)

Called when the configuration for the application is loaded. This is called before any service is started.

Properties

Link copied to clipboard
open val dependencies: Set<Feature<*>>

Dependencies for this feature. Dependencies are features that will be installed together with (but not necessarily before) your feature.

Link copied to clipboard
abstract val description: String

A short description of what your feature provides.

Link copied to clipboard
abstract val id: String

The identifier for this feature. Should be a lower case kebab-case string (e.g. this-is-my-feature).

Link copied to clipboard
abstract val name: String

The name for your feature, e.g. My Feature.