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, EnterpriseGrpcVaultServiceError, Failure, Failure, Failure, Failure, Failure, Failure, Failure, Failure, Shutdown, AuthenticationFailure, ChallengeFailure, AuthenticationFailure, ChallengeFailure, DomainTopologyManagerError, Failure, Failure, Failure, Failure, Reject, TopologyManagerParentError, Failure, Failure, TopologyDispatchingDegradation, SendRefused, SendTrackerTimeout, AsyncResultError, SendResultError, UnexpectedException, Impl, Error, Error, Reject, IdentityManagerParentError, Reject, CannotRemoveAdminWorkflowPackage, CannotRemoveOnlyDarForPackage, DarUnvettingError, MainPackageInUse, PackageInUse, PackageRemovalError, PackageVetted, ParticipantReplicationServiceError, Failure, Failure, PruningServiceError, Error, Error, Error, Error, Error, Error, Error, Error, Error, Error, Error, Error, Error, Error, DomainRegistryError, Error, Error, Error, Error, Error, Error, Error, Error, Error, Error, Error, DeserializationFailure, InitialOnboardingError, InvalidResponse, InvalidState, TopologyHandshakeError, Error, Error, Error, Error, Error, Error, AcsCommitmentDegradation, Report, Report, InconsistentRunningCommitmentAndACS, MultipleCommitmentsInBatch, SyncDomainMigrationError, DuplicateConfig, FailedMigratingContracts, FailedReadingAcs, Generic, PurgeDeactivatedDomain, ExpectedDomainIdsDiffer, InvalidDomainConfigStatus, SameDomainAlias, SourceAndTargetAreSame, SourceDomainIdUnknown, UnknownSourceDomain, MigrationParentError, SyncServiceError, Error, Error, Error, Error, UnrecoverableError, UnrecoverableException, Error, Error, Error, Error, SyncServiceFailedDomainConnection, CleanHeadAwaitFailed, DomainIsMissingInternally, Failure, InitError, UnknownDomainParameters, SyncServiceMigrationError, SyncServiceStartupError, Error, ParticipantTopologyManagerError, Missing, AlienParticipant, NoSuchKey, Reject, Reject, Reject, IdentityManagerParentError, Reject, DatabaseConnectionLost, DatabaseTaskRejected, Warn, ForkHappened, SequencedEventError, Error, Error, TopologyManagerError, ExistsAt, Failure, ParticipantStillHostsParties, PermanentlyInsecure, TemporarilyInsecure, Failure, CryptoPrivateError, CryptoPublicError, ImplementMe, IncompatibleOpMapping, Other, ReplaceExistingFailed, TopologySigningError, Failure, ThresholdTooHigh, TrafficLimitTooLow, Failure, Failure, Element, Mapping, Failure, Failure, Failure, Failure, Failure, Warn, Failure, Failure, Failure, WarnDomain, WarnParticipant, WarnSequencerClient, WarnDomain, WarnSequencerClient
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
    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
    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 asGoogleGrpcStatus(implicit loggingContext: ErrorLoggingContext): Status
    Definition Classes
    BaseCantonError
  5. def asGrpcError: StatusRuntimeException
  6. def asGrpcError(implicit loggingContext: ErrorLoggingContext): StatusRuntimeException
    Definition Classes
    BaseCantonError
  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() @IntrinsicCandidate()
  9. def context: Map[String, String]

    The context (declared fields) of this error

    The context (declared fields) of this error

    Definition Classes
    BaseCantonError → BaseError
  10. def definiteAnswerO: Option[Boolean]

    Controls whether a definite_answer error detail is added to the gRPC status code

    Controls whether a definite_answer error detail is added to the gRPC status code

    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() @IntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val location: Option[String]

    Contains the location where the error has been created.

    Contains the location where the error has been created.

    Definition Classes
    LocationMixin
  17. def log(): Unit
  18. def log()(implicit loggingContext: ErrorLoggingContext): Unit
    Definition Classes
    BaseCantonError
  19. 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.

  20. def logWithContext(extra: Map[String, String] = Map())(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Unit
    Definition Classes
    BaseError
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. def resources: Seq[(ErrorResource, String)]

    The resources related to this error

    The resources related to this error

    We return the set of resources via com.google.rpc.ResourceInfo. Override this method in order to return resource information via com.google.rpc.Status

    Definition Classes
    BaseError
  25. def retryable: Option[ErrorCategoryRetry]

    Returns retryability information of this particular error

    Returns retryability information of this particular error

    In some cases, error instances would like to provide custom retry intervals. This can be achieved by locally overriding this method.

    Do not use this to change the contract of the error categories. Non-retryable errors shouldn't be made retryable. Only use it for adjusting the retry intervals.

    Definition Classes
    BaseError
  26. def rpcStatus(overrideCode: Option[Code] = None)(implicit loggingContext: ContextualizedErrorLogger): Status
    Definition Classes
    BaseError
  27. def rpcStatusWithoutLoggingContext(): Status
    Definition Classes
    BaseCantonError
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def throwableO: Option[Throwable]

    An optional argument to log exceptions

    An optional argument to log exceptions

    If you want to log an exception as part of your error, then use the following example:

    object MyCode extends ErrorCode(id="SUPER_DUPER_ERROR") { case class MyError(someString: String, throwable: Throwable) extends SomeInternalError( cause = "Something failed with an exception bla", throwableO = Some(throwable) ) }

    NOTE: This throwable's details are not included the exception communicated to the gRPC clients so if you want them communicated, you need to explicitly add them to the e.g. context map or cause string.

    Definition Classes
    BaseError
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. 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 BaseCantonError

Inherited from BaseError

Inherited from LocationMixin

Inherited from AnyRef

Inherited from Any

Ungrouped