Packages

class DomainNodeBootstrap extends CantonNodeBootstrapBase[Domain, DomainConfig, DomainNodeParameters] with DomainTopologyManagerIdentityInitialization

Startup / Bootstrapping class for domain

The domain startup has three stages: (1) start core services, wait until domainId is initialized (first time) (2) start domain topology manager, wait until essential state is seeded (sequencer, identity and mediator keys are set) (3) start domain entities

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DomainNodeBootstrap
  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 DomainNodeBootstrap(name: InstanceName, config: DomainConfig, testingConfig: TestingConfigInternal, parameters: DomainNodeParameters, clock: Clock, metrics: DomainMetrics, parentLogger: NamedLoggerFactory = NamedLoggerFactory.root, legalIdentityHook: (X509Certificate) => EitherT[Future, String, Unit], addMemberHook: AddMemberHook, sequencerRuntimeFactory: SequencerRuntimeFactory, mediatorFactory: DomainNodeMediatorFactory, storageFactory: StorageFactory, futureSupervisor: FutureSupervisor)(implicit executionContext: ExecutionContextIdlenessExecutorService, 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. val adminApiConfig: AdminServerConfig
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  6. val adminServer: CloseableServer
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  7. val adminServerRegistry: CantonMutableHandlerRegistry
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def authorizeDomainGovernance[E <: CantonError](manager: TopologyManager[E], key: PublicKey, mapping: DomainGovernanceMapping)(implicit traceContext: TraceContext): EitherT[Future, String, SignedTopologyTransaction[Replace]]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  10. def authorizeStateUpdate[E <: CantonError](manager: TopologyManager[E], key: PublicKey, mapping: TopologyStateUpdateMapping)(implicit traceContext: TraceContext): EitherT[Future, String, SignedTopologyTransaction[Add]]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  11. def autoInitializeIdentity(): EitherT[Future, String, Unit]

    Generate an identity for the node.

    Generate an identity for the node.

    Attributes
    protected
    Definition Classes
    DomainNodeBootstrapCantonNodeBootstrapBase
  12. val certificateGenerator: X509CertificateGenerator
    Definition Classes
    CantonNodeBootstrapBase
  13. val clock: Clock
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  15. 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()
  16. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  17. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  18. val config: DomainConfig
  19. def connectionPoolForParticipant: Boolean
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  20. 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
  21. val cryptoConfig: CryptoConfig
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  22. val dbStorageMetrics: DbStorageMetrics
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. implicit val executionContext: ExecutionContextIdlenessExecutorService
    Definition Classes
    CantonNodeBootstrapBase
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. def getId: Option[NodeId]
  28. def getNode: Option[Domain]
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. val indexedStringStore: IndexedStringStore
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  31. val initConfig: InitConfigBase
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  32. val initializationStore: InitializationStore
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  33. 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
    DomainNodeBootstrapCantonNodeBootstrapBase
  34. def initializeIdentityManagerAndServices(nodeId: NodeId): DomainTopologyManager
    Attributes
    protected
    Definition Classes
    DomainNodeBootstrapDomainTopologyManagerIdentityInitialization
  35. def initializeTopologyManagerIdentity(name: InstanceName, legalIdentityHook: (X509Certificate) => EitherT[Future, String, Unit], initialDynamicDomainParameters: DynamicDomainParameters)(implicit traceContext: TraceContext): EitherT[Future, String, (NodeId, DomainTopologyManager, PublicKey)]
  36. 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
  37. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  38. val ips: IdentityProvidingServiceClient
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  39. def isActive: Boolean
  40. 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
  41. def isInitialized: Boolean
  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. def isRunning: Boolean
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  44. 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
  45. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  46. val loggerFactory: NamedLoggerFactory
  47. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  48. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  49. val name: InstanceName
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. def onClosed(): Unit
  55. 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
  56. 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
  57. 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
  58. 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
  59. 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
  60. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  61. 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
  62. def startInstanceUnlessClosing(instanceET: => EitherT[Future, String, Domain]): EitherT[Future, String, Unit]

    kick off initialisation during startup

    kick off initialisation during startup

    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  63. def startTopologyManagementWriteService[E <: CantonError](topologyManager: TopologyManager[E], authorizedStore: TopologyStore): Unit
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  64. def startWithStoredNodeId(id: NodeId): EitherT[Future, String, Unit]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  65. val storage: Storage
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  66. final def storeId(id: NodeId): EitherT[Future, String, Unit]
    Definition Classes
    CantonNodeBootstrapBase
  67. val supportsReplicaInitialization: Boolean

    Can this node be initialized by a replica

    Can this node be initialized by a replica

    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  68. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  69. val timeouts: ProcessingTimeout
  70. def toString(): String
    Definition Classes
    AnyRef → Any
  71. var topologyManager: Option[DomainTopologyManager]
  72. val topologyStoreFactory: TopologyStoreFactory
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  73. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  74. implicit val tracer: Tracer
    Definition Classes
    CantonNodeBootstrapBase
  75. val tracerProvider: TracerProvider
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  76. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  77. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  78. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  79. 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

Inherited from NoTracing

Inherited from HasCloseContext

Inherited from CantonNodeBootstrap[Domain]

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped