com.sksamuel.exts.config

ConfigLoaderParams

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.

Annotations
@deprecated
Deprecated

(Since version 1.47.0) use ConfigResolver

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
Learn more about member selection
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")

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. val applicationConfName: String

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. val configEnvParameterName: String

  10. val envConfFilename: String

  11. val envConfInClasspath: Boolean

  12. val envConfInUserHome: Boolean

  13. val envConfInWorkingDir: Boolean

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. val overrideConfInUserHome: Boolean

  22. val overrideConfInWorkingDir: Boolean

  23. val overrideConfName: String

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

    Definition Classes
    AnyRef

  25. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped