c

com.digitalasset.canton.environment

CantonNodeBootstrapBase

abstract class CantonNodeBootstrapBase[T <: CantonNode, NodeConfig <: LocalNodeConfig, ParameterConfig <: CantonNodeParameters, Metrics <: BaseMetrics] extends CantonNodeBootstrap[T] with HasCloseContext with NoTracing

Bootstrapping class used to drive the initialization of a canton node (domain and participant)

(wait for unique id) -> receive initId -> notify actual implementation via idInitialized

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

Instance Constructors

  1. new CantonNodeBootstrapBase(arguments: CantonNodeBootstrapCommonArguments[NodeConfig, ParameterConfig, Metrics])(implicit executionContext: ExecutionContextIdlenessExecutorService, scheduler: ScheduledExecutorService, actorSystem: ActorSystem)

Type Members

  1. class InitializationWatcher extends FlagCloseable with NamedLogging
    Attributes
    protected

Abstract Value Members

  1. abstract def autoInitializeIdentity(initConfigBase: InitConfigBase): EitherT[FutureUnlessShutdown, String, Unit]

    Generate an identity for the node.

    Generate an identity for the node.

    Attributes
    protected
  2. abstract def initialize(uid: NodeId): EitherT[FutureUnlessShutdown, String, Unit]

    Attempt to start the node with this identity.

    Attempt to start the node with this identity.

    Attributes
    protected
  3. abstract def mkNodeHealthService(storage: Storage): (DependenciesHealthService, LivenessHealthService)
    Attributes
    protected
  4. abstract def sequencedTopologyStores: Seq[TopologyStore[TopologyStoreId]]

    All existing domain stores

    All existing domain stores

    Attributes
    protected

Concrete 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
  5. val adminApiConfig: AdminServerConfig
    Attributes
    protected
  6. val adminServer: CloseableServer
    Attributes
    protected
  7. val adminServerRegistry: CantonMutableHandlerRegistry
    Attributes
    protected
  8. val arguments: CantonNodeBootstrapCommonArguments[NodeConfig, ParameterConfig, Metrics]
    Attributes
    protected
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def authorizeIfNew[E <: CantonError, Op <: TopologyChangeOp](manager: TopologyManager[E], transaction: TopologyTransaction[Op], signingKey: SigningPublicKey, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
    Attributes
    protected
  11. def authorizeStateUpdate[E <: CantonError](manager: TopologyManager[E], key: SigningPublicKey, mapping: TopologyStateUpdateMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
    Attributes
    protected
  12. val authorizedTopologyStore: TopologyStore[AuthorizedStore.type]
    Attributes
    protected
  13. 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
  14. def clock: Clock
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  16. 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
  17. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  18. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  19. def config: NodeConfig
  20. def connectionPoolForParticipant: Boolean
    Attributes
    protected
  21. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  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
  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
  28. def futureSupervisor: FutureSupervisor
    Attributes
    protected
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  30. def getId: Option[NodeId]
  31. def getNode: Option[T]
  32. val grpcHealthServer: Option[GrpcHealthServer]
    Attributes
    protected
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  34. val healthReporter: GrpcHealthReporter
    Attributes
    protected
  35. val indexedStringStore: IndexedStringStore
    Attributes
    protected
  36. val initConfig: InitConfigBase
    Attributes
    protected
  37. val initQueue: SimpleExecutionQueue
    Attributes
    protected
  38. val initializationStore: InitializationStore
    Attributes
    protected
  39. def initializeWithProvidedId(nodeId: NodeId): EitherT[Future, String, Unit]

    Initialize the node with an externally provided identity.

  40. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  41. val ips: IdentityProvidingServiceClient
    Attributes
    protected
  42. def isActive: Boolean
  43. 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
  44. def isInitialized: Boolean
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. def isRunning: Boolean
    Attributes
    protected
  47. def isWaitingForId: Boolean
  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
    PerformUnlessClosing
  49. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  50. def loggerFactory: NamedLoggerFactory
  51. 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
  52. def mkHealthComponents(nodeHealthService: HealthService, nodeLivenessService: LivenessHealthService): (GrpcHealthReporter, Option[GrpcHealthServer])
    Attributes
    protected
  53. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  54. def name: InstanceName
  55. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  56. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  58. lazy val nodeHealthService: DependenciesHealthService

    Health service component of the node

    Health service component of the node

    Attributes
    protected
  59. lazy val nodeLivenessService: LivenessHealthService

    Health service component of the node

    Health service component of the node

    Attributes
    protected
  60. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  62. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  63. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBasePerformUnlessClosing
  64. 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()
  65. def parameterConfig: ParameterConfig
  66. def parameters: ParameterConfig
  67. 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
  68. 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
  69. 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
  70. 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
  71. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  72. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  73. 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
  74. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  75. def registerHealthGauge(): Unit
    Attributes
    protected
  76. 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
  77. 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
  78. def runOnSkippedInitialization: EitherT[Future, String, Unit]

    When a node is not initialized and auto-init is false, we skip initialization.

    When a node is not initialized and auto-init is false, we skip initialization. This can be overridden to give a chance to a node to still perform some operation after it has been started but not yet initialized.

  79. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  80. implicit val scheduler: ScheduledExecutorService
  81. 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
  82. def startInstanceUnlessClosing(instanceET: => EitherT[FutureUnlessShutdown, String, T]): EitherT[FutureUnlessShutdown, String, Unit]

    kick off initialisation during startup

    kick off initialisation during startup

    Attributes
    protected
  83. def startTopologyManagementWriteService[E <: CantonError](topologyManager: TopologyManager[E]): Unit
    Attributes
    protected
  84. def startWithStoredNodeId(id: NodeId): EitherT[FutureUnlessShutdown, String, Unit]
    Attributes
    protected
  85. val storage: Storage
    Attributes
    protected
  86. final def storeId(id: NodeId): EitherT[Future, String, Unit]
    Attributes
    protected
  87. def supportsReplicaInitialization: Boolean

    Can this node be initialized by a replica

    Can this node be initialized by a replica

    Attributes
    protected
  88. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  89. def timeouts: ProcessingTimeout
  90. def toString(): String
    Definition Classes
    AnyRef → Any
  91. def topologyManagerWriteService[E <: CantonError](topologyManager: TopologyManager[E]): ServerServiceDefinition
    Attributes
    protected
  92. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  93. implicit val tracer: Tracer
    Attributes
    protected
  94. val tracerProvider: TracerProvider
    Attributes
    protected
  95. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  96. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  97. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from NoTracing

Inherited from HasCloseContext

Inherited from CantonNodeBootstrap[T]

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped