ktor-server-core/io.ktor.server.config

Package-level declarations

Types

ApplicationConfig

interface ApplicationConfig

Represents an application config node

ApplicationConfigurationException

class ApplicationConfigurationException(message: String, cause: Throwable?) : Exception

Thrown when an application is misconfigured

ApplicationConfigValue

interface ApplicationConfigValue

Represents an application config value

ConfigLoader

interface ConfigLoader

Loads an application configuration. An implementation of this interface should return ApplicationConfig if applicable configuration is found or null otherwise.

HoconApplicationConfig

open class HoconApplicationConfig(config: Config) : ApplicationConfig

Implements ApplicationConfig by loading configuration from HOCON data structures

HoconConfigLoader

class HoconConfigLoader : ConfigLoader

Loads a Config from a hocon file.

MapApplicationConfig

open class MapApplicationConfig : ApplicationConfig

Mutable application config backed by a hash map

Properties

configLoaders

expect val configLoaders: List<ConfigLoader>

List of all registered ConfigLoader implementations.

actual val configLoaders: List<ConfigLoader>

List of all registered ConfigLoader implementations.

Functions

addConfigLoader

fun addConfigLoader(loader: ConfigLoader)

ApplicationConfig

fun ApplicationConfig(configPath: String?): ApplicationConfig

Returns ApplicationConfig by loading configuration from a resource specified by configPath or a default resource if configPath is null

merge

fun List<ApplicationConfig>.~~merge~~(): ApplicationConfig

Merge configuration combining all their keys. If key is not found in one of the configs, search will continue in the next config in the list.

mergeWith

fun ApplicationConfig.mergeWith(other: ApplicationConfig): ApplicationConfig

Merge configuration combining all their keys. If the key exists in this and other config, the value from the other config will be used.

tryGetString

fun ApplicationConfig.tryGetString(key: String): String?

Try read String value from ApplicationConfig.

fun Config.tryGetString(path: String): String?

Returns a string value for path or null if missing

tryGetStringList

fun ApplicationConfig.tryGetStringList(key: String): List<String>?

Try read String value from ApplicationConfig.

fun Config.tryGetStringList(path: String): List<String>?

Returns a list of values for path or null if missing

withFallback

fun ApplicationConfig.withFallback(other: ApplicationConfig): ApplicationConfig

Merge configuration combining all their keys. If the key exists in this and other config, the value from this config will be used.