Packages

class DomainManagerBootstrap extends CantonNodeBootstrapBase[DomainManagerNode, DomainBaseConfig, DomainManagerNodeParameters] with DomainTopologyManagerIdentityInitialization[StoredDomainMangerNodeSettings]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DomainManagerBootstrap
  2. DomainTopologyManagerIdentityInitialization
  3. CantonNodeBootstrapBase
  4. NoTracing
  5. HasCloseContext
  6. CantonNodeBootstrap
  7. NamedLogging
  8. FlagCloseable
  9. AutoCloseable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DomainManagerBootstrap(name: InstanceName, config: DomainManagerConfig, testingConfig: TestingConfigInternal, parameters: DomainManagerNodeParameters, clock: Clock, metrics: DomainMetrics, parentLogger: NamedLoggerFactory = NamedLoggerFactory.root, storageFactory: StorageFactory, cryptoPrivateStoreFactory: CryptoPrivateStoreFactory, grpcVaultServiceFactory: GrpcVaultServiceFactory, futureSupervisor: FutureSupervisor, writeHealthDumpToFile: HealthDumpFunction, replicaManager: DomainManagerReplicaManager, configuredOpenTelemetry: ConfiguredOpenTelemetry)(implicit executionContext: ExecutionContextIdlenessExecutorService, scheduler: ScheduledExecutorService, actorSystem: ActorSystem)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

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. implicit val actorSystem: ActorSystem
    Definition Classes
    CantonNodeBootstrapBase
  5. def addSequencerConnectionService(managerId: DomainTopologyManagerId, sequencerClient: SequencerClient, transportFactory: SequencerClientTransportFactory): Unit
  6. val adminApiConfig: AdminServerConfig
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  7. val adminServer: CloseableServer
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  8. val adminServerRegistry: CantonMutableHandlerRegistry
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def authorizeDomainGovernance[E <: CantonError](manager: TopologyManager[E], key: SigningPublicKey, mapping: DomainGovernanceMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
    Attributes
    protected
    Definition Classes
    DomainTopologyManagerIdentityInitialization
  11. def authorizeIfNew[E <: CantonError, Op <: TopologyChangeOp](manager: TopologyManager[E], transaction: TopologyTransaction[Op], signingKey: SigningPublicKey, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  12. def authorizeStateUpdate[E <: CantonError](manager: TopologyManager[E], key: SigningPublicKey, mapping: TopologyStateUpdateMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  13. def autoInitializeIdentity(initConfigBase: InitConfigBase): EitherT[Future, String, Unit]

    Generate an identity for the node.

    Generate an identity for the node.

    Attributes
    protected
    Definition Classes
    DomainManagerBootstrapCantonNodeBootstrapBase
  14. val certificateGenerator: X509CertificateGenerator
    Definition Classes
    CantonNodeBootstrapBase
  15. val clock: Clock
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  17. 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()
  18. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  19. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  20. val config: DomainManagerConfig
  21. def connectionPoolForParticipant: Boolean
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  22. val crypto: Crypto

    Access to the private and public store to support local key inspection commands

    Access to the private and public store to support local key inspection commands

    Definition Classes
    CantonNodeBootstrapBaseCantonNodeBootstrap
  23. val cryptoConfig: CryptoConfig
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. implicit val executionContext: ExecutionContextIdlenessExecutorService
    Definition Classes
    CantonNodeBootstrapBase
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def getId: Option[NodeId]
  30. def getNode: Option[DomainManagerNode]
  31. def getOrCreateEncryptionKey(name: String)(implicit traceContext: TraceContext): EitherT[Future, String, EncryptionPublicKey]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  32. def getOrCreateSigningKey(name: String)(implicit traceContext: TraceContext): EitherT[Future, String, SigningPublicKey]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. val indexedStringStore: IndexedStringStore
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  35. val initConfig: InitConfigBase
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  36. val initializationStore: InitializationStore
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  37. def initialize(id: NodeId): EitherT[Future, String, Unit]

    Attempt to start the node with this identity.

    Attempt to start the node with this identity.

    Attributes
    protected
    Definition Classes
    DomainManagerBootstrapCantonNodeBootstrapBase
  38. def initializeIdentityManagerAndServices(nodeId: NodeId, staticDomainParameters: StaticDomainParameters): Either[String, DomainTopologyManager]
  39. def initializeTopologyManagerIdentity(name: InstanceName, initialDynamicDomainParameters: DynamicDomainParameters, initConfigBase: InitConfigBase, staticDomainParametersFromConfig: StaticDomainParameters)(implicit traceContext: TraceContext): EitherT[Future, String, (NodeId, DomainTopologyManager, SigningPublicKey)]
  40. def initializeWithProvidedId(nodeId: NodeId): EitherT[Future, String, Unit]

    Initialize the node with an externally provided identity.

    Initialize the node with an externally provided identity.

    Definition Classes
    CantonNodeBootstrapBaseCantonNodeBootstrap
  41. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  42. val ips: IdentityProvidingServiceClient
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  43. def isActive: Boolean
  44. 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
  45. def isInitialized: Boolean
  46. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  47. def isRunning: Boolean
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  48. 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
  49. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  50. val loggerFactory: NamedLoggerFactory
  51. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  52. val name: InstanceName
  53. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  54. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  55. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  56. lazy val nodeHealthService: ServiceHealth

    Health service component of the node

    Health service component of the node

    Attributes
    protected
    Definition Classes
    DomainManagerBootstrapCantonNodeBootstrapBase
  57. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  58. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  59. def onClosed(): Unit
  60. 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
    FlagCloseable
  61. 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
    FlagCloseable
  62. 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
    FlagCloseable
  63. 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
  64. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  65. 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
    FlagCloseable
  66. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  67. 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
    FlagCloseable
  68. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  69. implicit val scheduler: ScheduledExecutorService
    Definition Classes
    CantonNodeBootstrapBase
  70. def start(): EitherT[Future, String, Unit]

    Attempt to start the node.

    Attempt to start the node. If a previously initialized identifier is available the node will be immediately initialized. If there is no existing identity and autoinit is enabled an identity will be automatically generated and then the node will initialize. If there is no existing identity and autoinit is disabled start will immediately exit to wait for an identity to be externally provided through initializeWithProvidedId.

    Definition Classes
    CantonNodeBootstrapBaseCantonNodeBootstrap
  71. def startInstanceUnlessClosing(instanceET: => EitherT[Future, String, DomainManagerNode]): EitherT[Future, String, Unit]

    kick off initialisation during startup

    kick off initialisation during startup

    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  72. def startTopologyManagementWriteService[E <: CantonError](topologyManager: TopologyManager[E], authorizedStore: TopologyStore[AuthorizedStore]): Unit
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  73. def startWithStoredNodeId(id: NodeId): EitherT[Future, String, Unit]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  74. val storage: Storage
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  75. final def storeId(id: NodeId): EitherT[Future, String, Unit]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  76. val supportsReplicaInitialization: Boolean

    Can this node be initialized by a replica

    Can this node be initialized by a replica

    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  77. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  78. val timeouts: ProcessingTimeout
  79. def toString(): String
    Definition Classes
    AnyRef → Any
  80. def topologyManagerWriteService[E <: CantonError](topologyManager: TopologyManager[E], authorizedStore: TopologyStore[AuthorizedStore]): ServerServiceDefinition
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  81. val topologyStoreFactory: TopologyStoreFactory
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  82. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  83. implicit val tracer: Tracer
    Definition Classes
    CantonNodeBootstrapBase
  84. val tracerProvider: TracerProvider
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  88. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable

Deprecated Value Members

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

Ungrouped