abstract class CantonNodeBootstrapBase[T <: CantonNode, NodeConfig <: LocalNodeConfig, ParameterConfig <: LocalNodeParameters] 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
- Alphabetic
- By Inheritance
- CantonNodeBootstrapBase
- NoTracing
- HasCloseContext
- CantonNodeBootstrap
- NamedLogging
- FlagCloseable
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CantonNodeBootstrapBase(name: InstanceName, config: NodeConfig, parameterConfig: ParameterConfig, clock: Clock, nodeMetrics: NodeMetrics, storageFactory: StorageFactory, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContextIdlenessExecutorService, actorSystem: ActorSystem)
Type Members
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
Abstract Value Members
- abstract def autoInitializeIdentity(): EitherT[Future, String, Unit]
Generate an identity for the node.
Generate an identity for the node.
- Attributes
- protected
- 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
- abstract def isActive: Boolean
- Attributes
- protected
Concrete 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
- implicit val actorSystem: ActorSystem
- val adminApiConfig: AdminServerConfig
- Attributes
- protected
- val adminServer: CloseableServer
- Attributes
- protected
- val adminServerRegistry: CantonMutableHandlerRegistry
- Attributes
- protected
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def authorizeDomainGovernance[E <: CantonError](manager: TopologyManager[E], key: SigningPublicKey, mapping: DomainGovernanceMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
- Attributes
- protected
- def authorizeStateUpdate[E <: CantonError](manager: TopologyManager[E], key: SigningPublicKey, mapping: TopologyStateUpdateMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
- Attributes
- protected
- val certificateGenerator: X509CertificateGenerator
- val clock: Clock
- Definition Classes
- CantonNodeBootstrapBase → CantonNodeBootstrap
- 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 → AutoCloseable
- Annotations
- @SuppressWarnings()
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def connectionPoolForParticipant: Boolean
- Attributes
- protected
- 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
- CantonNodeBootstrapBase → CantonNodeBootstrap
- val cryptoConfig: CryptoConfig
- Attributes
- protected
- val dbStorageMetrics: DbStorageMetrics
- Attributes
- protected
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit val executionContext: ExecutionContextIdlenessExecutorService
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getId: Option[NodeId]
- Definition Classes
- CantonNodeBootstrapBase → CantonNodeBootstrap
- def getNode: Option[T]
- Definition Classes
- CantonNodeBootstrapBase → CantonNodeBootstrap
- def getOrCreateEncryptionKey(name: String)(implicit traceContext: TraceContext): EitherT[Future, String, EncryptionPublicKey]
- Attributes
- protected
- def getOrCreateSigningKey(name: String)(implicit traceContext: TraceContext): EitherT[Future, String, SigningPublicKey]
- Attributes
- protected
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val indexedStringStore: IndexedStringStore
- Attributes
- protected
- val initConfig: InitConfigBase
- Attributes
- protected
- val initializationStore: InitializationStore
- Attributes
- protected
- 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
- CantonNodeBootstrapBase → CantonNodeBootstrap
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- val ips: IdentityProvidingServiceClient
- Attributes
- protected
- 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
- def isInitialized: Boolean
- Definition Classes
- CantonNodeBootstrapBase → CantonNodeBootstrap
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isRunning: Boolean
- Attributes
- protected
- 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
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Definition Classes
- CantonNodeBootstrapBase → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- val name: InstanceName
- Definition Classes
- CantonNodeBootstrapBase → CantonNodeBootstrap
- 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 onClosed(): Unit
- Definition Classes
- CantonNodeBootstrapBase → FlagCloseable
- 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
- FlagCloseable
- 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
- FlagCloseable
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- FlagCloseable
- 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
- FlagCloseable
- 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
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- 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
- CantonNodeBootstrapBase → CantonNodeBootstrap
- def startInstanceUnlessClosing(instanceET: => EitherT[Future, String, T]): EitherT[Future, String, Unit]
kick off initialisation during startup
kick off initialisation during startup
- Attributes
- protected
- def startTopologyManagementWriteService[E <: CantonError](topologyManager: TopologyManager[E], authorizedStore: TopologyStore[AuthorizedStore]): Unit
- Attributes
- protected
- def startWithStoredNodeId(id: NodeId): EitherT[Future, String, Unit]
- Attributes
- protected
- val storage: Storage
- Attributes
- protected
- final def storeId(id: NodeId): EitherT[Future, String, Unit]
- Attributes
- protected
- val supportsReplicaInitialization: Boolean
Can this node be initialized by a replica
Can this node be initialized by a replica
- Attributes
- protected
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Definition Classes
- CantonNodeBootstrapBase → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- val topologyStoreFactory: TopologyStoreFactory
- Attributes
- protected
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- implicit val tracer: Tracer
- val tracerProvider: TracerProvider
- Attributes
- protected
- 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])
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable