object CantonConfig
- Annotations
- @nowarn()
- Alphabetic
- By Inheritance
- CantonConfig
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- class ConfigReaders extends AnyRef
- class ConfigWriters extends AnyRef
writers
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- implicit val communityStorageConfigTypeHint: FieldCoproductHint[CommunityStorageConfig]
- lazy val defaultConfigRenderer: ConfigRenderOptions
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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.
- 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.
- 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.
- 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.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- 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.
- 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
iffiles
is empty
- 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.
- 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.
- implicit def preventAllUnknownKeys[T]: ProductHint[T]
- def renderForLoggingOnStartup(config: Config): String
Renders a configuration file such that we can write it to the log-file on startup
- implicit def serverConfigProductHint[SC <: ServerConfig]: ProductHint[SC]
In the external config we use
port
for an optionally set port, while internally we store it asinternalPort
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])