com.digitalasset.canton.domain.topology
DomainTopologyManager
Companion object DomainTopologyManager
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.
- Alphabetic
- By Inheritance
- DomainTopologyManager
- ManagerHooks
- TopologyManager
- FlagCloseableAsync
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- AutoCloseable
- NamedLogging
- TopologyManagerStatus
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DomainTopologyManager(id: DomainTopologyManagerId, clock: Clock, store: TopologyStore[AuthorizedStore], crypto: Crypto, timeouts: ProcessingTimeout, protocolVersion: ProtocolVersion, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor)(implicit ec: ExecutionContext)
Value Members
- 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 add(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean = false, replaceExisting: Boolean = false, allowDuplicateMappings: Boolean = false)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, Unit]
- Definition Classes
- TopologyManager
- def addFromRequest(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, Unit]
- Definition Classes
- DomainTopologyManager → ManagerHooks
- def addObserver(observer: DomainIdentityStateObserver): Unit
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- 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
- 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
- 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
- def checkMappingOfTxDoesNotExistYet(transaction: SignedTopologyTransaction[TopologyChangeOp], allowDuplicateMappings: Boolean)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
- Attributes
- protected
- Definition Classes
- TopologyManager
- def checkNewTransaction(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Unit]
- Attributes
- protected
- Definition Classes
- DomainTopologyManager → TopologyManager
- def checkRemovalRefersToExisingTx(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
- Attributes
- protected
- Definition Classes
- TopologyManager
- def checkTransactionNotAddedBefore(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
- Attributes
- protected
- Definition Classes
- TopologyManager
- val clock: Clock
- Definition Classes
- TopologyManager
- 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 → OnShutdownRunner → AutoCloseable
- 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
- TopologyManager → FlagCloseableAsync
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- def containsShutdownTask(token: Long): Boolean
- Definition Classes
- OnShutdownRunner
- val crypto: Crypto
- Definition Classes
- DomainTopologyManager → TopologyManager
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def genTransaction(op: TopologyChangeOp, mapping: TopologyMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, TopologyTransaction[TopologyChangeOp]]
- Definition Classes
- TopologyManager
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val id: DomainTopologyManagerId
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- 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
performUnlessClosingand friends.- Definition Classes
- OnShutdownRunner
- 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
- def isInitializedET(mustHaveActiveMediator: Boolean)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def issueParticipantStateForDomain(participantId: ParticipantId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DomainTopologyManagerError, Unit]
- Definition Classes
- DomainTopologyManager → ManagerHooks
- 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
- 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
- def keyRevocationIsNotDangerous(owner: KeyOwner, key: PublicKey, elementId: TopologyElementId, force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, TopologyManagerError, Unit]
- Attributes
- protected
- Definition Classes
- TopologyManager
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- TopologyManager → NamedLogging
- 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
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- 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 notifyObservers(timestamp: CantonTimestamp, transactions: Seq[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): Future[Unit]
- Attributes
- protected
- Definition Classes
- DomainTopologyManager → TopologyManager
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- final def onClosed(): Unit
- Definition Classes
- FlagCloseableAsync → PerformUnlessClosing
- 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
- PerformUnlessClosing → OnShutdownRunner
- Annotations
- @SuppressWarnings()
- 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
- PerformUnlessClosing
- 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
- 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
- PerformUnlessClosing
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- 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
- PerformUnlessClosing
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- PerformUnlessClosing
- def preNotifyObservers(transactions: Seq[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): Unit
- Attributes
- protected
- Definition Classes
- DomainTopologyManager → TopologyManager
- 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
- val protocolVersion: ProtocolVersion
- 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 → TopologyManagerStatus
- def removeExistingTransactions(transaction: SignedTopologyTransaction[TopologyChangeOp], replaceExisting: Boolean)(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Seq[SignedTopologyTransaction[TopologyChangeOp]]]
- Attributes
- protected
- Definition Classes
- TopologyManager
- def removeObserver(observer: DomainIdentityStateObserver): Unit
- 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
- 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
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- OnShutdownRunner
- Annotations
- @VisibleForTesting()
- val sequentialQueue: SimpleExecutionQueue
- Attributes
- protected
- Definition Classes
- TopologyManager
- def signedMappingAlreadyExists(mapping: TopologyMapping, signingKey: Fingerprint)(implicit traceContext: TraceContext): Future[Boolean]
- Definition Classes
- TopologyManager
- def signingKeyForTransactionF(transaction: TopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): EitherT[Future, DomainTopologyManagerError, Fingerprint]
- Attributes
- protected
- Definition Classes
- TopologyManager
- val store: TopologyStore[AuthorizedStore]
- Definition Classes
- DomainTopologyManager → TopologyManager
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- DomainTopologyManager → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def transactionIsNotDangerous(transaction: SignedTopologyTransaction[TopologyChangeOp], force: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TopologyManagerError, Unit]
- Attributes
- protected
- Definition Classes
- TopologyManager
- val validator: IncomingTopologyTransactionAuthorizationValidator
- Attributes
- protected
- Definition Classes
- TopologyManager
- 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])
- def wrapError(error: TopologyManagerError)(implicit traceContext: TraceContext): DomainTopologyManagerError
- Attributes
- protected
- Definition Classes
- DomainTopologyManager → TopologyManager