c

com.digitalasset.canton.participant.store.db

DbServiceAgreementStore

class DbServiceAgreementStore extends ServiceAgreementStore with DbStore

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbServiceAgreementStore
  2. DbStore
  3. HasCloseContext
  4. NamedLogging
  5. FlagCloseable
  6. ServiceAgreementStore
  7. AutoCloseable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbServiceAgreementStore(storage: DbStorage, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

Type Members

  1. type ServiceAgreementStoreT[A] = EitherT[Future, ServiceAgreementStoreError, A]
    Definition Classes
    ServiceAgreementStore

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. 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()
  7. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  9. def containsAcceptedAgreement(domainId: DomainId, agreementId: ServiceAgreementId)(implicit traceContext: TraceContext): Future[Boolean]

    Check if the given agreement has been accepted for the domain.

    Check if the given agreement has been accepted for the domain.

    Definition Classes
    DbServiceAgreementStoreServiceAgreementStore
  10. def containsAgreement(domainId: DomainId, agreementId: ServiceAgreementId)(implicit traceContext: TraceContext): Future[Boolean]

    Check if the agreement has been stored already.

    Check if the agreement has been stored already.

    Definition Classes
    DbServiceAgreementStoreServiceAgreementStore
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def getAgreement(domainId: DomainId, agreementId: ServiceAgreementId)(implicit traceContext: TraceContext): EitherT[Future, ServiceAgreementStoreError, String256M]

    Get the agreement text of a stored agreement.

    Get the agreement text of a stored agreement.

    Definition Classes
    DbServiceAgreementStoreServiceAgreementStore
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def insertAcceptedAgreement(domainId: DomainId, agreementId: ServiceAgreementId)(implicit traceContext: TraceContext): EitherT[Future, ServiceAgreementStoreError, Unit]

    Store the acceptance of a previously stored agreement.

    Store the acceptance of a previously stored agreement.

    Definition Classes
    DbServiceAgreementStoreServiceAgreementStore
  17. def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  18. 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
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. 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
  21. def listAcceptedAgreements(domainId: DomainId)(implicit traceContext: TraceContext): Future[Seq[ServiceAgreementId]]

    List all accepted agreements for the domain.

    List all accepted agreements for the domain.

    Definition Classes
    DbServiceAgreementStoreServiceAgreementStore
  22. def listAgreements(implicit traceContext: TraceContext): Future[Seq[(DomainId, ServiceAgreement)]]

    List all stored agreements.

    List all stored agreements.

    Definition Classes
    DbServiceAgreementStoreServiceAgreementStore
  23. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbServiceAgreementStoreNamedLogging
  25. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  31. def performUnlessClosing[A](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.

    f

    The task to perform

    returns

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

    Definition Classes
    FlagCloseable
  32. def performUnlessClosingEitherT[E, R](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.

    etf

    The task to perform

    Definition Classes
    FlagCloseable
  33. def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    FlagCloseable
  34. def performUnlessClosingF[A](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.

    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
  35. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Definition Classes
    FlagCloseable
  36. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  37. def sleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  38. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbServiceAgreementStoreDbStore
  39. def storeAgreement(domainId: DomainId, agreementId: ServiceAgreementId, agreementText: String256M)(implicit traceContext: TraceContext): EitherT[Future, ServiceAgreementStoreError, Unit]

    Stores the agreement for the domain with the agreement text.

    Stores the agreement for the domain with the agreement text.

    Fails if the agreement has been stored already with a different text.

    Definition Classes
    DbServiceAgreementStoreServiceAgreementStore
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbServiceAgreementStoreFlagCloseable
  42. def toString(): String
    Definition Classes
    AnyRef → Any
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. 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 DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from ServiceAgreementStore

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped