Packages

object CantonConfig

Annotations
@nowarn()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CantonConfig
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class ConfigReaders extends AnyRef
  2. class ConfigWriters extends AnyRef

    writers

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. implicit val communityStorageConfigTypeHint: FieldCoproductHint[CommunityStorageConfig]
  7. lazy val defaultConfigRenderer: ConfigRenderOptions
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def loadAndValidate[ConfClass <: CantonConfig with ConfigDefaults[DefaultPorts, ConfClass]](config: Config)(implicit arg0: ClassTag[ConfClass], arg1: ConfigReader[ConfClass], elc: ErrorLoggingContext): Either[CantonConfigError, ConfClass]

    Will load a case class configuration (defined by template args) from the configuration object.

    Will load a case class configuration (defined by template args) from the configuration object. Any configuration errors encountered will be returned (but not logged).

    returns

    scala.Right of type CantonConfig (e.g. CantonCommunityConfig)) if parsing was successful.

  14. def loadOrExit[ConfClass <: CantonConfig with ConfigDefaults[DefaultPorts, ConfClass]](config: Config)(implicit arg0: ClassTag[ConfClass], arg1: ConfigReader[ConfClass], elc: ErrorLoggingContext): ConfClass

    Will load a case class configuration (defined by template args) from the configuration object.

    Will load a case class configuration (defined by template args) from the configuration object. If any configuration errors are encountered, they will be logged and the thread will exit with code 1.

    returns

    scala.Right of type ClassTag (e.g. CantonCommunityConfig)) if parsing was successful.

  15. def mergeConfigs(configs: NonEmpty[Seq[Config]]): Config

    Merge a number of com.typesafe.config.Config instances into a single com.typesafe.config.Config.

    Merge a number of com.typesafe.config.Config instances into a single com.typesafe.config.Config. If the same key is included in multiple configurations, then the last definition has highest precedence.

  16. def mergeConfigs(firstConfig: Config, otherConfigs: Seq[Config]): Config

    Merge a number of com.typesafe.config.Config instances into a single com.typesafe.config.Config.

    Merge a number of com.typesafe.config.Config instances into a single com.typesafe.config.Config. If the same key is included in multiple configurations, then the last definition has highest precedence.

  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. def parseAndLoad[ConfClass <: CantonConfig with ConfigDefaults[DefaultPorts, ConfClass]](files: Seq[File])(implicit arg0: ClassTag[ConfClass], arg1: ConfigReader[ConfClass], elc: ErrorLoggingContext): Either[CantonConfigError, ConfClass]

    Parses the provided files to generate a com.typesafe.config.Config, then attempts to load the com.typesafe.config.Config based on the given ClassTag.

    Parses the provided files to generate a com.typesafe.config.Config, then attempts to load the com.typesafe.config.Config based on the given ClassTag. Will return an error (but not log anything) if any steps fails.

    files

    config files to read, parse and merge

    returns

    scala.Right of type ConfClass (e.g. CantonCommunityConfig)) if parsing was successful.

  21. def parseAndLoadOrExit[ConfClass <: CantonConfig with ConfigDefaults[DefaultPorts, ConfClass]](files: Seq[File])(implicit arg0: ClassTag[ConfClass], arg1: ConfigReader[ConfClass], elc: ErrorLoggingContext): ConfClass

    Parses the provided files to generate a com.typesafe.config.Config, then attempts to load the com.typesafe.config.Config based on the given ClassTag.

    Parses the provided files to generate a com.typesafe.config.Config, then attempts to load the com.typesafe.config.Config based on the given ClassTag. Will log the error and exit with code 1, if any error is encountered. *

    files

    config files to read - must be a non-empty Seq

    returns

    scala.Right of type ClassTag (e.g. CantonCommunityConfig)) if parsing was successful.

    Exceptions thrown

    java.lang.IllegalArgumentException if files is empty

  22. def parseAndMergeConfigs(files: NonEmpty[Seq[File]])(implicit elc: ErrorLoggingContext): Either[CantonConfigError, Config]

    Parses and merges the provided configuration files into a single com.typesafe.config.Config.

    Parses and merges the provided configuration files into a single com.typesafe.config.Config. Also loads and merges the default config (as defined by the Lightbend config library) with the provided configuration files. Unless you know that you explicitly only want to use the provided configuration files, use this method. Any errors will be returned, but not logged.

    files

    config files to read, parse and merge

    returns

    scala.Right com.typesafe.config.Config if parsing was successful.

  23. def parseAndMergeJustCLIConfigs(files: NonEmpty[Seq[File]])(implicit elc: ErrorLoggingContext): Either[CantonConfigError, Config]

    Parses and merges the provided configuration files into a single com.typesafe.config.Config.

    Parses and merges the provided configuration files into a single com.typesafe.config.Config. Does not load and merge the default config (as defined by the Lightbend config library) with the provided configuration files. Only use this if you explicitly know that you don't want to load and merge the default config.

    files

    config files to read, parse and merge

    returns

    scala.Right com.typesafe.config.Config if parsing was successful.

  24. implicit def preventAllUnknownKeys[T]: ProductHint[T]
  25. def renderForLoggingOnStartup(config: Config): String

    Renders a configuration file such that we can write it to the log-file on startup

  26. implicit def serverConfigProductHint[SC <: ServerConfig]: ProductHint[SC]

    In the external config we use port for an optionally set port, while internally we store it as internalPort

  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped