Packages

object ConfigErrors extends ConfigErrorGroup

* Trait which acts as a wrapper around

  1. lightbend ConfigExceptions which are caught when attempting to read or parse a configuration file 2. pureconfig ConfigReaderFailures which are returned when attempting to convert a given com.typesafe.config.Config instance (basically a valid HOCON-file) to one of the Canton configs
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigErrors
  2. ConfigErrorGroup
  3. ErrorGroup
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract class CantonConfigError extends CantonError
  2. sealed abstract class ConfigErrorCode extends ErrorCode
  3. sealed abstract class ExceptionBasedConfigError extends CantonConfigError

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() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. implicit val errorClass: ErrorClass
    Definition Classes
    ErrorGroup
  9. val fullClassName: String
    Definition Classes
    ErrorGroup
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def getMessage[ConfClass](failures: ConfigReaderFailures)(implicit arg0: ClassTag[ConfClass]): String
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. 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.")
  23. 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. ")
  24. 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.
    |"""
    )
  25. case object NoConfigFiles extends ConfigErrorCode with Product with Serializable
  26. 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. ")
  27. case object ValidationError extends ConfigErrorCode with Product with Serializable

Deprecated Value Members

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

Inherited from ConfigErrorGroup

Inherited from ErrorGroup

Inherited from AnyRef

Inherited from Any

Ungrouped