abstract class TopologyManager[E <: CantonError] extends TopologyManagerStatus with NamedLogging with FlagCloseableAsync

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

Instance Constructors

  1. new TopologyManager(clock: Clock, crypto: Crypto, store: TopologyStore[TopologyStoreId], timeouts: ProcessingTimeout, protocolVersion: ProtocolVersion, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor)(implicit ec: ExecutionContext)

Abstract Value Members

  1. abstract def checkNewTransaction(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, E, Unit]
    Attributes
    protected
  2. abstract def notifyObservers(timestamp: CantonTimestamp, transactions: Seq[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): Future[Unit]
    Attributes
    protected
  3. abstract def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    FlagCloseable
  4. abstract def wrapError(error: TopologyManagerError)(implicit traceContext: TraceContext): E
    Attributes
    protected

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 add(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean = false, replaceExisting: Boolean = false, allowDuplicateMappings: Boolean = false)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, Unit]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def authorize[Op <: TopologyChangeOp](transaction: TopologyTransaction[Op], signingKey: Option[Fingerprint], protocolVersion: ProtocolVersion, force: Boolean = false, replaceExisting: Boolean = false)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, SignedTopologyTransaction[Op]]

    Authorizes a new topology transaction by signing it and adding it to the topology state

    Authorizes a new topology transaction by signing it and adding it to the topology state

    transaction

    the transaction to be signed and added

    signingKey

    the key which should be used to sign

    protocolVersion

    the protocol version corresponding to the transaction

    force

    force dangerous operations, such as removing the last signing key of a participant

    replaceExisting

    if true and the transaction op is add, then we'll replace existing active mappings before adding the new

    returns

    the domain state (initialized or not initialized) or an error code of why the addition failed

  7. def build[Op <: TopologyChangeOp](transaction: TopologyTransaction[Op], signingKey: Option[Fingerprint], protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, E, SignedTopologyTransaction[Op]]
    Attributes
    protected
  8. 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
  9. def checkMappingOfTxDoesNotExistYet(transaction: SignedTopologyTransaction[TopologyChangeOp], allowDuplicateMappings: Boolean)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
  10. def checkRemovalRefersToExisingTx(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
  11. def checkTransactionNotAddedBefore(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
  12. val clock: Clock
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  14. 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
  15. def closeAsync(): Seq[AsyncOrSyncCloseable]

    closeAsync asynchronously releases resources held by a future

    closeAsync asynchronously releases resources held by a future

    returns

    an ordered sequence of async and sync closeables with async closeables made up of future and timeout

    Attributes
    protected
    Definition Classes
    TopologyManagerFlagCloseableAsync
  16. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  17. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  18. val crypto: Crypto
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  22. def genTransaction(op: TopologyChangeOp, mapping: TopologyMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, TopologyTransaction[TopologyChangeOp]]
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  26. 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
    OnShutdownRunner
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. 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
  29. def keyRevocationDelegationIsNotDangerous(transaction: SignedTopologyTransaction[TopologyChangeOp], namespace: Namespace, targetKey: SigningPublicKey, force: Boolean, removeFromCache: (SnapshotAuthorizationValidator, StoredTopologyTransactions[TopologyChangeOp]) => EitherT[FutureUnlessShutdown, TopologyManagerError, Unit])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TopologyManagerError, Unit]
    Attributes
    protected
  30. def keyRevocationIsNotDangerous(owner: KeyOwner, key: PublicKey, elementId: TopologyElementId, force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
  31. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    TopologyManagerNamedLogging
  33. 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
  34. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  40. final def onClosed(): Unit
  41. 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()
  42. 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
  43. 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
  44. 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
  45. 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
  46. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  47. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  48. 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
  49. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  50. def preNotifyObservers(transactions: Seq[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): Unit
    Attributes
    protected
  51. def process[Op <: TopologyChangeOp](transaction: SignedTopologyTransaction[Op], force: Boolean, replaceExisting: Boolean, allowDuplicateMappings: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, Unit]

    sequential(!) processing of topology transactions

    sequential(!) processing of topology transactions

    force

    force a dangerous change (such as revoking the last key)

    allowDuplicateMappings

    whether to reject a transaction if a similar transaction leading to the same result already exists

    Attributes
    protected
  52. def queueSize: Int

    returns the current queue size (how many changes are being processed)

    returns the current queue size (how many changes are being processed)

    Definition Classes
    TopologyManagerTopologyManagerStatus
  53. def removeExistingTransactions(transaction: SignedTopologyTransaction[TopologyChangeOp], replaceExisting: Boolean)(implicit traceContext: TraceContext): EitherT[Future, E, Seq[SignedTopologyTransaction[TopologyChangeOp]]]
    Attributes
    protected
  54. 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
  55. 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
  56. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  57. val sequentialQueue: SimpleExecutionQueue
    Attributes
    protected
  58. def signedMappingAlreadyExists(mapping: TopologyMapping, signingKey: Fingerprint)(implicit traceContext: TraceContext): Future[Boolean]
  59. def signingKeyForTransactionF(transaction: TopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, E, Fingerprint]
    Attributes
    protected
  60. val store: TopologyStore[TopologyStoreId]
    Attributes
    protected
  61. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  62. def toString(): String
    Definition Classes
    AnyRef → Any
  63. def transactionIsNotDangerous(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TopologyManagerError, Unit]
    Attributes
    protected
  64. val validator: IncomingTopologyTransactionAuthorizationValidator
    Attributes
    protected
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  67. 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 FlagCloseableAsync

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from TopologyManagerStatus

Inherited from AnyRef

Inherited from Any

Ungrouped