class DbDamlPackageStore extends DamlPackageStore with DbStore

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbDamlPackageStore
  2. DbStore
  3. HasCloseContext
  4. PromiseUnlessShutdownFactory
  5. NamedLogging
  6. FlagCloseable
  7. PerformUnlessClosing
  8. HasSynchronizeWithReaders
  9. HasSynchronizeWithClosing
  10. OnShutdownRunner
  11. HasRunOnClosing
  12. HasUnlessClosing
  13. DamlPackageStore
  14. AutoCloseable
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbDamlPackageStore(storage: DbStorage, timeouts: ProcessingTimeout, futureSupervisor: FutureSupervisor, exitOnFatalFailures: Boolean, loggerFactory: NamedLoggerFactory)(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. def anyPackagePreventsDarRemoval(packages: Seq[PackageId], removeDar: DarDescription)(implicit tc: TraceContext): OptionT[FutureUnlessShutdown, PackageId]

    Find from packages a registered package that does not exist in any dar except perhaps removeDar.

    Find from packages a registered package that does not exist in any dar except perhaps removeDar. This checks whether a DAR containing packages can be safely removed -- if there's any package that would be left without a DAR then we won't remove the DAR.

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  6. def append(pkgs: List[(PackageInfo, Archive)], uploadedAt: CantonTimestamp, dar: Dar)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    pkgs

    Daml packages to be stored

    uploadedAt

    The timestamp at which the package has been persisted in the store

    dar

    The DAR containing the packages

    returns

    Future which gets completed when the packages are successfully stored.

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
    Annotations
    @SuppressWarnings()
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  9. 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
  10. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  11. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  12. def determinePackagesExclusivelyInDar(packages: Seq[PackageId], dar: DarDescription)(implicit tc: TraceContext): FutureUnlessShutdown[Seq[PackageId]]

    Returns the package IDs from the set of packages that are only referenced by the provided dar.

    Returns the package IDs from the set of packages that are only referenced by the provided dar.

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. def getDar(mainPackageId: DarMainPackageId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, Dar]

    Get DAR by its main package ID

    Get DAR by its main package ID

    mainPackageId

    The main package-id of the DAR archive

    returns

    Future that will contain an empty option if the DAR with the given package ID could not be found or an option with the DAR if it could be found.

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  18. def getPackage(packageId: PackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[Archive]]

    packageId

    The package id of the Daml package to be retrieved from the store.

    returns

    Future that will contain an empty option if the package with the given id could not be found or an option with the archive (serialized version of the package) if it could be found.

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  19. def getPackageDescription(packageId: PackageId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, PackageDescription]
    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  20. def getPackageDescriptionsOfDar(mainPackageId: DarMainPackageId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, Seq[PackageDescription]]

    Get the packages in the DAR by its main package ID

    Get the packages in the DAR by its main package ID

    mainPackageId

    The main package ID of the DAR file

    returns

    The package description of the given dar

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  21. def getPackageReferences(packageId: LfPackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[DarDescription]]

    Return all DARs that reference a given package

    Return all DARs that reference a given package

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. 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
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. 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
  26. def listDars(limit: Option[Int])(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[DarDescription]]

    returns

    Future with sequence of DAR descriptors (ID and name)

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  27. def listPackages(limit: Option[Int])(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[PackageDescription]]

    returns

    yields descriptions of all persisted Daml packages

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  28. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbDamlPackageStoreNamedLogging
  30. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext): 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
  31. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  32. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  37. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  38. def onClosed(): Unit
  39. 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
  40. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  41. def removeDar(mainPackageId: DarMainPackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    Remove the DAR with the main package ID from the store

    Remove the DAR with the main package ID from the store

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  42. def removePackage(packageId: PackageId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    Remove the package from the package store.

    Remove the package from the package store.

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  43. 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
  44. 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
  45. 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
  46. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

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

  47. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  48. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbDamlPackageStoreDbStore
  49. 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 until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    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.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  50. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  51. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  52. 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 until f has finished or the synchronizeWithClosingPatience has elapsed.

    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.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  53. 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 until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    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.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  54. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  55. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  56. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbDamlPackageStoreFlagCloseable
  57. def toString(): String
    Definition Classes
    AnyRef → Any
  58. 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()
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. 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 DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from DamlPackageStore

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped