abstract class TopologyStore[+StoreID <: TopologyStoreId] extends FlagCloseable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopologyStore
  2. FlagCloseable
  3. PerformUnlessClosing
  4. HasSynchronizeWithReaders
  5. HasSynchronizeWithClosing
  6. OnShutdownRunner
  7. HasRunOnClosing
  8. HasUnlessClosing
  9. AutoCloseable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TopologyStore()(implicit ec: ExecutionContext)

Abstract Value Members

  1. abstract def currentDispatchingWatermark(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[CantonTimestamp]]

    returns the current dispatching watermark

    returns the current dispatching watermark

    for topology transaction dispatching, we keep track up to which point in time we have mirrored the authorized store to the remote store

    the timestamp always refers to the timestamp of the authorized store!

  2. abstract def deleteAllData()(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
  3. abstract def doFindCurrentAndUpcomingChangeDelays(sequencedTime: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[Iterable[GenericStoredTopologyTransaction]]

    Implementation specific parts of findCurrentAndUpcomingChangeDelays.

    Implementation specific parts of findCurrentAndUpcomingChangeDelays. Implementations must filter by validFrom, validUntil, sequenced, isProposal, and rejected. Implementations may or may not apply further filters. Implementations should not spend resources for sorting.

    Attributes
    protected
  4. abstract def dumpStoreContent()(implicit traceContext: TraceContext): FutureUnlessShutdown[GenericStoredTopologyTransactions]
    Attributes
    protected[topology]
    Annotations
    @VisibleForTesting()
  5. abstract def findDispatchingTransactionsAfter(timestampExclusive: CantonTimestamp, limit: Option[Int])(implicit traceContext: TraceContext): FutureUnlessShutdown[GenericStoredTopologyTransactions]

    Yields transactions with validFrom strictly greater than timestampExclusive.

    Yields transactions with validFrom strictly greater than timestampExclusive. Excludes rejected transactions and expired proposals.

  6. abstract def findEffectiveStateChanges(fromEffectiveInclusive: CantonTimestamp, filterTypes: Option[Seq[Code]] = None, onlyAtEffective: Boolean)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[EffectiveStateChange]]

    Find all effective-time state changes.

    Find all effective-time state changes. One EffectiveStateChange contains all positive transactions which have valid_from == fromEffectiveInclusive for the new state, and all positive transactions which have valid_until == fromEffectiveInclusive for the old/previous, but none of those transactions which meet both criteria (transient topology changes). This query does not return proposals, rejected transactions or removals.

    fromEffectiveInclusive

    If onlyAtEffective is true, look up state change for a single effective time, which should produce at most one result per mapping unique key. If onlyAtEffective is false, this defines the inclusive lower bound for effective time: lookup up all state changes for all effective times bigger than or equal to this.

    filterTypes

    If defined, restrict the query to specific mappings.

    onlyAtEffective

    Controls whether fromEffectiveInclusive defines a single effective time, or an inclusive lower bound for the query.

    returns

    A sequence of EffectiveStateChange. Neither the sequence, nor the before/after fields in the results are ordered.

  7. abstract def findEssentialStateAtSequencedTime(asOfInclusive: SequencedTime, includeRejected: Boolean)(implicit traceContext: TraceContext): FutureUnlessShutdown[GenericStoredTopologyTransactions]

    Yields all transactions with sequenced time less than or equal to asOfInclusive.

    Yields all transactions with sequenced time less than or equal to asOfInclusive. Sets validUntil to None, if validUntil is strictly greater than the maximum value of validFrom.

  8. abstract def findExpiredChangeDelays(validUntilMinInclusive: CantonTimestamp, validUntilMaxExclusive: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[TopologyDelay]]

    Yields all topologyChangeDelays that have expired within a given time period.

    Yields all topologyChangeDelays that have expired within a given time period. Does not yield any proposals or rejections.

  9. abstract def findFirstMediatorStateForMediator(mediatorId: MediatorId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[StoredTopologyTransaction[Replace, MediatorSynchronizerState]]]

    Finds the topology transaction that first onboarded the mediator with ID mediatorId

  10. abstract def findFirstSequencerStateForSequencer(sequencerId: SequencerId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[StoredTopologyTransaction[Replace, SequencerSynchronizerState]]]

    Finds the topology transaction that first onboarded the sequencer with ID sequencerId

  11. abstract def findFirstTrustCertificateForParticipant(participant: ParticipantId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[StoredTopologyTransaction[Replace, SynchronizerTrustCertificate]]]

    Finds the topology transaction that first onboarded the participant with ID participantId

  12. abstract def findLatestTransactionsAndProposalsByTxHash(hashes: Set[TxHash])(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[GenericSignedTopologyTransaction]]
  13. abstract def findParticipantOnboardingTransactions(participantId: ParticipantId, synchronizerId: SynchronizerId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[GenericSignedTopologyTransaction]]

    Returns initial set of onboarding transactions that should be dispatched to the synchronizer.

    Returns initial set of onboarding transactions that should be dispatched to the synchronizer. Includes:

    • SynchronizerTrustCertificates for the given participantId
    • OwnerToKeyMappings for the given participantId
    • NamespaceDelegations for the participantId's namespace
    • The above even if they are expired.
    • Transactions with operation REMOVE. Excludes:
    • Proposals
    • Rejected transactions
    • Transactions that are not valid for synchronizerId
  14. abstract def findPositiveTransactions(asOf: CantonTimestamp, asOfInclusive: Boolean, isProposal: Boolean, types: Seq[Code], filterUid: Option[NonEmpty[Seq[UniqueIdentifier]]], filterNamespace: Option[NonEmpty[Seq[Namespace]]])(implicit traceContext: TraceContext): FutureUnlessShutdown[PositiveStoredTopologyTransactions]

    returns the set of positive transactions

    returns the set of positive transactions

    this function is used by the topology processor to determine the set of transaction, such that we can perform cascading updates if there was a certificate revocation

    asOfInclusive

    whether the search interval should include the current timepoint or not. the state at t is defined as "exclusive" of t, whereas for updating the state, we need to be able to query inclusive.

  15. abstract def findProposalsByTxHash(asOfExclusive: EffectiveTime, hashes: NonEmpty[Set[TxHash]])(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[GenericSignedTopologyTransaction]]
  16. abstract def findStored(asOfExclusive: CantonTimestamp, transaction: GenericSignedTopologyTransaction, includeRejected: Boolean = false)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[GenericStoredTopologyTransaction]]

    Finds the last (i.e.

    Finds the last (i.e. highest id) stored transaction with validFrom strictly before asOfExclusive that has the same hash as transaction.

  17. abstract def findStoredForVersion(asOfExclusive: CantonTimestamp, transaction: GenericTopologyTransaction, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[GenericStoredTopologyTransaction]]

    Finds the last (i.e.

    Finds the last (i.e. highest id) stored transaction with validFrom strictly before asOfExclusive that has the same hash as transaction and the representative protocol version for the given protocolVersion. Excludes rejected transactions.

  18. abstract def findTransactionsForMapping(asOfExclusive: EffectiveTime, hashes: NonEmpty[Set[MappingHash]])(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[GenericSignedTopologyTransaction]]
  19. abstract def findUpcomingEffectiveChanges(asOfInclusive: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[Change]]

    fetch the effective time updates greater than or equal to a certain timestamp

    fetch the effective time updates greater than or equal to a certain timestamp

    this function is used to recover the future effective timestamp such that we can reschedule "pokes" of the topology client and updates of the acs commitment processor on startup

  20. abstract def inspect(proposals: Boolean, timeQuery: TimeQuery, asOfExclusiveO: Option[CantonTimestamp], op: Option[TopologyChangeOp], types: Seq[Code], idFilter: Option[String], namespaceFilter: Option[String])(implicit traceContext: TraceContext): FutureUnlessShutdown[StoredTopologyTransactions[TopologyChangeOp, TopologyMapping]]

    query optimized for inspection

    query optimized for inspection

    proposals

    if true, query only for proposals instead of approved transaction mappings

    asOfExclusiveO

    if exists, use this timestamp for the head state to prevent race conditions on the console

  21. abstract def inspectKnownParties(asOfExclusive: CantonTimestamp, filterParty: String, filterParticipant: String)(implicit traceContext: TraceContext): FutureUnlessShutdown[Set[PartyId]]
  22. abstract def logger: TracedLogger
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  23. abstract def maxTimestamp(sequencedTime: SequencedTime, includeRejected: Boolean)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[(SequencedTime, EffectiveTime)]]

    Finds the transaction with maximum effective time that has been sequenced at or before sequencedTime and yields the sequenced / effective time of that transaction.

    Finds the transaction with maximum effective time that has been sequenced at or before sequencedTime and yields the sequenced / effective time of that transaction.

    includeRejected

    whether to include rejected transactions

  24. abstract def storeId: StoreID
  25. abstract def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    FlagCloseable
  26. abstract def update(sequenced: SequencedTime, effective: EffectiveTime, removeMapping: Map[MappingHash, PositiveInt], removeTxs: Set[TxHash], additions: Seq[GenericValidatedTopologyTransaction])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    Updates topology transactions.

    Updates topology transactions. The method proceeds as follows:

    1. It expires all transactions tx with removeMapping.get(tx.mapping.uniqueKey).exists(tx.serial <= _). By expire we mean that valid_until is set to effective, provided valid_until was previously NULL and valid_from < effective. 2. It expires all transactions tx with tx.hash in removeTxs. 3. It adds all transactions in additions. Thereby: 3.1. It sets valid_until to effective, if there is a rejection reason or if expireImmediately.
  27. abstract def updateDispatchingWatermark(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    update the dispatching watermark for this target store

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 addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. 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
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  9. def currentChangeDelay(asOfExclusive: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[TopologyDelay]

    Yields the topologyChangeDelay valid at a given time or, if there is none in the store, the initial default value.

  10. implicit val ec: ExecutionContext
    Attributes
    protected
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def findCurrentAndUpcomingChangeDelays(sequencedTime: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[NonEmpty[List[TopologyDelay]]]

    Yields the currently valid and all upcoming topology change delays.

    Yields the currently valid and all upcoming topology change delays. Namely:

    • The change delay with validFrom < sequencedTime and validUntil.forall(_ >= sequencedTime), or the initial default value, if no such change delay exists.
    • All change delays with validFrom >= sequencedTime and sequenced < sequencedTime. Excludes:
    • Proposals
    • Rejected transactions
    • Transactions with validUntil.contains(validFrom)

    The result is sorted descending by validFrom. So the current change delay comes last.

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. 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
    OnShutdownRunnerHasUnlessClosing
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def keepTrackOfReaderCallStack: Boolean

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  19. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  24. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  25. 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
  26. def providesAdditionalSignatures(transaction: GenericSignedTopologyTransaction)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]

    Checks whether the given signed topology transaction has signatures (at this point still unvalidated) from signing keys, for which there aren't yet signatures in the store.

  27. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  28. def removeReader(handle: ReaderHandle): Unit

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  29. def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]

    Schedules the given task to be run upon closing.

    Schedules the given task to be run upon closing.

    returns

    An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the LifeCycleManager's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.

    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  30. def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the LifeCycleManager's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  31. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  32. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  33. def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  34. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  35. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  36. def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has finished or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  37. def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  38. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]

    Runs the computation fa unless isClosing returns true.

    Runs the computation fa unless isClosing returns true.

    This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

    returns

    The result of fa or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true

    Definition Classes
    HasUnlessClosing
    Annotations
    @inline()
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

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

    (Since version 9)

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped