trait BaseError extends LocationMixin

The main error interface for everything that should be logged and notified.

There are two ways to communicate an error to the user: write it into a log or send it as a string. In most cases, we'll do both: log the error appropriately locally and communicate it to the user by failing the API call with an error string.

Linear Supertypes
LocationMixin, AnyRef, Any
Known Subclasses
ContextualizedError, DamlError, DamlErrorWithDefiniteAnswer, Error, DeserializedCantonError, Wrap, Error, Error, CantonConfigError, ExceptionBasedConfigError, Error, Error, Error, Error, CantonCommandError, ErrorWithException, NullError, Error, ErrorCanton, EnterpriseGrpcVaultServiceError, Failure, Failure, Failure, Failure, Failure, Failure, Failure, Failure, Shutdown, Error, Error, Error, Error, Error, Error, Error, Error, Error, Error, Error, AuthenticationFailure, ChallengeFailure, AuthenticationFailure, ChallengeFailure, DomainTopologyManagerError, Failure, Failure, Failure, Failure, Reject, TopologyManagerParentError, Failure, Failure, TopologyDispatchingDegradation, SendRefused, SendTrackerTimeout, AsyncResultError, SendResultError, UnexpectedException, Alarm, BaseAlarm, BaseCantonError, Impl, CantonError, Impl, Warn, TopologyManagerId, Error, Warn, Error, Error, Error, Warn, Warn, Warn, Warn, Warn, Warn, Warn, Warn, GenericError, Reject, Reject, Reject, Reject, ParentCantonError, Impl, TransactionError, TransactionErrorImpl, TransactionParentError, Reject, Reject, Reject, Generic, UnexpectedOrUnknownException, Reject, Reject, Reject, Reject, Reject, DbError, Rejection, Buffer, Generic, Interpretation, PackageInternal, PackageSelfConsistency, Preprocessing, UnexpectedOrUnknownException, Validation, VersionService, Rejection, Rejection, Rejection, Error, Generic, Unhandled, Validation, Error, Error, Error, Error, Error, Error, Error, AllowedLanguageMismatchError, Error, Error, Error, Error, Reject, Reject, Reject, Reject, Reject, Reject, Reject, MissingJwtToken, UserBasedAuthenticationIsDisabled, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Error, Reject, Reject, Error, Reject, Reject, Reject, Reject, Reject, Reject, Error, Reject, Reject, Reject, Reject, Reject, Reject, Reject, RejectWithContractKeyArg, Reject, Reject, RejectWithContractKeyArg, Reject, RejectEnriched, RejectSimple, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Error, Reject, RejectWithMessage, Reject, InterpretationReject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, RejectWithSubmitterAndParticipantId, Reject, Error, Error, Reject, IdentityManagerParentError, Reject, CannotRemoveAdminWorkflowPackage, CannotRemoveOnlyDarForPackage, DarUnvettingError, MainPackageInUse, PackageInUse, PackageRemovalError, PackageVetted, ParticipantReplicationServiceError, Failure, Failure, PruningServiceError, Error, Error, Error, Error, Error, Error, RepairServiceError, 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, Error, Rejection, Error, Error, Error, Error, Rejection, Error, SubmissionAlreadyInFlight, Rejection, Error, Error, TransactionSubmissionError, AcsCommitmentDegradation, Report, Report, InconsistentRunningCommitmentAndACS, MultipleCommitmentsInBatch, Warn, Mismatch, Mismatch, DeduplicationPeriodStartsTooEarlyErrorWithDuration, DeduplicationPeriodStartsTooEarlyErrorWithOffset, DuplicateCommandReject, Error, SyncDomainMigrationError, DuplicateConfig, FailedMigratingContracts, FailedReadingAcs, Generic, PurgeDeactivatedDomain, ExpectedDomainIdsDiffer, InvalidDomainConfigStatus, SameDomainAlias, SourceAndTargetAreSame, SourceDomainIdUnknown, UnknownSourceDomain, MigrationParentError, SyncServiceError, Error, Warn, Error, Error, Error, UnrecoverableError, UnrecoverableException, Error, Error, Error, Error, SyncServiceFailedDomainConnection, CleanHeadAwaitFailed, DomainIsMissingInternally, Failure, InitError, UnknownDomainParameters, SyncServiceMigrationError, SyncServiceStartupError, Error, Failure, Error, Error, TransactionRoutingError, Failed, Generic, InputContractsNotOnDomain, NotAllInformeeAreOnDomain, Error, Error, Error, Error, Error, Error, Error, Error, IllformedTransaction, InputContractsOnDifferentDomains, SubmissionError, Error, Error, Error, NoSuitableDomain, NotAllowed, Error, Error, Error, Error, Error, Error, Failed, TransactionRoutingErrorWithDomain, ParticipantTopologyManagerError, Missing, AlienParticipant, NoSuchKey, Reject, Reject, Reject, IdentityManagerParentError, Reject, LocalReject, Reject, Reject, Reject, Reject, Reject, GenericReject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, Reject, LocalRejectImpl, Malformed, DatabaseConnectionLost, DatabaseTaskRejected, Warn, ForkHappened, SequencedEventError, Error, Error, SequencerDeliverError, 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, RejectDeprecated
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseError
  2. LocationMixin
  3. AnyRef
  4. 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

  2. abstract def code: ErrorCode

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

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. 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() @IntrinsicCandidate()
  6. def context: Map[String, String]

    The context (declared fields) of this error

  7. def definiteAnswerO: Option[Boolean]

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

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. 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
  14. def logWithContext(extra: Map[String, String] = Map())(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Unit
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. 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

  19. 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.

  20. def rpcStatus(overrideCode: Option[Code] = None)(implicit loggingContext: ContextualizedErrorLogger): Status
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. 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.

  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. 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 LocationMixin

Inherited from AnyRef

Inherited from Any

Ungrouped