sealed trait Storage extends AutoCloseable with ComponentHealth
Storage resources (e.g., a database connection pool) that must be released on shutdown.
The only common functionality defined is the shutdown through AutoCloseable. Using storage objects after shutdown is unsafe; thus, they should only be closed when they're ready for garbage collection.
- Self Type
- Storage with NamedLogging
- Alphabetic
- By Inheritance
- Storage
- ComponentHealth
- HealthElement
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type HealthListener = (Storage.this, (Storage.this)#State, TraceContext) => Unit
- Definition Classes
- HealthElement
- type State = ComponentState
- Definition Classes
- ComponentHealth → HealthElement
Abstract Value Members
- abstract def close(): Unit
- Definition Classes
- AutoCloseable
- Annotations
- @throws(classOf[java.lang.Exception])
- abstract def initialState: ComponentState
Initial state of the component
Initial state of the component
- Attributes
- protected
- Definition Classes
- ComponentHealth
- abstract def isActive: Boolean
Indicates if the storage instance is active and ready to perform updates/writes.
- abstract def name: String
Name of the health element.
Name of the health element. Used for logging.
- Definition Classes
- HealthElement
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def degradationOccurred(error: String)(implicit tc: TraceContext): Unit
Report that the component is now degraded.
Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!
- Definition Classes
- ComponentHealth
- def degradationOccurred(error: CantonError)(implicit tc: TraceContext): Unit
Report that the component is now degraded.
Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!
- Definition Classes
- ComponentHealth
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def failureOccurred(error: String)(implicit tc: TraceContext): Unit
Report that the component is now failed
Report that the component is now failed
- Definition Classes
- ComponentHealth
- def failureOccurred(error: CantonError)(implicit tc: TraceContext): Unit
Report that the component is now failed
Report that the component is now failed
- Definition Classes
- ComponentHealth
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getState: ComponentState
Current state
Current state
- Definition Classes
- ComponentHealth → HealthElement
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def isFailed: Boolean
Whether the component is in a failed state.
Whether the component is in a failed state. Note: failed here means exactly _failed_, to know if the component is just unhealthy (i.e degraded or failed), use isUnhealthy.
- Definition Classes
- ComponentHealth
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNotFailed: Boolean
Returns true when the component is not in a failed state (for components, degraded is still not failed)
Returns true when the component is not in a failed state (for components, degraded is still not failed)
- Definition Classes
- ComponentHealth → HealthElement
- val listeners: AtomicReference[List[(Storage.this)#HealthListener]]
- Attributes
- protected
- Definition Classes
- HealthElement
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def registerOnHealthChange(listener: (Storage.this)#HealthListener): Unit
- Definition Classes
- HealthElement
- def reportHealthState(state: ComponentState)(implicit tc: TraceContext): Boolean
- Definition Classes
- ComponentHealth
- def reportHealthState_(state: ComponentState)(implicit tc: TraceContext): Unit
- Definition Classes
- ComponentHealth
- def resolveUnhealthy(implicit traceContext: TraceContext): Boolean
Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.
Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.
- Definition Classes
- ComponentHealth
- def resolveUnhealthy_(implicit traceContext: TraceContext): Unit
- Definition Classes
- ComponentHealth
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])