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

MapApplicationConfig

open class MapApplicationConfig : ApplicationConfig

Mutable application config backed by a hash map

Constructors

MapApplicationConfig

fun MapApplicationConfig(values: List<Pair<String, String>>)

MapApplicationConfig

fun MapApplicationConfig(vararg values: Pair<String, String>)

MapApplicationConfig

fun MapApplicationConfig()

Functions

open override fun config(path: String): ApplicationConfig

Get config child node or fail

open override fun configList(path: String): List<ApplicationConfig>

Get a list of child nodes for path or fail

open override fun keys(): Set<String>

Returns the set of keys, found by recursing the root object. All entries represent leaf nodes' keys, meaning that there would be no nested objects directly included as values for returned keys. It's still possible that entries may be a list and the lists may contain objects.

open override fun property(path: String): ApplicationConfigValue

Get config property with path or fail

open override fun propertyOrNull(path: String): ApplicationConfigValue?

Get config property value for path or return null

fun put(path: String, value: String)

Set property value

fun put(path: String, values: Iterable<String>)

Put list property value

open override fun toMap(): Map<String, Any?>

Returns map representation of this config. Values can be String, Map<String, Any>, List<String> and List<Map<String, Any>>

Extensions

val ApplicationConfig.host: String

The host address of the currently running application, as defined by the configuration at start-up.

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.

val ApplicationConfig.port: Int

The port the current application is running on, as defined by the configuration at start-up.

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

Try read String value from ApplicationConfig.

tryGetStringList

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

Try read String value from ApplicationConfig.

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.