Packages

class PackageService extends DarService with PackageInfoService with NamedLogging with FlagCloseable

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

Instance Constructors

  1. new PackageService(dependencyResolver: PackageDependencyResolver, packageUploader: Eval[PackageUploader], hashOps: HashOps, packageOps: PackageOps, metrics: ParticipantMetrics, timeouts: ProcessingTimeout, 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 appendDarFromByteString(payload: ByteString, filename: String, vetAllPackages: Boolean, synchronizeVetting: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, 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
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. 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
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  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
    FlagCloseableOnShutdownRunner → AutoCloseable
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  10. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  11. val dependencyResolver: PackageDependencyResolver
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. def getDar(hash: Hash)(implicit traceContext: TraceContext): Future[Option[Dar]]
    Definition Classes
    PackageServiceDarService
  17. def getDescription(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[PackageDescription]]
    Definition Classes
    PackageServicePackageInfoService
  18. def getLfArchive(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[Archive]]
  19. def getPackage(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[Package]]
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  22. 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
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. 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
  25. def listDarContents(darId: Hash)(implicit traceContext: TraceContext): EitherT[Future, String, (DarDescriptor, Dar[Archive])]
  26. def listDars(limit: Option[Int])(implicit traceContext: TraceContext): Future[Seq[DarDescriptor]]
    Definition Classes
    PackageServiceDarService
  27. def listPackages(limit: Option[Int] = None)(implicit traceContext: TraceContext): Future[Seq[PackageDescription]]
  28. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    PackageServiceNamedLogging
  30. 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
  31. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  36. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  37. def onClosed(): Unit
    Definition Classes
    PackageServicePerformUnlessClosing
  38. 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()
  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.

    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 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
  42. 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
  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 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
  46. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  47. def removeDar(darHash: Hash)(implicit tc: TraceContext): EitherT[FutureUnlessShutdown, CantonError, Unit]
  48. def removePackage(packageId: PackageId, force: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CantonError, Unit]
  49. 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
  50. 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
  51. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    PackageServiceFlagCloseable
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. def unvetDar(darHash: Hash)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CantonError, Unit]
  56. def upload(darBytes: ByteString, fileNameO: Option[String], submissionId: LedgerSubmissionId, vetAllPackages: Boolean, synchronizeVetting: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DamlError, Unit]

    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 in-memory package-id resolution state used for subsequent validations 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.

    fileNameO

    The DAR filename, present if uploaded via the Admin API.

    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

  57. def validateDar(payload: ByteString, darFileNameO: Option[String])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DamlError, Hash]

    Decodes and validates the packages in the provided DAR payload.

    Decodes and validates the packages in the provided DAR payload.

    This method serves as the "dry-run" counterpart of the upload flow and is meant for checking packages against the current participant-node state without modifying the uploaded and vetted packages state.

  58. def vetDar(darHash: Hash, synchronize: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CantonError, Unit]
  59. def vetPackages(packages: Seq[PackageId], syncVetting: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, DamlError, Unit]
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  62. 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 FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from PackageInfoService

Inherited from DarService

Inherited from AnyRef

Inherited from Any

Ungrouped