c

com.digitalasset.canton.participant.store.db

DbSynchronizerConnectionConfigStore

class DbSynchronizerConnectionConfigStore extends SynchronizerConnectionConfigStore with DbStore

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

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. val aliasResolution: SynchronizerAliasResolution
  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]) @IntrinsicCandidate() @native()
  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. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  11. implicit val ec: ExecutionContext
  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. def get(psid: PhysicalSynchronizerId): Either[UnknownPSId, StoredSynchronizerConnectionConfig]

    Retrieves the config for a given id.

    Retrieves the config for a given id. Will return an SynchronizerConnectionConfigStore.UnknownPSId error if there is no config for id.

    Definition Classes
    DbSynchronizerConnectionConfigStoreSynchronizerConnectionConfigStore
  16. def get(alias: SynchronizerAlias, configuredPSId: ConfiguredPhysicalSynchronizerId): Either[MissingConfigForSynchronizer, StoredSynchronizerConnectionConfig]

    Retrieves the config for a given alias and id.

    Retrieves the config for a given alias and id. Will return an SynchronizerConnectionConfigStore.MissingConfigForSynchronizer error if there is no config for the pair (alias, id).

    Definition Classes
    DbSynchronizerConnectionConfigStoreSynchronizerConnectionConfigStore
  17. def getActive(id: SynchronizerId): Either[Error, StoredSynchronizerConnectionConfig]

    Retrieves the active connection for id.

    Retrieves the active connection for id. Return an SynchronizerConnectionConfigStore.Error if the id is unknown or if no connection is active. If several active configs are found, return the one with the highest com.digitalasset.canton.topology.PhysicalSynchronizerId.

    Definition Classes
    SynchronizerConnectionConfigStore
  18. def getActive(alias: SynchronizerAlias): Either[Error, StoredSynchronizerConnectionConfig]

    Retrieves the active connection for alias.

    Retrieves the active connection for alias. Return an SynchronizerConnectionConfigStore.Error if the alias is unknown or if no connection is active. If several active configs are found, return the one with the highest com.digitalasset.canton.topology.PhysicalSynchronizerId.

    Definition Classes
    SynchronizerConnectionConfigStore
  19. def getAll(): Seq[StoredSynchronizerConnectionConfig]

    Retrieves all configured synchronizers connection configs

    Retrieves all configured synchronizers connection configs

    Definition Classes
    DbSynchronizerConnectionConfigStoreSynchronizerConnectionConfigStore
  20. def getAllFor(alias: SynchronizerAlias): Either[UnknownAlias, NonEmpty[Seq[StoredSynchronizerConnectionConfig]]]
  21. def getAllFor(id: SynchronizerId): Either[UnknownId, NonEmpty[Seq[StoredSynchronizerConnectionConfig]]]
  22. def getAllForAliasInternal(alias: SynchronizerAlias)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[StoredSynchronizerConnectionConfig]]
  23. def getAllStatusesFor(id: SynchronizerId): Either[UnknownId, NonEmpty[Seq[Status]]]
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  26. 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
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. 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
  29. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbSynchronizerConnectionConfigStoreNamedLogging
  31. 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
  32. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  33. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  38. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  39. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  40. 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
  41. def predecessorCompatibilityCheck(configuredPSId: ConfiguredPhysicalSynchronizerId, synchronizerPredecessor: Option[SynchronizerPredecessor]): Either[Error, Unit]

    Ensures a configured PSId can be the successor of another one.

    Ensures a configured PSId can be the successor of another one.

    Attributes
    protected
    Definition Classes
    SynchronizerConnectionConfigStore
  42. def put(config: SynchronizerConnectionConfig, status: Status, configuredPSId: ConfiguredPhysicalSynchronizerId, synchronizerPredecessor: Option[SynchronizerPredecessor])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, Error, Unit]

    Stores a synchronizer connection config together with the status.

    Stores a synchronizer connection config together with the status. Primary identifier is the (synchronizer alias, physical synchronizer id). Will return an SynchronizerConnectionConfigStore.ConfigAlreadyExists error if a config for that alias and physical synchronizer id already exists.

    Definition Classes
    DbSynchronizerConnectionConfigStoreSynchronizerConnectionConfigStore
  43. def refreshCache()(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    Dump and refresh all connection configs.

    Dump and refresh all connection configs. Used when a warm participant replica becomes active to ensure it has accurate configs cached.

    Definition Classes
    DbSynchronizerConnectionConfigStoreSynchronizerConnectionConfigStore
  44. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  45. 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
  46. def replace(configuredPSId: ConfiguredPhysicalSynchronizerId, config: SynchronizerConnectionConfig)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, Error, Unit]

    Replaces the config for the given alias and physical synchronizer id.

    Replaces the config for the given alias and physical synchronizer id. Will return an SynchronizerConnectionConfigStore.MissingConfigForSynchronizer error if there is no config for the (alias, physicalSynchronizerId).

    Definition Classes
    DbSynchronizerConnectionConfigStoreSynchronizerConnectionConfigStore
  47. 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
  48. 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
  49. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

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

  50. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  51. def setPhysicalSynchronizerId(alias: SynchronizerAlias, psid: PhysicalSynchronizerId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, Error, Unit]
  52. def setStatus(alias: SynchronizerAlias, configuredPSId: ConfiguredPhysicalSynchronizerId, status: Status)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, Error, Unit]

    Set the synchronizer configuration status

    Set the synchronizer configuration status

    Definition Classes
    DbSynchronizerConnectionConfigStoreSynchronizerConnectionConfigStore
  53. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbSynchronizerConnectionConfigStoreDbStore
  54. 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

  55. 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
  56. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  57. 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

  58. 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

  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
    DbSynchronizerConnectionConfigStoreFlagCloseable
  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. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. 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 AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped