object ConfigErrors extends ConfigErrorGroup
* Trait which acts as a wrapper around
lightbend ConfigExceptions which are caught when attempting to read or parse a configuration file 2.pureconfig ConfigReaderFailureswhich are returned when attempting to convert a given com.typesafe.config.Config instance (basically a valid HOCON-file) to one of the Canton configs
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- ConfigErrors
- ConfigErrorGroup
- ErrorGroup
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Type Members
- abstract class CantonConfigError extends CantonError
- sealed abstract class ConfigErrorCode extends ErrorCode
- sealed abstract class ExceptionBasedConfigError extends CantonConfigError
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() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit val errorClass: ErrorClass
- Definition Classes
- ErrorGroup
- val fullClassName: String
- Definition Classes
- ErrorGroup
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getMessage[ConfClass](failures: ConfigReaderFailures)(implicit arg0: ClassTag[ConfClass]): String
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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])
- case object CannotParseFilesError extends ConfigErrorCode with Product with Serializable
- Annotations
- @Explanation(explanation = "This error is usually thrown because a config file doesn't contain configs in valid HOCON format. " +
"The most common cause of an invalid HOCON format is a forgotten bracket.") @Resolution(resolution = "Make sure that all files are in valid HOCON format.")
- case object CannotReadFilesError extends ConfigErrorCode with Product with Serializable
- Annotations
- @Explanation(explanation = "This error is usually thrown when Canton can't find a given configuration file.") @Resolution(resolution = "Make sure that the path and name of all configuration files is correctly specified. ")
- case object GenericConfigError extends ConfigErrorCode with Product with Serializable
- Annotations
- @Resolution(resolution = """ In general, this can be one of many errors since this is the 'miscellaneous category' of configuration errors.
| One of the more common errors in this category is an 'unknown key' error. This error usually means that
| a keyword that is not valid (e.g. it may have a typo 'bort' instead of 'port'), or that a valid keyword
| at the wrong part of the configuration hierarchy was used (e.g. to enable database replication for a participant, the correct configuration
| is `canton.participants.participant2.replication.enabled = true` and not `canton.participants.replication.enabled = true`).
| Please refer to the scaladoc of either `CantonEnterpriseConfig` or `CantonCommunityConfig` (depending on whether the community or enterprise version is used) to find the valid configuration keywords and the correct position in the configuration hierarchy.
|""")
- case object NoConfigFiles extends ConfigErrorCode with Product with Serializable
- case object SubstitutionError extends ConfigErrorCode with Product with Serializable
- Annotations
- @Resolution(resolution = "A common cause of this error is attempting to use an environment variable that isn't defined within a config-file. ")
- case object ValidationError extends ConfigErrorCode with Product with Serializable