com.digitalasset.canton.participant
ParticipantNodeBootstrap
Companion object ParticipantNodeBootstrap
class ParticipantNodeBootstrap extends CantonNodeBootstrapBase[ParticipantNode, LocalParticipantConfig, ParticipantNodeParameters, ParticipantMetrics] with ParticipantNodeBootstrapCommon
- Alphabetic
- By Inheritance
- ParticipantNodeBootstrap
- ParticipantNodeBootstrapCommon
- CantonNodeBootstrapBase
- CantonNodeBootstrapCommon
- NoTracing
- HasCloseContext
- CantonNodeBootstrap
- NamedLogging
- FlagCloseable
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ParticipantNodeBootstrap(arguments: CantonNodeBootstrapCommonArguments[LocalParticipantConfig, ParticipantNodeParameters, ParticipantMetrics], engine: Engine, cantonSyncServiceFactory: Factory[CantonSyncService], setStartableStoppableLedgerApiAndCantonServices: (StartableStoppableLedgerApiServer, StartableStoppableLedgerApiDependentServices) => Unit, resourceManagementServiceFactory: (Eval[ParticipantSettingsStore]) => ResourceManagementService, replicationServiceFactory: (Storage) => ServerServiceDefinition, createSchedulers: (ParticipantSchedulersParameters) => Future[SchedulersWithPruning] = _ => Future.successful(SchedulersWithPruning.noop), ledgerApiServerFactory: CantonLedgerApiServerFactory, persistentStateFactory: ParticipantNodePersistentStateFactory, skipRecipientsCheck: Boolean)(implicit executionContext: ExecutionContextIdlenessExecutorService, scheduler: ScheduledExecutorService, actorSystem: ActorSystem, executionSequencerFactory: ExecutionSequencerFactory)
Type Members
- class InitializationWatcher extends FlagCloseable with NamedLogging
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
Value Members
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable
- 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
- Definition Classes
- CantonNodeBootstrapCommon
- val adminApiConfig: AdminServerConfig
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val adminServer: CloseableServer
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val adminServerRegistry: CantonMutableHandlerRegistry
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val adminToken: CantonAdminToken
per session created admin token for in-process connections to ledger-api
- val arguments: CantonNodeBootstrapCommonArguments[LocalParticipantConfig, ParticipantNodeParameters, ParticipantMetrics]
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- Definition Classes
- CantonNodeBootstrapBase
- def authorizeStateUpdate[E <: CantonError](manager: TopologyManager[E], key: SigningPublicKey, mapping: TopologyStateUpdateMapping, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- val authorizedTopologyStore: TopologyStore[AuthorizedStore.type]
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- def autoInitializeIdentity(initConfigBase: InitConfigBase): EitherT[FutureUnlessShutdown, String, Unit]
Generate an identity for the node.
Generate an identity for the node.
- Attributes
- protected
- Definition Classes
- ParticipantNodeBootstrap → CantonNodeBootstrapBase
- def clock: Clock
- Definition Classes
- CantonNodeBootstrapCommon → 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 config: LocalParticipantConfig
- Definition Classes
- ParticipantNodeBootstrap → ParticipantNodeBootstrapCommon → CantonNodeBootstrapCommon
- def connectionPoolForParticipant: Boolean
- Attributes
- protected
- Definition Classes
- ParticipantNodeBootstrap → CantonNodeBootstrapCommon
- def createParticipantServices(participantId: ParticipantId, crypto: Crypto, storage: Storage, persistentStateFactory: ParticipantNodePersistentStateFactory, engine: Engine, ledgerApiServerFactory: CantonLedgerApiServerFactory, indexedStringStore: IndexedStringStore, cantonSyncServiceFactory: Factory[CantonSyncService], setStartableStoppableLedgerApiAndCantonServices: (StartableStoppableLedgerApiServer, StartableStoppableLedgerApiDependentServices) => Unit, resourceManagementServiceFactory: (Eval[ParticipantSettingsStore]) => ResourceManagementService, replicationServiceFactory: (Storage) => ServerServiceDefinition, createSchedulers: (ParticipantSchedulersParameters) => Future[SchedulersWithPruning], createPartyNotifierAndSubscribe: (ParticipantEventPublisher) => LedgerServerPartyNotifier, adminToken: CantonAdminToken, topologyManager: ParticipantTopologyManagerOps, componentFactory: ParticipantComponentBootstrapFactory, skipRecipientsCheck: Boolean, overrideKeyUniqueness: Option[Boolean] = None)(implicit executionSequencerFactory: ExecutionSequencerFactory): EitherT[FutureUnlessShutdown, String, (LedgerServerPartyNotifier, CantonSyncService, ParticipantNodeEphemeralState, LedgerApiServerState, StartableStoppableLedgerApiDependentServices, SchedulersWithPruning, ParticipantTopologyDispatcherCommon)]
- Attributes
- protected
- Definition Classes
- ParticipantNodeBootstrapCommon
- val crypto: Some[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
- Definition Classes
- CantonNodeBootstrapCommon
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- implicit val executionContext: ExecutionContextIdlenessExecutorService
- Definition Classes
- CantonNodeBootstrapCommon
- def futureSupervisor: FutureSupervisor
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getId: Option[NodeId]
- Definition Classes
- CantonNodeBootstrapBase → CantonNodeBootstrap
- def getNode: Option[ParticipantNode]
- Definition Classes
- CantonNodeBootstrapBase → CantonNodeBootstrap
- val grpcHealthServer: Option[GrpcHealthServer]
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val healthReporter: GrpcHealthReporter
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- val indexedStringStore: IndexedStringStore
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- val initConfig: InitConfigBase
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val initQueue: SimpleExecutionQueue
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val initializationStore: InitializationStore
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- def initialize(id: NodeId): EitherT[FutureUnlessShutdown, String, Unit]
Attempt to start the node with this identity.
Attempt to start the node with this identity.
- Definition Classes
- ParticipantNodeBootstrap → CantonNodeBootstrapBase
- 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
- 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
- Definition Classes
- CantonNodeBootstrapCommon
- def isActive: Boolean
- Definition Classes
- ParticipantNodeBootstrap → CantonNodeBootstrapBase → CantonNodeBootstrap
- 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
- Definition Classes
- CantonNodeBootstrapBase
- def isWaitingForId: Boolean
- Definition Classes
- CantonNodeBootstrapBase
- 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
- def loggerFactory: NamedLoggerFactory
- Definition Classes
- CantonNodeBootstrapCommon → NamedLogging
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def mkHealthComponents(nodeHealthService: HealthService): (GrpcHealthReporter, Option[GrpcHealthServer])
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- def mkNodeHealthService(storage: Storage): HealthService
- Attributes
- protected
- Definition Classes
- ParticipantNodeBootstrap → CantonNodeBootstrapCommon
- def name: InstanceName
- Definition Classes
- CantonNodeBootstrapCommon → CantonNodeBootstrap
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- lazy val nodeHealthService: HealthService
Health service component of the node
Health service component of the node
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def onClosed(): Unit
- Definition Classes
- ParticipantNodeBootstrap → CantonNodeBootstrapBase → FlagCloseable
- def parameterConfig: ParticipantNodeParameters
- Definition Classes
- CantonNodeBootstrapCommon
- def parameters: ParticipantNodeParameters
- Definition Classes
- CantonNodeBootstrapCommon
- 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 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
- 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 performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, 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 performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- FlagCloseable
- val recordSequencerInteractions: AtomicReference[Option[RecordingConfig]]
If set to
Some(path), every sequencer client will record all received events to the directorypath.If set to
Some(path), every sequencer client will record all received events to the directorypath.- Attributes
- protected
- Definition Classes
- ParticipantNodeBootstrapCommon
- def registerHealthGauge(): Unit
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val replaySequencerConfig: AtomicReference[Option[ReplayConfig]]
- Attributes
- protected
- Definition Classes
- ParticipantNodeBootstrapCommon
- 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
- 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.
- Definition Classes
- CantonNodeBootstrapBase
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- implicit val scheduler: ScheduledExecutorService
- Definition Classes
- CantonNodeBootstrapCommon
- def sequencedTopologyStores: Seq[TopologyStore[TopologyStoreId]]
All existing domain stores
All existing domain stores
- Attributes
- protected
- Definition Classes
- ParticipantNodeBootstrap → CantonNodeBootstrapBase
- Annotations
- @SuppressWarnings()
- def setPostInitCallbacks(sync: CantonSyncService, packageService: PackageService): Unit
- Attributes
- protected
- Definition Classes
- ParticipantNodeBootstrap → ParticipantNodeBootstrapCommon
- 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[FutureUnlessShutdown, String, ParticipantNode]): EitherT[FutureUnlessShutdown, String, Unit]
kick off initialisation during startup
kick off initialisation during startup
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- def startTopologyManagementWriteService[E <: CantonError](topologyManager: TopologyManager[E], authorizedStore: TopologyStore[AuthorizedStore]): Unit
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- def startWithStoredNodeId(id: NodeId): EitherT[FutureUnlessShutdown, String, Unit]
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- val storage: Storage
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- final def storeId(id: NodeId): EitherT[Future, String, Unit]
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- def supportsReplicaInitialization: Boolean
Can this node be initialized by a replica
Can this node be initialized by a replica
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- lazy val syncDomainEphemeralHealth: MutableHealthComponent
- Definition Classes
- ParticipantNodeBootstrapCommon
- lazy val syncDomainHealth: MutableHealthComponent
- Definition Classes
- ParticipantNodeBootstrapCommon
- lazy val syncDomainSequencerClientHealth: MutableHealthComponent
- Definition Classes
- ParticipantNodeBootstrapCommon
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timeouts: ProcessingTimeout
- Definition Classes
- CantonNodeBootstrapCommon → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def topologyManagerWriteService[E <: CantonError](topologyManager: TopologyManager[E], authorizedStore: TopologyStore[AuthorizedStore]): ServerServiceDefinition
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapBase
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- implicit val tracer: Tracer
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val tracerProvider: TracerProvider
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- 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])