class PackageService extends DarService with PackageInfoService with NamedLogging with FlagCloseable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PackageService
  2. FlagCloseable
  3. AutoCloseable
  4. NamedLogging
  5. PackageInfoService
  6. DarService
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PackageService(engine: Engine, packagesDarsStore: DamlPackageStore, eventPublisher: ParticipantEventPublisher, hashOps: HashOps, vetPackages: (Traced[(Seq[PackageId], Boolean)]) => EitherT[Future, ParticipantTopologyManagerError, Unit], inspectionOps: PackageInspectionOps, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def appendDarFromByteString(payload: ByteString, filename: String, vetAllPackages: Boolean, synchronizeVetting: Boolean)(implicit traceContext: TraceContext): EitherT[Future, DamlError, Hash]

    Stores DAR file from given byte string with the provided filename.

    Stores DAR file from given byte string with the provided filename. All the Daml packages inside the DAR file are also stored.

    payload

    ByteString containing the data of the DAR file

    filename

    String the filename of the DAR

    returns

    Future with the hash of the DAR file

    Definition Classes
    PackageServiceDarService
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. 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()
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def getDar(hash: Hash)(implicit traceContext: TraceContext): Future[Option[Dar]]
    Definition Classes
    PackageServiceDarService
  15. def getDescription(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[PackageDescription]]
    Definition Classes
    PackageServicePackageInfoService
  16. def getLfArchive(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[Archive]]
  17. def getPackage(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[Package]]
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  20. 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
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. 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
  23. def listDarContents(darId: Hash)(implicit traceContext: TraceContext): EitherT[Future, String, (DarDescriptor, Dar[Archive])]
  24. def listDars(limit: Option[Int])(implicit traceContext: TraceContext): Future[Seq[DarDescriptor]]
    Definition Classes
    PackageServiceDarService
  25. def listPackages(limit: Option[Int] = None)(implicit traceContext: TraceContext): Future[Seq[PackageDescription]]
  26. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    PackageServiceNamedLogging
  28. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  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
    @native() @HotSpotIntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def onClosed(): Unit
    Definition Classes
    PackageServiceFlagCloseable
  35. def packageDependencies(packages: List[PackageId]): EitherT[Future, PackageId, Set[PackageId]]
  36. 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
    FlagCloseable
  37. 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
    FlagCloseable
  38. 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
  39. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  40. 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
    FlagCloseable
  41. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  42. def removeDar(darHash: Hash)(implicit tc: TraceContext): EitherT[Future, PackageRemovalError, Unit]
  43. def removePackage(packageId: PackageId, force: Boolean)(implicit traceContext: TraceContext): EitherT[Future, PackageRemovalError, Unit]
  44. 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
  45. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  46. def storeValidatedPackagesAndSyncEvent(archives: List[Archive], sourceDescription: String256M, submissionId: LedgerSubmissionId, dar: Option[Dar], vetAllPackages: Boolean, synchronizeVetting: Boolean)(implicit traceContext: TraceContext): EitherT[Future, DamlError, Unit]

    Stores archives in the store and sends package upload event to participant event log for inclusion in ledger sync event stream.

    Stores archives in the store and sends package upload event to participant event log for inclusion in ledger sync event stream. This allows the ledger api server to update its package store accordingly and unblock synchronous upload request if the request originated in the ledger api.

    archives

    The archives to store. They must have been decoded and package-validated before.

    sourceDescription

    description of the source of the package

    submissionId

    upstream submissionId for ledger api server to recognize previous package upload requests

    vetAllPackages

    if true, then the packages will be vetted automatically

    synchronizeVetting

    if true, the future will terminate once the participant observed the package vetting on all connected domains

    returns

    future holding whether storing and/or event sending failed (relevant to upstream caller)

  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    PackageServiceFlagCloseable
  49. def toString(): String
    Definition Classes
    AnyRef → Any
  50. def vetPackages(packages: Seq[PackageId], syncVetting: Boolean)(implicit traceContext: TraceContext): EitherT[Future, DamlError, Unit]
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  53. 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

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from PackageInfoService

Inherited from DarService

Inherited from AnyRef

Inherited from Any

Ungrouped