trait CantonError extends BaseCantonError

CantonErrors are logged immediately when they are created. Therefore, they usually expect an implicit com.digitalasset.canton.logging.ErrorLoggingContext to be around when they are created. If you are creating such an error in a class extending com.digitalasset.canton.logging.NamedLogging, then the implicit function will provide you with such a context. If you don't have that context, then you can also use BaseCantonError and invoke the logging yourself at a later point in time (which is what we do, for example, with TransactionError).

Linear Supertypes
BaseCantonError, BaseError, LocationMixin, AnyRef, Any
Known Subclasses
Wrap, Error, Error, CantonConfigError, ExceptionBasedConfigError, Error, Error, Error, Error, Warn, SigningTolerance, TopologyManagerId, Warn, Error, Error, AuthenticationFailure, ChallengeFailure, AuthenticationFailure, ChallengeFailure, DomainTopologyManagerError, Failure, Failure, Failure, TopologyManagerParentError, Failure, TopologyDispatchingDegradation, SendRefused, SendTrackerTimeout, AsyncResultError, SendResultError, UnexpectedException, Impl, Error, IdentityManagerParentError, PackageInUse, PackageRemovalError, PackageVetted, ParticipantReplicationServiceError, Failure, Failure, PruningServiceError, Error, Error, Error, Error, DomainRegistryError, Error, Error, Error, Error, Error, Error, Error, Error, DeserializationFailure, FailedToAddParticipantDomainStateCert, IdentityHandshakeError, InvalidResponse, InvalidState, Error, Error, Error, Error, Error, MultipleCommitmentsInBatch, Mismatch, Mismatch, SyncServiceError, Error, Error, Error, UnrecoverableError, UnrecoverableException, SyncServiceFailedDomainConnection, DomainIsMissingInternally, Failure, InitError, MissingDomainConfig, UnknownDomainParameters, SyncServiceStartupError, Error, ParticipantTopologyManagerError, Missing, AlienParticipant, NoSuchKey, Reject, Reject, IdentityManagerParentError, Reject, DatabaseTaskRejected, Warn, Error, TopologyManagerError, Failure, Failure, CryptoPrivateError, CryptoPublicError, IncompatibleOpMapping, ReplaceExistingFailed, TopologySigningError, Failure, Failure, Failure, Element, Mapping, Failure, Failure, Failure, Failure
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CantonError
  2. BaseCantonError
  3. BaseError
  4. LocationMixin
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def cause: String

    A human readable string indicating the error

    A human readable string indicating the error

    Definition Classes
    BaseCantonError → BaseError
  2. abstract def code: ErrorCode

    The error code, usually passed in as implicit where the error class is defined

    The error code, usually passed in as implicit where the error class is defined

    Definition Classes
    BaseCantonError → BaseError
  3. abstract def loggingContext: ErrorLoggingContext

    The logging context obtained when we created the error, usually passed in as implicit via com.digitalasset.canton.logging.NamedLogging

Concrete 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. def asGrpcError: StatusRuntimeException
  5. def asGrpcErrorFromContext(implicit contextualizedErrorLogger: ContextualizedErrorLogger): StatusRuntimeException
    Definition Classes
    BaseError
  6. def asGrpcStatusFromContext(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Status
    Definition Classes
    BaseError
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def context: Map[String, String]
    Definition Classes
    BaseError
  10. def definiteAnswerO: Option[Boolean]
    Definition Classes
    BaseError
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val location: Option[String]
    Definition Classes
    LocationMixin
  17. def log(): Unit
  18. def logOnCreation: Boolean

    Flag to control if an error should be logged at creation

    Flag to control if an error should be logged at creation

    Generally, we do want to log upon creation, except in the case of "nested" or combined errors, where we just nest the error but don't want it to be logged twice. See com.digitalasset.canton.error.ParentCantonError as an example.

  19. def logWithContext(extra: Map[String, String])(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Unit
    Definition Classes
    BaseError
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def resources: Seq[(ErrorResource, String)]
    Definition Classes
    BaseError
  24. def retryable: Option[ErrorCategoryRetry]
    Definition Classes
    BaseError
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def throwableO: Option[Throwable]
    Definition Classes
    BaseError
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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

Inherited from BaseCantonError

Inherited from BaseError

Inherited from LocationMixin

Inherited from AnyRef

Inherited from Any

Ungrouped