Packages

final class RepairService extends NamedLogging with FlagCloseable with HasCloseContext

Implements the repair commands. Repair commands work only if the participant has disconnected from the affected domains. Every individual repair commands is executed transactionally, i.e., either all its effects are applied or none. This is achieved in the same way as for request processing:

If anything goes wrong before advancing the clean request prehead, the already persisted data will be cleaned up upon the next repair request or reconnection to the domain.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RepairService
  2. HasCloseContext
  3. PromiseUnlessShutdownFactory
  4. FlagCloseable
  5. PerformUnlessClosing
  6. OnShutdownRunner
  7. AutoCloseable
  8. NamedLogging
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RepairService(participantId: ParticipantId, syncCrypto: SyncCryptoApiProvider, packageDependencyResolver: PackageDependencyResolver, damle: DAMLe, multiDomainEventLog: Eval[MultiDomainEventLog], syncDomainPersistentStateManager: SyncDomainPersistentStateManager, aliasManager: DomainAliasManager, parameters: ParticipantNodeParameters, threadsAvailableForWriting: PositiveInt, indexedStringStore: IndexedStringStore, isConnected: (DomainId) => Boolean, executionQueue: SimpleExecutionQueue, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

    executionQueue

    Sequential execution queue on which repair actions must be run. This queue is shared with the CantonSyncService, which uses it for domain connections. Sharing it ensures that we cannot connect to the domain while a repair action is running and vice versa. It also ensure only one repair runs at a time. This ensures concurrent activity among repair operations does not corrupt state.

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 addContracts(domain: DomainAlias, contracts: Seq[RepairContract], ignoreAlreadyAdded: Boolean, ignoreStakeholderCheck: Boolean, hostedParties: Option[NonEmpty[Set[LfPartyId]]], workflowIdPrefix: Option[String] = None)(implicit traceContext: TraceContext): Either[String, Unit]

    Participant repair utility for manually adding contracts to a domain in an offline fashion.

    Participant repair utility for manually adding contracts to a domain in an offline fashion.

    domain

    alias of domain to add contracts to. The domain needs to be configured, but disconnected to prevent race conditions.

    contracts

    contracts to add. Relevant pieces of each contract: create-arguments (LfContractInst), template-id (LfContractInst), contractId, ledgerCreateTime, salt (to be added to SerializableContract), and witnesses, SerializableContract.metadata is only validated, but otherwise ignored as stakeholder and signatories can be recomputed from contracts.

    ignoreAlreadyAdded

    whether to ignore and skip over contracts already added/present in the domain. Setting this to true (at least on retries) enables writing idempotent repair scripts.

    ignoreStakeholderCheck

    do not check for stakeholder presence for the given parties

    workflowIdPrefix

    If present, each transaction generated for added contracts will have a workflow ID whose prefix is the one set and the suffix is a sequential number and the number of transactions generated as part of the addition (e.g. import-foo-1-2, import-foo-2-2)

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def awaitCleanHeadForTimestamp(domainId: DomainId, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]

    Allows to wait until clean head has progressed up to a certain timestamp

  7. def cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  8. def changeDomain(contractIds: Seq[LfContractId], sourceDomainId: DomainId, targetDomainId: DomainId, skipInactive: Boolean, batchSize: PositiveInt)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]

    Change the association of a contract from one domain to another

    Change the association of a contract from one domain to another

    This function here allows us to manually insert a transfer out / in into the respective journals in order to move a contract from one domain to another. The procedure will result in a consistent state if and only if all the counter parties run the same command. Failure to do so, will results in participants reporting errors and possibly break.

    skipInactive

    if true, then the migration will skip contracts in the contractId list that are inactive

  9. def changeDomainAwait(contractIds: Seq[LfContractId], sourceDomain: DomainAlias, targetDomain: DomainAlias, skipInactive: Boolean, batchSize: PositiveInt)(implicit traceContext: TraceContext): Either[String, Unit]

    Participant repair utility for manually moving contracts from a source domain to a target domain in an offline fashion.

    Participant repair utility for manually moving contracts from a source domain to a target domain in an offline fashion.

    contractIds

    ids of contracts to move that reside in the sourceDomain

    sourceDomain

    alias of source domain from which to move contracts

    targetDomain

    alias of target domain to which to move contracts

    skipInactive

    whether to only move contracts that are active in the source domain

    batchSize

    how big the batches should be used during the migration

  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  11. final def close(): Unit

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Definition Classes
    FlagCloseableOnShutdownRunner → AutoCloseable
  12. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  13. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  14. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  20. def ignoreEvents(domain: DomainId, fromInclusive: SequencerCounter, toInclusive: SequencerCounter, force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
  21. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  22. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunner
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def keepTrackOfOpenFutures: Boolean

    track running futures on shutdown

    track running futures on shutdown

    set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  25. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    RepairServiceNamedLogging
  27. def maxSleepMillis: Long

    How often to poll to check that all tasks have completed.

    How often to poll to check that all tasks have completed.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  28. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  29. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  34. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  35. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    RepairServicePerformUnlessClosing
  36. final def onFirstClose(): Unit

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Definition Classes
    PerformUnlessClosingOnShutdownRunner
    Annotations
    @SuppressWarnings()
  37. def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    PerformUnlessClosing
  38. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
    Definition Classes
    PerformUnlessClosing
  39. def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of etf, because it will result in a deadlock.

    etf

    The task to perform

    Definition Classes
    PerformUnlessClosing
  40. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    PerformUnlessClosing
  41. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  42. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  43. def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.

    Definition Classes
    PerformUnlessClosing
  44. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  45. def purgeContracts(domain: DomainAlias, contractIds: NonEmpty[Seq[LfContractId]], offboardedParties: Option[NonEmpty[Set[LfPartyId]]], ignoreAlreadyPurged: Boolean)(implicit traceContext: TraceContext): Either[String, Unit]

    Participant repair utility for manually purging (archiving) contracts in an offline fashion.

    Participant repair utility for manually purging (archiving) contracts in an offline fashion.

    domain

    alias of domain to purge contracts from. The domain needs to be configured, but disconnected to prevent race conditions.

    contractIds

    lf contract ids of contracts to purge

    ignoreAlreadyPurged

    whether to ignore already purged contracts.

  46. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  47. def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task to run when shutdown is initiated.

    Register a task to run when shutdown is initiated.

    You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".

    Definition Classes
    OnShutdownRunner
  48. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  49. val syncDomainPersistentStateManager: SyncDomainPersistentStateManager
  50. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  51. def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    RepairServiceFlagCloseable
  52. def toString(): String
    Definition Classes
    AnyRef → Any
  53. def unignoreEvents(domain: DomainId, fromInclusive: SequencerCounter, toInclusive: SequencerCounter, force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  56. 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 HasCloseContext

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped