class DbTopologyStore extends TopologyStore with DbStore
- Alphabetic
- By Inheritance
- DbTopologyStore
- DbStore
- HasCloseContext
- NamedLogging
- FlagCloseable
- TopologyStore
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DbTopologyStore(storage: DbStorage, storeId: TopologyStoreId, maxItemsInSqlQuery: Int, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)
Type Members
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
Value Members
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def allTransactions(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]
- Definition Classes
- DbTopologyStore → TopologyStore
- def append(timestamp: CantonTimestamp, 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
- TopologyStore
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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()
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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
- DbTopologyStore → TopologyStore
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def exists(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Boolean]
- Definition Classes
- DbTopologyStore → TopologyStore
- def findActiveTransactionsForMapping(mapping: TopologyMapping)(implicit traceContext: TraceContext): Future[Seq[SignedTopologyTransaction[Add]]]
- Definition Classes
- DbTopologyStore → TopologyStore
- 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
- DbTopologyStore → TopologyStore
- def findEffectiveTimestampsSince(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Seq[CantonTimestamp]]
fetch the effective time updates greater than a certain timestamp
fetch the effective time updates greater than 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
- DbTopologyStore → TopologyStore
- def findInitialState(uid: UniqueIdentifier)(implicit traceContext: TraceContext): Future[Map[KeyOwner, Seq[PublicKey]]]
query interface used by DomainIdentityManager to find the set of initial keys
query interface used by DomainIdentityManager to find the set of initial keys
- Definition Classes
- DbTopologyStore → TopologyStore
- def findParticipantOnboardingTransactions(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[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
- DbTopologyStore → TopologyStore
- 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
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
- DbTopologyStore → TopologyStore
- 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
- DbTopologyStore → TopologyStore
- 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
- DbTopologyStore → TopologyStore
- 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
- DbTopologyStore → TopologyStore
- 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
- DbTopologyStore → TopologyStore
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def headTransactions(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[Positive]]
set of topology transactions which are active
set of topology transactions which are active
- Definition Classes
- DbTopologyStore → TopologyStore
- 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
- DbTopologyStore → TopologyStore
- def inspectKnownParties(timestamp: CantonTimestamp, filterParty: String, filterParticipant: String, limit: Int)(implicit traceContext: TraceContext): Future[Set[PartyId]]
- Definition Classes
- DbTopologyStore → TopologyStore
- Annotations
- @SuppressWarnings()
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- DbTopologyStore → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def monotonicityTimeCheckUpdate(ts: CantonTimestamp): Option[CantonTimestamp]
- Attributes
- protected
- Definition Classes
- TopologyStore
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onClosed(): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
- 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
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, 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.closeas part ofetf, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- FlagCloseable
- 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
- def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
- Definition Classes
- FlagCloseable
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- val storage: DbStorage
- Attributes
- protected
- Definition Classes
- DbTopologyStore → DbStore
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- DbTopologyStore → FlagCloseable
- def timestamp(useStateStore: Boolean)(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]
- Definition Classes
- DbTopologyStore → TopologyStore
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
- DbTopologyStore → TopologyStore
- def updateState(timestamp: CantonTimestamp, 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
- DbTopologyStore → TopologyStore
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])