Packages

class DomainTopologyManager extends TopologyManager[DomainTopologyManagerError] with ManagerHooks

Domain manager implementation

The domain manager is the topology manager of a domain. The read side of the domain manager is the identity providing service.

The domain manager is a special local manager but otherwise follows the same logic as a local manager.

The domain manager exposes three main functions for manipulation: - authorize - take an Identity Transaction, sign it with the given private key and add it to the state - add - take a signed Identity Transaction and add it to the given state - set - update the participant state

In order to bootstrap a domain, we need to add appropriate signing keys for the domain identities (topology manager, sequencer, mediator).

In order to add a participant, we need to add appropriate signing and encryption keys. Once they are there, we can set the participant state to enabled.

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

Instance Constructors

  1. new DomainTopologyManager(id: DomainTopologyManagerId, clock: Clock, store: TopologyStore[AuthorizedStore], crypto: Crypto, timeouts: ProcessingTimeout, protocolVersion: ProtocolVersion, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor)(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 add(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean = false, replaceExisting: Boolean = false, allowDuplicateMappings: Boolean = false)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, Unit]
    Definition Classes
    TopologyManager
  5. def addFromRequest(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, Unit]
    Definition Classes
    DomainTopologyManager → ManagerHooks
  6. def addObserver(observer: DomainIdentityStateObserver): Unit
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def authorize[Op <: TopologyChangeOp](transaction: TopologyTransaction[Op], signingKey: Option[Fingerprint], force: Boolean, replaceExisting: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, 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

    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

  9. def authorize[Op <: TopologyChangeOp](transaction: TopologyTransaction[Op], signingKey: Option[Fingerprint], protocolVersion: ProtocolVersion, force: Boolean = false, replaceExisting: Boolean = false)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, 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

    Definition Classes
    TopologyManager
  10. def build[Op <: TopologyChangeOp](transaction: TopologyTransaction[Op], signingKey: Option[Fingerprint], protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, SignedTopologyTransaction[Op]]
    Attributes
    protected
    Definition Classes
    TopologyManager
  11. 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
  12. def checkMappingOfTxDoesNotExistYet(transaction: SignedTopologyTransaction[TopologyChangeOp], allowDuplicateMappings: Boolean)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  13. def checkNewTransaction(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerTopologyManager
  14. def checkRemovalRefersToExisingTx(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  15. def checkTransactionNotAddedBefore(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  16. val clock: Clock
    Definition Classes
    TopologyManager
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  18. 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
  19. 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
  20. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  21. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  22. val crypto: Crypto
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. def genTransaction(op: TopologyChangeOp, mapping: TopologyMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, TopologyTransaction[TopologyChangeOp]]
    Definition Classes
    TopologyManager
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  28. def getKeysForBootstrapping()(implicit traceContext: TraceContext): Future[Map[KeyOwner, Seq[PublicKey]]]

    Return a set of initial keys we can use before the sequenced store has seen any topology transaction

  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  30. val id: DomainTopologyManagerId
  31. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  32. def isAuthorizedStore: Boolean
    Definition Classes
    TopologyManager
  33. 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
  34. def isInitialized(mustHaveActiveMediator: Boolean, logReason: Boolean = true)(implicit traceContext: TraceContext): Future[Boolean]

    Return true if domain identity is sufficiently initialized such that it can be used

  35. def isInitializedET(mustHaveActiveMediator: Boolean)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. def issueParticipantStateForDomain(participantId: ParticipantId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, Unit]
    Definition Classes
    DomainTopologyManager → ManagerHooks
  38. 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
  39. 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
    Definition Classes
    TopologyManager
  40. def keyRevocationIsNotDangerous(owner: KeyOwner, key: PublicKey, elementId: TopologyElementId, force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  41. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  42. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    TopologyManagerNamedLogging
  43. 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
  44. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  49. def notifyObservers(timestamp: CantonTimestamp, transactions: Seq[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): Future[Unit]
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerTopologyManager
  50. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  51. final def onClosed(): Unit
  52. 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()
  53. 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
  54. 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
  55. 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
  56. 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
  57. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  58. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  59. 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
  60. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  61. def preNotifyObservers(transactions: Seq[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): Unit
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerTopologyManager
  62. def process[Op <: TopologyChangeOp](transaction: SignedTopologyTransaction[Op], force: Boolean, replaceExisting: Boolean, allowDuplicateMappings: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, 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
    Definition Classes
    TopologyManager
  63. val protocolVersion: ProtocolVersion
  64. 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
  65. def removeExistingTransactions(transaction: SignedTopologyTransaction[TopologyChangeOp], replaceExisting: Boolean)(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Seq[SignedTopologyTransaction[TopologyChangeOp]]]
    Attributes
    protected
    Definition Classes
    TopologyManager
  66. def removeObserver(observer: DomainIdentityStateObserver): Unit
  67. 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
  68. 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
  69. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  70. val sequentialQueue: SimpleExecutionQueue
    Attributes
    protected
    Definition Classes
    TopologyManager
  71. def signedMappingAlreadyExists(mapping: TopologyMapping, signingKey: Fingerprint)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    TopologyManager
  72. def signingKeyForTransactionF(transaction: TopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Fingerprint]
    Attributes
    protected
    Definition Classes
    TopologyManager
  73. val store: TopologyStore[AuthorizedStore]
  74. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  75. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerFlagCloseable
  76. def toString(): String
    Definition Classes
    AnyRef → Any
  77. def transactionIsNotDangerous(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  78. val validator: IncomingTopologyTransactionAuthorizationValidator
    Attributes
    protected
    Definition Classes
    TopologyManager
  79. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  80. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  81. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  82. def wrapError(error: TopologyManagerError)(implicit traceContext: TraceContext): DomainTopologyManagerError
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerTopologyManager

Deprecated Value Members

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

Inherited from ManagerHooks

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