c

com.digitalasset.canton.environment

CantonNodeBootstrapBase

abstract class CantonNodeBootstrapBase[T <: CantonNode, NodeConfig <: LocalNodeConfig, ParameterConfig <: CantonNodeParameters] 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. CantonNodeBootstrap
  5. NamedLogging
  6. FlagCloseable
  7. AutoCloseable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CantonNodeBootstrapBase(name: InstanceName, config: NodeConfig, parameterConfig: ParameterConfig, clock: Clock, metricsPrefix: MetricName, metricsFactory: MetricsFactory, dbStorageMetrics: DbStorageMetrics, storageFactory: StorageFactory, cryptoPrivateStoreFactory: CryptoPrivateStoreFactory, grpcVaultServiceFactory: GrpcVaultServiceFactory, loggerFactory: NamedLoggerFactory, writeHealthDumpToFile: HealthDumpFunction, grpcMetrics: GrpcServerMetrics, configuredOpenTelemetry: ConfiguredOpenTelemetry, healthMetrics: HealthMetrics)(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

Abstract Value Members

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

    Generate an identity for the node.

    Generate an identity for the node.

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

    Attempt to start the node with this identity.

    Attempt to start the node with this identity.

    Attributes
    protected
  3. abstract def isActive: Boolean
    Definition Classes
    CantonNodeBootstrap
  4. abstract def nodeHealthService: ServiceHealth

    Health service component of the node

    Health service component of the node

    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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. 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
  10. def authorizeStateUpdate[E <: CantonError](manager: TopologyManager[E], key: SigningPublicKey, mapping: TopologyStateUpdateMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
    Attributes
    protected
  11. val certificateGenerator: X509CertificateGenerator
  12. val clock: Clock
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  14. 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()
  15. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  16. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  17. def connectionPoolForParticipant: Boolean
    Attributes
    protected
  18. 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
  19. val cryptoConfig: CryptoConfig
    Attributes
    protected
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. implicit val executionContext: ExecutionContextIdlenessExecutorService
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def getId: Option[NodeId]
  26. def getNode: Option[T]
  27. def getOrCreateEncryptionKey(name: String)(implicit traceContext: TraceContext): EitherT[Future, String, EncryptionPublicKey]
    Attributes
    protected
  28. def getOrCreateSigningKey(name: String)(implicit traceContext: TraceContext): EitherT[Future, String, SigningPublicKey]
    Attributes
    protected
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. val indexedStringStore: IndexedStringStore
    Attributes
    protected
  31. val initConfig: InitConfigBase
    Attributes
    protected
  32. val initializationStore: InitializationStore
    Attributes
    protected
  33. 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
  34. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  35. val ips: IdentityProvidingServiceClient
    Attributes
    protected
  36. 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
  37. def isInitialized: Boolean
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. def isRunning: Boolean
    Attributes
    protected
  40. def isWaitingForId: Boolean
  41. 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
  42. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  43. val loggerFactory: NamedLoggerFactory
  44. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  45. val name: InstanceName
  46. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  51. def onClosed(): Unit
  52. 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
  53. 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
  54. 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
  55. 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
  56. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  57. 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
  58. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  59. 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
  60. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  61. implicit val scheduler: ScheduledExecutorService
  62. 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
  63. def startInstanceUnlessClosing(instanceET: => EitherT[Future, String, T]): EitherT[Future, String, Unit]

    kick off initialisation during startup

    kick off initialisation during startup

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

    Can this node be initialized by a replica

    Can this node be initialized by a replica

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

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped