Packages

class DbTopologyStore[StoreId <: TopologyStoreId] extends TopologyStore[StoreId] with DbTopologyStoreCommon[StoreId] with DbStore

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbTopologyStore
  2. DbStore
  3. HasCloseContext
  4. PromiseUnlessShutdownFactory
  5. DbTopologyStoreCommon
  6. NamedLogging
  7. TopologyStore
  8. TopologyStoreCommon
  9. FlagCloseable
  10. PerformUnlessClosing
  11. OnShutdownRunner
  12. AutoCloseable
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbTopologyStore(storage: DbStorage, storeId: StoreId, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor, maxItemsInSqlQuery: PositiveInt = PositiveInt.tryCreate(100))(implicit ec: ExecutionContext)

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 allTransactions(includeRejected: Boolean = false)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]
    Definition Classes
    DbTopologyStoreTopologyStore
  5. def andIdFilter(previousFilter: SQLActionBuilderChain, idFilter: String, namespaceOnly: Boolean): SQLActionBuilderChain
    Attributes
    protected
    Definition Classes
    DbTopologyStoreCommon
    Annotations
    @SuppressWarnings()
  6. def append(sequenced: SequencedTime, effective: EffectiveTime, transactions: Seq[ValidatedTopologyTransaction])(implicit traceContext: TraceContext): Future[Unit]

    add validated topology transaction as is to the topology transaction table

    add validated topology transaction as is to the topology transaction table

    Definition Classes
    DbTopologyStoreTopologyStore
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def asOfQuery(asOf: CantonTimestamp, asOfInclusive: Boolean): SQLActionBuilder
    Attributes
    protected
    Definition Classes
    DbTopologyStoreCommon
  9. def bootstrap(collection: StoredTopologyTransactions[Positive])(implicit traceContext: TraceContext): Future[Unit]

    Bootstrap a node state from a topology transaction collection

    Bootstrap a node state from a topology transaction collection

    Definition Classes
    TopologyStore
  10. 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
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  12. 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
  13. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  14. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  15. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  16. def currentDispatchingWatermark(implicit traceContext: TraceContext): Future[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!

    Definition Classes
    DbTopologyStoreDbTopologyStoreCommonTopologyStoreCommon
  17. implicit val ec: ExecutionContext
    Definition Classes
    DbTopologyStoreTopologyStoreCommon
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. final def exists(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    TopologyStoreCommon
  22. def findDispatchingTransactionsAfter(timestampExclusive: CantonTimestamp, limitO: Option[Int])(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]

    returns transactions that should be dispatched to the domain

    returns transactions that should be dispatched to the domain

    Definition Classes
    DbTopologyStoreTopologyStore
  23. def findInitialState(id: DomainTopologyManagerId)(implicit traceContext: TraceContext): Future[Map[KeyOwner, Seq[PublicKey]]]

    query interface used by DomainTopologyManager to find the set of initial keys

    query interface used by DomainTopologyManager to find the set of initial keys

    Definition Classes
    DbTopologyStoreTopologyStore
  24. def findParticipantOnboardingTransactions(participantId: ParticipantId, domainId: DomainId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[SignedTopologyTransaction[TopologyChangeOp]]]

    returns initial set of onboarding transactions that should be dispatched to the domain

    returns initial set of onboarding transactions that should be dispatched to the domain

    Definition Classes
    DbTopologyStoreTopologyStore
  25. def findPositiveTransactions(asOf: CantonTimestamp, asOfInclusive: Boolean, includeSecondary: Boolean, types: Seq[DomainTopologyTransactionType], filterUid: Option[Seq[UniqueIdentifier]], filterNamespace: Option[Seq[Namespace]])(implicit traceContext: TraceContext): Future[PositiveStoredTopologyTransactions]

    query interface used by com.digitalasset.canton.topology.client.StoreBasedTopologySnapshot

    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.

    includeSecondary

    some topology transactions have an "secondary" uid. currently, this only applies to the party to participant mapping where the secondary uid is the participant uid. we need this information during cascading updates of participant certificates.

    Definition Classes
    DbTopologyStoreTopologyStore
  26. def findPositiveTransactionsForMapping(mapping: TopologyMapping)(implicit traceContext: TraceContext): Future[Seq[SignedTopologyTransaction[Positive]]]
    Definition Classes
    DbTopologyStoreTopologyStore
  27. def findRemovalTransactionForMappings(mappings: Set[TopologyStateElement[TopologyMapping]])(implicit traceContext: TraceContext): Future[Seq[SignedTopologyTransaction[Remove]]]

    finds transactions in the local store that would remove the topology state elements

    finds transactions in the local store that would remove the topology state elements

    Definition Classes
    DbTopologyStoreTopologyStore
  28. def findStateTransactions(asOf: CantonTimestamp, asOfInclusive: Boolean, includeSecondary: Boolean, types: Seq[DomainTopologyTransactionType], filterUid: Option[Seq[UniqueIdentifier]], filterNamespace: Option[Seq[Namespace]])(implicit traceContext: TraceContext): Future[PositiveStoredTopologyTransactions]

    find active topology transactions

    find active topology transactions

    active / state means that for the key authorizing the transaction, there is a connected path to reach the root certificate this function is used for updating and by the lookup client com.digitalasset.canton.topology.client.StoreBasedTopologySnapshot

    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.

    includeSecondary

    some topology transactions have an "secondary" uid. currently, this only applies to the party to participant mapping where the secondary uid is the participant uid. we need this information during cascading updates of participant certificates.

    Definition Classes
    DbTopologyStoreTopologyStore
  29. def findStored(transaction: SignedTopologyTransaction[TopologyChangeOp], includeRejected: Boolean = false)(implicit traceContext: TraceContext): Future[Option[StoredTopologyTransaction[TopologyChangeOp]]]
    Definition Classes
    DbTopologyStoreTopologyStoreCommon
  30. def findStoredForVersion(transaction: TopologyTransaction[TopologyChangeOp], protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): Future[Option[StoredTopologyTransaction[TopologyChangeOp]]]
    Definition Classes
    DbTopologyStoreTopologyStore
  31. def findStoredNoSignature(transaction: TopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Seq[StoredTopologyTransaction[TopologyChangeOp]]]
    Definition Classes
    DbTopologyStoreTopologyStore
  32. def findTransactionsInRange(asOfExclusive: CantonTimestamp, upToExclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]

    Returns an ordered list of transactions from the transaction store within a certain range

    Returns an ordered list of transactions from the transaction store within a certain range

    Definition Classes
    DbTopologyStoreTopologyStore
  33. def findTsOfParticipantStateChangesBefore(beforeExclusive: CantonTimestamp, participantId: ParticipantId, limit: Int)(implicit traceContext: TraceContext): Future[Seq[CantonTimestamp]]

    returns an descending ordered list of timestamps of when participant state changes occurred before a certain point in time

    returns an descending ordered list of timestamps of when participant state changes occurred before a certain point in time

    Definition Classes
    DbTopologyStoreTopologyStore
  34. def findUpcomingEffectiveChanges(asOfInclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[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

    Definition Classes
    DbTopologyStoreTopologyStoreCommon
  35. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  36. def getHeadStateQuery(recentTimestampO: Option[CantonTimestamp]): SQLActionBuilderChain
    Attributes
    protected
    Definition Classes
    DbTopologyStoreCommon
  37. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  38. def headTransactions(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[Positive]]

    set of topology transactions which are active

    set of topology transactions which are active

    Definition Classes
    DbTopologyStoreTopologyStore
  39. def inspect(stateStore: Boolean, timeQuery: TimeQuery, recentTimestampO: Option[CantonTimestamp], ops: Option[TopologyChangeOp], typ: Option[DomainTopologyTransactionType], idFilter: String, namespaceOnly: Boolean)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]

    query optimized for inspection

    query optimized for inspection

    recentTimestampO

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

    Definition Classes
    DbTopologyStoreTopologyStore
  40. def inspectKnownParties(timestamp: CantonTimestamp, filterParty: String, filterParticipant: String, limit: Int)(implicit traceContext: TraceContext): Future[Set[PartyId]]
    Definition Classes
    DbTopologyStoreTopologyStore
    Annotations
    @SuppressWarnings()
  41. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  42. 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
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. 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
  45. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  46. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbTopologyStoreNamedLogging
  47. val maxItemsInSqlQuery: PositiveInt
    Attributes
    protected
    Definition Classes
    DbTopologyStoreDbTopologyStoreCommon
  48. 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
  49. def maxTimestamp()(implicit traceContext: TraceContext): Future[Option[(SequencedTime, EffectiveTime)]]
    Definition Classes
    TopologyStoreTopologyStoreCommon
  50. 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
  51. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  52. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  54. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  56. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  57. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  58. 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()
  59. 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
  60. 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
  61. 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
  62. 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
  63. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  64. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  65. 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
  66. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  67. def providesAdditionalSignatures(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    TopologyStoreTopologyStoreCommon
  68. val readTime: TimedLoadGauge
    Attributes
    protected
    Definition Classes
    DbTopologyStoreDbTopologyStoreCommon
  69. 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
  70. 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
  71. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  72. def signedTxFromStoredTx(storedTx: StoredTopologyTransaction[TopologyChangeOp]): SignedTopologyTransaction[TopologyChangeOp]
    Attributes
    protected
    Definition Classes
    TopologyStoreTopologyStoreCommon
  73. val stateStoreIdFilterName: LengthLimitedString
    Attributes
    protected
  74. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbTopologyStoreDbStore
  75. val storeId: StoreId
    Definition Classes
    DbTopologyStoreTopologyStoreCommon
  76. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  77. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbTopologyStoreFlagCloseable
  78. def timestamp(useStateStore: Boolean)(implicit traceContext: TraceContext): Future[Option[(SequencedTime, EffectiveTime)]]
    Definition Classes
    DbTopologyStoreTopologyStore
  79. def toString(): String
    Definition Classes
    AnyRef → Any
  80. val transactionStoreIdName: LengthLimitedString
    Attributes
    protected
    Definition Classes
    DbTopologyStoreDbTopologyStoreCommon
  81. def updateDispatchingWatermark(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    update the dispatching watermark for this target store

    update the dispatching watermark for this target store

    Definition Classes
    DbTopologyStoreDbTopologyStoreCommonTopologyStoreCommon
  82. def updateState(sequenced: SequencedTime, effective: EffectiveTime, deactivate: Seq[UniquePath], positive: Seq[SignedTopologyTransaction[Positive]])(implicit traceContext: TraceContext): Future[Unit]

    update active topology transaction to the active topology transaction table

    update active topology transaction to the active topology transaction table

    active means that for the key authorizing the transaction, there is a connected path to reach the root certificate

    Definition Classes
    DbTopologyStoreTopologyStore
  83. val updatingTime: TimedLoadGauge
    Attributes
    protected
    Definition Classes
    DbTopologyStoreDbTopologyStoreCommon
  84. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  85. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  86. 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 DbStore

Inherited from HasCloseContext

Inherited from DbTopologyStoreCommon[StoreId]

Inherited from NamedLogging

Inherited from TopologyStore[StoreId]

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped