Packages

class PackageService extends DarService with NamedLogging with FlagCloseable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PackageService
  2. FlagCloseable
  3. PerformUnlessClosing
  4. HasSynchronizeWithReaders
  5. OnShutdownRunner
  6. HasRunOnClosing
  7. HasUnlessClosing
  8. AutoCloseable
  9. NamedLogging
  10. DarService
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PackageService(packageDependencyResolver: PackageDependencyResolver, loggerFactory: NamedLoggerFactory, metrics: ParticipantMetrics, packageMetadataView: PackageMetadataView, packageOps: PackageOps, packageUploader: PackageUploader, timeouts: ProcessingTimeout)(implicit ec: ExecutionContext)

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. 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
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. 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
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def getDar(mainPackageId: DarMainPackageId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, Dar]
    Definition Classes
    PackageServiceDarService
  14. def getDarContents(mainPackageId: DarMainPackageId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, Seq[PackageDescription]]
    Definition Classes
    PackageServiceDarService
  15. def getLfArchive(packageId: PackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[Archive]]
  16. def getPackage(packageId: PackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[Package]]
  17. def getPackageDescription(packageId: PackageId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, PackageDescription]
  18. def getPackageReferences(packageId: LfPackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[DarDescription]]

    Returns all dars that reference a certain package id

  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  20. 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
    OnShutdownRunnerHasUnlessClosing
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. 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
    PerformUnlessClosingHasSynchronizeWithReaders
  23. def listDars(limit: Option[Int])(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[DarDescription]]
    Definition Classes
    PackageServiceDarService
  24. def listPackages(limit: Option[Int] = None)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[PackageDescription]]
  25. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    PackageServiceNamedLogging
  27. 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
  28. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  29. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  34. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  35. def onClosed(): Unit
    Definition Classes
    PackageServicePerformUnlessClosing
  36. 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()
  37. val packageDependencyResolver: PackageDependencyResolver
  38. val packageMetadataView: PackageMetadataView
  39. 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. DO NOT PUT retries, especially indefinite ones, inside f.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    PerformUnlessClosing
  40. 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
  41. def performUnlessClosingCheckedUST[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[FutureUnlessShutdown, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[FutureUnlessShutdown, A, N, R]
    Definition Classes
    PerformUnlessClosing
  42. 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. DO NOT PUT retries, especially indefinite ones, inside f.

    etf

    The task to perform

    Definition Classes
    PerformUnlessClosing
  43. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  44. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  45. def performUnlessClosingEitherUSFAsync[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(asyncResultToWaitForF: (R) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    etf

    closing of this object will wait for all such spawned Futures to finish

    asyncResultToWaitForF

    closing of this object will wait also wait for all such asynchronous Futures to finish too

    returns

    the future spawned by etf

    Definition Classes
    PerformUnlessClosing
  46. 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. DO NOT PUT retries, especially indefinite ones, inside f.

    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
  47. def performUnlessClosingOptionUSF[R](name: String)(otf: => OptionT[FutureUnlessShutdown, R])(implicit ec: ExecutionContext, traceContext: TraceContext): OptionT[FutureUnlessShutdown, R]
    Definition Classes
    PerformUnlessClosing
  48. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  49. def performUnlessClosingUSFAsync[A](name: String)(f: => FutureUnlessShutdown[A])(asyncResultToWaitForF: (A) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    f

    closing of this object will wait for all such spawned Futures to finish

    asyncResultToWaitForF

    closing of this object will wait also wait for all such asynchronous Futures to finish too

    returns

    the future spawned by f

    Definition Classes
    PerformUnlessClosing
  50. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  51. def removeDar(mainPackageId: DarMainPackageId)(implicit tc: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
  52. def removePackage(packageId: PackageId, force: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
  53. 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
  54. 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's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle 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
    OnShutdownRunnerHasRunOnClosing
  55. 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's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  56. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  57. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  58. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  59. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  60. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  61. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    PackageServiceFlagCloseable
  62. def toString(): String
    Definition Classes
    AnyRef → Any
  63. 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 in HasSynchronizeWithClosing. 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()
  64. def unvetDar(mainPackageId: DarMainPackageId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
  65. 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:

    1. Decodes the provided DAR payloads
    2. Validates the resulting Daml packages
    3. Persists the DARs and decoded archives in the DARs and package stores
    4. Dispatches the package upload event for inclusion in the ledger sync event stream
    5. Updates the com.digitalasset.canton.participant.store.memory.MutablePackageMetadataView which is used for subsequent DAR upload validations and incoming Ledger API queries
    6. Issues a package vetting topology transaction for all uploaded packages (if vetAllPackages is enabled) and waits for for its completion (if synchronizeVetting 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
    PackageServiceDarService
  66. 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:

    1. Decodes the provided DAR payload
    2. Validates the resulting Daml packages
    3. Persists the DAR and decoded archives in the DARs and package stores
    4. Dispatches the package upload event for inclusion in the ledger sync event stream
    5. Updates the com.digitalasset.canton.participant.store.memory.MutablePackageMetadataView which is used for subsequent DAR upload validations and incoming Ledger API queries
    6. Issues a package vetting topology transaction for all uploaded packages (if vetAllPackages is enabled) and waits for for its completion (if synchronizeVetting 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.

  67. def validateDar(payload: ByteString, darName: String)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, DarMainPackageId]
    Definition Classes
    PackageServiceDarService
  68. def vetDar(mainPackageId: DarMainPackageId, synchronizeVetting: PackageVettingSynchronization)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
  69. def vetPackages(packages: Seq[PackageId], synchronizeVetting: PackageVettingSynchronization)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, RpcError, Unit]
  70. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  71. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  72. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  73. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from DarService

Inherited from AnyRef

Inherited from Any

Ungrouped