Class

com.sksamuel.exts.config

ConfigLoaderParams

Related Doc: package config

Permalink

case class ConfigLoaderParams(overrideConfInUserHome: Boolean = true, overrideConfInWorkingDir: Boolean = true, envConfInWorkingDir: Boolean = true, envConfInClasspath: Boolean = true, envConfInUserHome: Boolean = true, envConfFilename: String = "$ENV.conf", applicationConfName: String = "application.conf", configEnvParameterName: String = "CONFIG_ENV", overrideConfName: String = "override.conf") extends Product with Serializable

Supports environment and application config in an opinionated way.

Starting from the lowest priority to the highest:

- all reference.confs are loaded from the classpath and merged; the order is not defined. - application.conf is loaded from the classpath - ENV.conf is loaded from working dir, user home, and classpath in that order, and merged. - override.conf is loaded from working dir and user home and merged.

Override.conf is designed to allow easy, temporary, overrides at runtime for a particular process, and therefore is only ever loaded from the user home and cwd.

The env config is designed to change between environments. The filename has a placeholder $ENV which is replaced by the value of the system property called by default CONFIG_ENV. If no env is found, it will default to LOCAL.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigLoaderParams
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConfigLoaderParams(overrideConfInUserHome: Boolean = true, overrideConfInWorkingDir: Boolean = true, envConfInWorkingDir: Boolean = true, envConfInClasspath: Boolean = true, envConfInUserHome: Boolean = true, envConfFilename: String = "$ENV.conf", applicationConfName: String = "application.conf", configEnvParameterName: String = "CONFIG_ENV", overrideConfName: String = "override.conf")

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val applicationConfName: String

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val configEnvParameterName: String

    Permalink
  8. val envConfFilename: String

    Permalink
  9. val envConfInClasspath: Boolean

    Permalink
  10. val envConfInUserHome: Boolean

    Permalink
  11. val envConfInWorkingDir: Boolean

    Permalink
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. val overrideConfInUserHome: Boolean

    Permalink
  20. val overrideConfInWorkingDir: Boolean

    Permalink
  21. val overrideConfName: String

    Permalink
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped