Packages

class ParticipantNodeBootstrap extends CantonNodeBootstrapBase[ParticipantNode, LocalParticipantConfig, ParticipantNodeParameters, ParticipantMetrics] with ParticipantNodeBootstrapCommon

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

Instance Constructors

  1. 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[SchedulersWithParticipantPruning] = _ => Future.successful(SchedulersWithParticipantPruning.noop), ledgerApiServerFactory: CantonLedgerApiServerFactory, persistentStateFactory: ParticipantNodePersistentStateFactory, packageUploaderFactory: PackageUploaderFactory, skipRecipientsCheck: Boolean, setInitialized: () => Unit)(implicit executionContext: ExecutionContextIdlenessExecutorService, scheduler: ScheduledExecutorService, actorSystem: ActorSystem, executionSequencerFactory: ExecutionSequencerFactory)

Type Members

  1. class InitializationWatcher extends FlagCloseable with NamedLogging
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase

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. val adminToken: CantonAdminToken

    per session created admin token for in-process connections to ledger-api

  9. val arguments: CantonNodeBootstrapCommonArguments[LocalParticipantConfig, ParticipantNodeParameters, ParticipantMetrics]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. 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
  12. 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
  13. val authorizedTopologyStore: TopologyStore[AuthorizedStore.type]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  14. def autoInitializeIdentity(initConfigBase: InitConfigBase): EitherT[FutureUnlessShutdown, String, Unit]

    Generate an identity for the node.

    Generate an identity for the node.

    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCantonNodeBootstrapBase
  15. 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
  16. def clock: Clock
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  18. 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
  19. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  20. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  21. def config: LocalParticipantConfig
  22. def connectionPoolForParticipant: Boolean
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCantonNodeBootstrapBase
  23. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  24. def createParticipantServices(participantId: ParticipantId, crypto: Crypto, storage: Storage, persistentStateFactory: ParticipantNodePersistentStateFactory, packageUploaderFactory: PackageUploaderFactory, engine: Engine, ledgerApiServerFactory: CantonLedgerApiServerFactory, indexedStringStore: IndexedStringStore, cantonSyncServiceFactory: Factory[CantonSyncService], setStartableStoppableLedgerApiAndCantonServices: (StartableStoppableLedgerApiServer, StartableStoppableLedgerApiDependentServices) => Unit, resourceManagementServiceFactory: (Eval[ParticipantSettingsStore]) => ResourceManagementService, replicationServiceFactory: (Storage) => ServerServiceDefinition, createSchedulers: (ParticipantSchedulersParameters) => Future[SchedulersWithParticipantPruning], createPartyNotifierAndSubscribe: (ParticipantEventPublisher) => LedgerServerPartyNotifier, adminToken: CantonAdminToken, topologyManager: ParticipantTopologyManagerOps, packageDependencyResolver: PackageDependencyResolver, componentFactory: ParticipantComponentBootstrapFactory, skipRecipientsCheck: Boolean, overrideKeyUniqueness: Option[Boolean] = None)(implicit executionSequencerFactory: ExecutionSequencerFactory): EitherT[FutureUnlessShutdown, String, (LedgerServerPartyNotifier, CantonSyncService, ParticipantNodeEphemeralState, LedgerApiServerState, StartableStoppableLedgerApiDependentServices, SchedulersWithParticipantPruning, ParticipantTopologyDispatcherCommon)]
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCommon
  25. 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
  26. val cryptoConfig: CryptoConfig
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  29. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. implicit val executionContext: ExecutionContextIdlenessExecutorService
    Definition Classes
    CantonNodeBootstrapBase
  31. def futureSupervisor: FutureSupervisor
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  32. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  33. def getId: Option[NodeId]
  34. def getNode: Option[ParticipantNode]
  35. val grpcHealthServer: Option[GrpcHealthServer]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  36. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  37. val healthReporter: GrpcHealthReporter
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  38. val indexedStringStore: IndexedStringStore
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  39. val initConfig: InitConfigBase
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  40. val initQueue: SimpleExecutionQueue
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  41. val initializationStore: InitializationStore
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  42. 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
    ParticipantNodeBootstrapCantonNodeBootstrapBase
  43. 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
  44. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  45. val ips: IdentityProvidingServiceClient
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  46. def isActive: Boolean
  47. 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
  48. def isInitialized: Boolean
  49. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  50. def isRunning: Boolean
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  51. def isWaitingForId: Boolean
    Definition Classes
    CantonNodeBootstrapBase
  52. 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
  53. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  54. def loggerFactory: NamedLoggerFactory
  55. 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
  56. def mkHealthComponents(nodeHealthService: HealthService, nodeLivenessService: LivenessHealthService): (GrpcHealthReporter, Option[GrpcHealthServer])
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  57. def mkNodeHealthService(storage: Storage): (DependenciesHealthService, LivenessHealthService)
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCantonNodeBootstrapBase
  58. 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
  59. def name: InstanceName
  60. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  61. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  63. lazy val nodeHealthService: DependenciesHealthService

    Health service component of the node

    Health service component of the node

    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  64. lazy val nodeLivenessService: LivenessHealthService

    Health service component of the node

    Health service component of the node

    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  65. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  66. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  67. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  68. def onClosed(): Unit
  69. 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()
  70. def parameterConfig: ParticipantNodeParameters
    Definition Classes
    CantonNodeBootstrapBase
  71. def parameters: ParticipantNodeParameters
    Definition Classes
    CantonNodeBootstrapBase
  72. 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
  73. 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
  74. 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
  75. 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
  76. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  77. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  78. 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
  79. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  80. val recordSequencerInteractions: AtomicReference[Option[RecordingConfig]]

    If set to Some(path), every sequencer client will record all received events to the directory path.

    If set to Some(path), every sequencer client will record all received events to the directory path.

    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCommon
  81. def registerHealthGauge(): Unit
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  82. val replaySequencerConfig: AtomicReference[Option[ReplayConfig]]
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCommon
  83. 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
  84. 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
  85. 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
  86. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  87. implicit val scheduler: ScheduledExecutorService
    Definition Classes
    CantonNodeBootstrapBase
  88. def sequencedTopologyStores: Seq[TopologyStore[TopologyStoreId]]

    All existing domain stores

    All existing domain stores

    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCantonNodeBootstrapBase
    Annotations
    @SuppressWarnings()
  89. def setPostInitCallbacks(sync: CantonSyncService): Unit
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapParticipantNodeBootstrapCommon
  90. 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
  91. 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
  92. def startTopologyManagementWriteService[E <: CantonError](topologyManager: TopologyManager[E]): Unit
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  93. def startWithStoredNodeId(id: NodeId): EitherT[FutureUnlessShutdown, String, Unit]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  94. val storage: Storage
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  95. final def storeId(id: NodeId): EitherT[Future, String, Unit]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  96. def supportsReplicaInitialization: Boolean

    Can this node be initialized by a replica

    Can this node be initialized by a replica

    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  97. lazy val syncAcsCommitmentProcessorHealth: MutableHealthComponent
  98. lazy val syncDomainEphemeralHealth: MutableHealthComponent
  99. lazy val syncDomainHealth: MutableHealthComponent
  100. lazy val syncDomainSequencerClientHealth: MutableHealthComponent
  101. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  102. def timeouts: ProcessingTimeout
  103. def toString(): String
    Definition Classes
    AnyRef → Any
  104. def topologyManagerWriteService[E <: CantonError](topologyManager: TopologyManager[E]): ServerServiceDefinition
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  105. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  106. implicit val tracer: Tracer
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  107. val tracerProvider: TracerProvider
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapBase
  108. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  109. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  110. 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 NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped