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.

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

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

Removes a shutdown task from the list using a token returned by runOnShutdown

Blocks until all earlier tasks have completed and then prevents further tasks from being run.

The state set when the associatedOnShutdownRunner closes

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

Decrypts an encrypted message using the referenced private encryption key

Generates a new encryption key pair with the given scheme and optional name, stores the private key and returns the public key.

Generates a new signing key pair with the given scheme and optional name, stores the private key and returns the public key.

Returns the current state

The initial state upon creation

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.

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.

How often to poll to check that all tasks have completed.

Name of the health element. Used for logging.

Blocks until all earlier tasks have completed and then prevents further tasks from being run.

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.

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.

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.

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.

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

This function and registerEncryptionKey is used to register a key directly to the store (i.e. pre-generated) and bypass the default key generation procedure. As we are overriding the usual way to create new keys, by using pre-generated ones, we need to add their public material to a node's public store.

Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

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

Signs the byte string directly, however it is encouraged to sign a hash.

Signs the given hash using the referenced private signing key.

Unregisters a listener.