class PackageService extends DarService with NamedLogging with FlagCloseable
- Alphabetic
- By Inheritance
- PackageService
- FlagCloseable
- PerformUnlessClosing
- HasSynchronizeWithReaders
- HasSynchronizeWithClosing
- OnShutdownRunner
- HasRunOnClosing
- HasUnlessClosing
- AutoCloseable
- NamedLogging
- DarService
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new PackageService(packageDependencyResolver: PackageDependencyResolver, loggerFactory: NamedLoggerFactory, metrics: ParticipantMetrics, packageMetadataView: PackageMetadataView, packageOps: PackageOps, packageUploader: PackageUploader, timeouts: ProcessingTimeout)(implicit ec: ExecutionContext)
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
- def addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- 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 → OnShutdownRunner → AutoCloseable
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getDar(mainPackageId: DarMainPackageId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, Dar]
- Definition Classes
- PackageService → DarService
- def getDarContents(mainPackageId: DarMainPackageId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, Seq[PackageDescription]]
- Definition Classes
- PackageService → DarService
- def getLfArchive(packageId: PackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[Archive]]
- def getPackage(packageId: PackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[Package]]
- def getPackageDescription(packageId: PackageId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, PackageDescription]
- def getPackageReferences(packageId: LfPackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[DarDescription]]
Returns all dars that reference a certain package id
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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 → HasUnlessClosing
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepTrackOfReaderCallStack: Boolean
Set this to true to get detailed information about all futures that did not complete during shutdown.
Set this to true to get detailed information about all futures that did not complete during shutdown.
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def listDars(limit: Option[Int])(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[DarDescription]]
- Definition Classes
- PackageService → DarService
- def listPackages(limit: Option[Int] = None)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[PackageDescription]]
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- PackageService → NamedLogging
- def nameInternal: String
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- 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
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Definition Classes
- PackageService → PerformUnlessClosing
- 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
- PerformUnlessClosing → OnShutdownRunner
- val packageDependencyResolver: PackageDependencyResolver
- val packageMetadataView: PackageMetadataView
- def remainingReaders(): Seq[String]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- def removeDar(mainPackageId: DarMainPackageId)(implicit tc: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
- def removePackage(packageId: PackageId, force: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
- def removeReader(handle: ReaderHandle): Unit
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]
Schedules the given task to be run upon closing.
Schedules the given task to be run upon closing.
- returns
An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the
LifeCycleManager
'scloseAsync
method completes or whenAutoCloseable
'sclose
method returns, unless the returnedLifeCycleRegistrationHandle
was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the
LifeCycleManager
'scloseAsync
method completes orAutoCloseable
'sclose
returns. This is because the task is run immediately if the component has already been closed.- Definition Classes
- HasRunOnClosing
- final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
- Definition Classes
- HasRunOnClosing
- def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
- Attributes
- protected[this]
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]
Runs the computation
f
only if the component is not yet closing.Runs the computation
f
only if the component is not yet closing. If so, the component will delay releasing its resources untilf
has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as part off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- returns
The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
f
has not run. Otherwise it is the result of runningf
.
- Definition Classes
- HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Convenience method for synchronizing on
Future
s instead ofFutureUnlessShutdown
s.Convenience method for synchronizing on
Future
s instead ofFutureUnlessShutdown
s. Equivalent tosynchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
- Definition Classes
- PerformUnlessClosing
- def synchronizeWithClosingPatience: FiniteDuration
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Runs the computation
f
only if the component is not yet closing.Runs the computation
f
only if the component is not yet closing. If so, the component will delay releasing its resources untilf
has finished or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as part off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
f
has not run.
- Definition Classes
- HasSynchronizeWithClosing
- Annotations
- @SuppressWarnings()
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
Runs the computation
f
only if the component is not yet closing.Runs the computation
f
only if the component is not yet closing. If so, the component will delay releasing its resources untilf
has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as part off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
f
has not run. Otherwise the result of runningf
.
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- PackageService → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]
Runs the computation
fa
unless isClosing returns true.Runs the computation
fa
unless isClosing returns true.This method does not delay the closing while
fa
is running, unlike the methods inHasSynchronizeWithClosing
. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.- returns
The result of
fa
or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true
- Definition Classes
- HasUnlessClosing
- Annotations
- @inline()
- def unvetDar(mainPackageId: DarMainPackageId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
- def upload(dars: Seq[UploadDarData], submissionIdO: Option[LedgerSubmissionId], vetAllPackages: Boolean, synchronizeVetting: PackageVettingSynchronization)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Seq[DarMainPackageId]]
Performs the upload DAR flow:
Performs the upload DAR flow:
- Decodes the provided DAR payloads
- Validates the resulting Daml packages
- Persists the DARs and decoded archives in the DARs and package stores
- Dispatches the package upload event for inclusion in the ledger sync event stream
- Updates the com.digitalasset.canton.participant.store.memory.MutablePackageMetadataView which is used for subsequent DAR upload validations and incoming Ledger API queries
- Issues a package vetting topology transaction for all uploaded packages (if
vetAllPackages
is enabled) and waits for for its completion (ifsynchronizeVetting
is enabled).
- dars
The DARs (bytes, description, expected main package) to upload.
- submissionIdO
upstream submissionId for ledger api server to recognize previous package upload requests
- vetAllPackages
if true, then the packages will be vetted automatically
- synchronizeVetting
a value of PackageVettingSynchronization, that checks that the packages have been vetted on all connected synchronizers. The Future returned by the check will complete once all synchronizers have observed the vetting to be effective for the new packages. The caller may also pass be a no-op implementation that immediately returns, depending no the caller's needs for synchronization.
- Definition Classes
- PackageService → DarService
- final def upload(darBytes: ByteString, description: Option[String], submissionIdO: Option[LedgerSubmissionId], vetAllPackages: Boolean, synchronizeVetting: PackageVettingSynchronization, expectedMainPackageId: Option[LfPackageId])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, DarMainPackageId]
Performs the upload DAR flow:
Performs the upload DAR flow:
- Decodes the provided DAR payload
- Validates the resulting Daml packages
- Persists the DAR and decoded archives in the DARs and package stores
- Dispatches the package upload event for inclusion in the ledger sync event stream
- Updates the com.digitalasset.canton.participant.store.memory.MutablePackageMetadataView which is used for subsequent DAR upload validations and incoming Ledger API queries
- Issues a package vetting topology transaction for all uploaded packages (if
vetAllPackages
is enabled) and waits for for its completion (ifsynchronizeVetting
is enabled).
- darBytes
The DAR payload to store.
- description
A description of the DAR.
- submissionIdO
upstream submissionId for ledger api server to recognize previous package upload requests
- vetAllPackages
if true, then the packages will be vetted automatically
- synchronizeVetting
a value of PackageVettingSynchronization, that checks that the packages have been vetted on all connected synchronizers. The Future returned by the check will complete once all synchronizers have observed the vetting for the new packages. The caller may also pass be a no-op implementation that immediately returns, depending no the caller's needs for synchronization.
- def validateDar(payload: ByteString, darName: String)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, DarMainPackageId]
- Definition Classes
- PackageService → DarService
- def vetDar(mainPackageId: DarMainPackageId, synchronizeVetting: PackageVettingSynchronization)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
- def vetPackages(packages: Seq[PackageId], synchronizeVetting: PackageVettingSynchronization)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
- 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])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders