Packages

class Crypto extends BaseCrypto with CloseableHealthElement with CompositeHealthElement[String, HealthQuasiComponent] with HealthComponent

Wrapper class to simplify crypto dependency management. It does not validate crypto schemes against the static synchronizer parameters.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Crypto
  2. HealthComponent
  3. HealthQuasiComponent
  4. CompositeHealthElement
  5. CloseableHealthElement
  6. HealthElement
  7. FlagCloseable
  8. PerformUnlessClosing
  9. HasSynchronizeWithReaders
  10. HasSynchronizeWithClosing
  11. OnShutdownRunner
  12. HasRunOnClosing
  13. HasUnlessClosing
  14. AutoCloseable
  15. BaseCrypto
  16. NamedLogging
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type State = ComponentHealthState

    The type of health states exposed by this component

    The type of health states exposed by this component

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement

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 alterDependencies(remove: Set[String], add: Map[String, HealthQuasiComponent]): Unit

    First removes all dependencies in remove, then adds all those in add.

    First removes all dependencies in remove, then adds all those in add. If an ID appears in remove and add, then the ID is replaced. Refreshes the state if any of the dependencies was changed.

    Updates of dependencies are not atomic: If this method is called concurrently multiple times, the resulting dependencies may not correspond to a serializable execution.

    If an dependency triggers a concurrent state refresh, then the state refresh may see an inconsistent set of dependencies and therefore derive an inconsistent state. This however is only temporary as in this case another state refresh will be triggered at the end.

    Attributes
    protected
    Definition Classes
    CompositeHealthElement
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def associatedHasRunOnClosing: FlagCloseable

    The com.digitalasset.canton.lifecycle.HasRunOnClosing associated with this object.

    The com.digitalasset.canton.lifecycle.HasRunOnClosing associated with this object.

    When this com.digitalasset.canton.lifecycle.HasRunOnClosing closes, the health state permanently becomes closingState and all listeners are notified about this.

    Attributes
    protected
    Definition Classes
    CloseableHealthElementHealthElement
  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. def closingState: ComponentHealthState

    The state set when the associatedHasRunOnClosing closes

    The state set when the associatedHasRunOnClosing closes

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement
  11. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  12. def combineDependentStates: ComponentHealthState

    Fetch the current states from the relevant dependencies and combine them into the new state to report for this element.

    Fetch the current states from the relevant dependencies and combine them into the new state to report for this element.

    Attributes
    protected
    Definition Classes
    CryptoCompositeHealthElement
  13. val cryptoPrivateStore: CryptoPrivateStore
    Definition Classes
    CryptoBaseCrypto
  14. val cryptoPublicStore: CryptoPublicStore
    Definition Classes
    CryptoBaseCrypto
  15. implicit val ec: ExecutionContext
    Definition Classes
    CryptoBaseCrypto
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  19. def generateEncryptionKey(keySpec: EncryptionKeySpec = privateCrypto.encryptionKeySpecs.default, name: Option[KeyName] = None)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, EncryptionKeyGenerationError, EncryptionPublicKey]

    Helper method to generate a new encryption key pair and store the public key in the public store as well.

    Helper method to generate a new encryption key pair and store the public key in the public store as well.

    Definition Classes
    BaseCrypto
  20. def generateSigningKey(keySpec: SigningKeySpec = privateCrypto.signingKeySpecs.default, usage: NonEmpty[Set[SigningKeyUsage]], name: Option[KeyName] = None)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SigningKeyGenerationError, SigningPublicKey]

    Helper method to generate a new signing key pair and store the public key in the public store as well.

    Helper method to generate a new signing key pair and store the public key in the public store as well.

    Definition Classes
    BaseCrypto
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  22. def getDependencies: Map[String, HealthQuasiComponent]
    Attributes
    protected
    Definition Classes
    CompositeHealthElement
  23. final def getState: State

    Returns the current state

    Returns the current state

    Definition Classes
    HealthElement
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  25. def initialHealthState: ComponentHealthState

    The initial state upon creation

    The initial state upon creation

    Attributes
    protected
    Definition Classes
    CryptoHealthElement
  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. def isDegraded: Boolean
    Definition Classes
    HealthQuasiComponent
  28. def isFailed: Boolean
    Definition Classes
    HealthQuasiComponent
  29. def isFatal: Boolean
    Definition Classes
    HealthQuasiComponent
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isOk: Boolean
    Definition Classes
    HealthQuasiComponent
  32. 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
  33. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  34. val loggerFactory: NamedLoggerFactory
    Definition Classes
    CryptoNamedLogging
  35. def name: String

    Name of the health element.

    Name of the health element. Used for logging.

    Definition Classes
    CryptoHealthElement
  36. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  37. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  42. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  43. def onClosed(): Unit
    Definition Classes
    CryptoPerformUnlessClosing
  44. 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
  45. def prettyState: Pretty[State]
    Attributes
    protected
    Definition Classes
    HealthQuasiComponentHealthElement
  46. val privateCrypto: CryptoPrivateApi
    Definition Classes
    CryptoBaseCrypto
  47. val pureCrypto: CryptoPureApi
    Definition Classes
    CryptoBaseCrypto
  48. def refreshFromDependencies()(implicit traceContext: TraceContext): Unit
    Attributes
    protected
    Definition Classes
    CompositeHealthElement
  49. def refreshState(newState: Eval[State])(implicit traceContext: TraceContext): Unit

    Triggers a refresh of the component's state, using newState to determine the new state.

    Triggers a refresh of the component's state, using newState to determine the new state. May return before the newState has been evaluated and the listeners have been poked.

    Note that listeners need not be poked about every state change; it suffices that they are poked eventually after each state change. So if there are frequent updates to the state, possibly from concurrent calls, then the listeners may never see some intermediate states.

    Attributes
    protected
    Definition Classes
    HealthElement
  50. def registerHighPriorityOnHealthChange(listener: HealthListener): Boolean

    Registers a high priority listener that gets poked upon each change of this element's health state.

    Registers a high priority listener that gets poked upon each change of this element's health state. This listener will be run before listeners registered via registerOnHealthChange

    returns

    Whether the listener was not registered before

    Definition Classes
    HealthElement
  51. def registerOnHealthChange(listener: HealthListener, pokeIfNew: Boolean = true): Boolean

    Registers a listener that gets poked upon each change of this element's health state.

    Registers a listener that gets poked upon each change of this element's health state.

    pokeIfNew

    if true (default), poke the listener if it's new

    returns

    Whether the listener was not registered before

    Definition Classes
    HealthElement
  52. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  53. def removeDependency(id: String): Unit
    Attributes
    protected
    Definition Classes
    CompositeHealthElement
  54. 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
  55. 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
  56. 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
  57. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

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

  58. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  59. def setDependency(id: String, dependency: HealthQuasiComponent): Unit
    Attributes
    protected
    Definition Classes
    CompositeHealthElement
  60. def stateLoggingLevel(state: ComponentHealthState): Level
    Attributes
    protected
    Definition Classes
    HealthComponentHealthElement
  61. 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

  62. 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
  63. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  64. 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

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

  66. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  67. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  68. val timeouts: ProcessingTimeout
    Definition Classes
    CryptoFlagCloseable
  69. def toComponentStatus: ComponentStatus
    Definition Classes
    HealthQuasiComponent
  70. def toString(): String
    Definition Classes
    AnyRef → Any
  71. 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()
  72. def unregisterOnHealthChange(listener: HealthListener): Boolean

    Unregisters a listener.

    Unregisters a listener.

    returns

    Whether the listener was registered before.

    Definition Classes
    HealthElement
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  75. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  76. 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 HealthComponent

Inherited from HealthQuasiComponent

Inherited from CloseableHealthElement

Inherited from HealthElement

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from BaseCrypto

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped