class DomainTopologyManager extends TopologyManager[DomainTopologyManagerError]

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. TopologyManager
  3. FlagCloseableAsync
  4. FlagCloseable
  5. AutoCloseable
  6. NamedLogging
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DomainTopologyManager(id: UniqueIdentifier, clock: Clock, store: TopologyStore, addParticipantHook: AddMemberHook, crypto: Crypto, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(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[Future, DomainTopologyManagerError, Unit]
    Definition Classes
    TopologyManager
  5. def addObserver(observer: DomainIdentityStateObserver): Unit
  6. def addParticipant(participantId: ParticipantId, x509: Option[X509Cert]): EitherT[Future, DomainTopologyManagerError, Unit]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def authorize[Op <: TopologyChangeOp](transaction: TopologyTransaction[Op], signingKey: Option[Fingerprint], force: Boolean = false, replaceExisting: Boolean = false)(implicit traceContext: TraceContext): EitherT[Future, 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

    Definition Classes
    TopologyManager
  9. def build[Op <: TopologyChangeOp](transaction: TopologyTransaction[Op], signingKey: Option[Fingerprint])(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, SignedTopologyTransaction[Op]]
    Attributes
    protected
    Definition Classes
    TopologyManager
  10. def checkMappingDoesNotExistYet(transaction: SignedTopologyTransaction[TopologyChangeOp], allowDuplicateMappings: Boolean)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  11. def checkNewTransaction(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerTopologyManager
  12. def checkNotAddingToWrongDomain(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Unit]
    Attributes
    protected
  13. def checkNotEnablingParticipantWithoutKeys(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Unit]
    Attributes
    protected
  14. def checkRemovalRefersToExisingTx(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  15. def checkTransactionIsNotForAlienDomainEntities(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Unit]
    Attributes
    protected
  16. def checkTransactionNotAddedBefore(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  17. val clock: Clock
    Definition Classes
    TopologyManager
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  19. 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()
  20. 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
  21. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  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. def executeSequential(fut: => Future[Unit], description: String): Future[Unit]
  26. def generate(claim: LegalIdentityClaim)(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, SignedLegalIdentityClaim]

    Generates a signed legal identity claim of the given claim

    Generates a signed legal identity claim of the given claim

    Definition Classes
    TopologyManager
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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() @HotSpotIntrinsicCandidate()
  30. val id: UniqueIdentifier
  31. def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  32. 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
  33. def isInitialized(implicit traceContext: TraceContext): Future[Boolean]

    Return true if domain identity is sufficiently initialized

    Return true if domain identity is sufficiently initialized

    The state is sufficiently initialized if it contains the domain entities signing keys.

  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. 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
  36. def keyRevocationIsNotDangerous(owner: KeyOwner, key: PublicKey, elementId: TopologyElementId, force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  37. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  38. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    TopologyManagerNamedLogging
  39. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  40. val managerId: DomainTopologyManagerId
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  45. def notifyObservers(timestamp: CantonTimestamp, transactions: Seq[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): Future[Unit]
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerTopologyManager
  46. final def onClosed(): Unit
    Definition Classes
    FlagCloseableAsyncFlagCloseable
  47. def performUnlessClosing[A](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.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    FlagCloseable
  48. def performUnlessClosingEitherT[E, R](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.

    etf

    The task to perform

    Definition Classes
    FlagCloseable
  49. def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    FlagCloseable
  50. def performUnlessClosingF[A](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.

    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
  51. def preNotifyObservers(transactions: Seq[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): Unit
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerTopologyManager
  52. def process[Op <: TopologyChangeOp](transaction: SignedTopologyTransaction[Op], force: Boolean, replaceExisting: Boolean, allowDuplicateMappings: Boolean)(implicit traceContext: TraceContext): EitherT[Future, 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
  53. 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
    TopologyManager
  54. def removeExistingTransactions(transaction: SignedTopologyTransaction[TopologyChangeOp], replaceExisting: Boolean)(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Seq[SignedTopologyTransaction[TopologyChangeOp]]]
    Attributes
    protected
    Definition Classes
    TopologyManager
  55. 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
  56. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  57. val sequentialQueue: SimpleExecutionQueue
    Attributes
    protected
    Definition Classes
    TopologyManager
  58. def signingKeyForTransactionF(transaction: TopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Fingerprint]
    Attributes
    protected
    Definition Classes
    TopologyManager
  59. def sleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  60. val store: TopologyStore
  61. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  62. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerFlagCloseable
  63. def toString(): String
    Definition Classes
    AnyRef → Any
  64. def transactionIsNotDangerous(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
    Attributes
    protected
    Definition Classes
    TopologyManager
  65. val validator: IncomingTopologyTransactionAuthorizationValidator
    Attributes
    protected
    Definition Classes
    TopologyManager
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. 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

Inherited from FlagCloseableAsync

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped