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. DbTopologyStoreCommon
  5. NamedLogging
  6. TopologyStore
  7. TopologyStoreCommon
  8. FlagCloseable
  9. AutoCloseable
  10. AnyRef
  11. 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: Int = 100)(implicit ec: ExecutionContext)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def allTransactions(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]
    Definition Classes
    DbTopologyStoreTopologyStore
  6. def andIdFilter(previousFilter: SQLActionBuilderChain, idFilter: String, namespaceOnly: Boolean): SQLActionBuilderChain
    Attributes
    protected
    Definition Classes
    DbTopologyStoreCommon
    Annotations
    @SuppressWarnings()
  7. 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
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asOfQuery(asOf: CantonTimestamp, asOfInclusive: Boolean): SQLActionBuilder
    Attributes
    protected
    Definition Classes
    DbTopologyStoreCommon
  10. 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
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  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
    FlagCloseable → AutoCloseable
    Annotations
    @SuppressWarnings()
  13. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  14. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  15. 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
  16. implicit val ec: ExecutionContext
    Definition Classes
    DbTopologyStoreTopologyStoreCommon
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  20. final def exists(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    TopologyStoreCommon
  21. 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
  22. 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
  23. 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
  24. 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
  25. def findPositiveTransactionsForMapping(mapping: TopologyMapping)(implicit traceContext: TraceContext): Future[Seq[SignedTopologyTransaction[Positive]]]
    Definition Classes
    DbTopologyStoreTopologyStore
  26. 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
  27. 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
  28. def findStored(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Option[StoredTopologyTransaction[TopologyChangeOp]]]
    Definition Classes
    DbTopologyStoreTopologyStoreCommon
  29. def findStoredForVersion(transaction: TopologyTransaction[TopologyChangeOp], protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): Future[Option[StoredTopologyTransaction[TopologyChangeOp]]]
    Definition Classes
    DbTopologyStoreTopologyStore
  30. def findStoredNoSignature(transaction: TopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Seq[StoredTopologyTransaction[TopologyChangeOp]]]
    Definition Classes
    DbTopologyStoreTopologyStore
  31. 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
  32. 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
  33. 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
  34. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def getHeadStateQuery(recentTimestampO: Option[CantonTimestamp]): SQLActionBuilderChain
    Attributes
    protected
    Definition Classes
    DbTopologyStoreCommon
  36. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. 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
  38. 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
  39. def inspectKnownParties(timestamp: CantonTimestamp, filterParty: String, filterParticipant: String, limit: Int)(implicit traceContext: TraceContext): Future[Set[PartyId]]
    Definition Classes
    DbTopologyStoreTopologyStore
    Annotations
    @SuppressWarnings()
  40. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  41. def isClosing: Boolean

    Check whether we're closing.

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

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

Inherited from DbStore

Inherited from HasCloseContext

Inherited from DbTopologyStoreCommon[StoreId]

Inherited from NamedLogging

Inherited from TopologyStore[StoreId]

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped