case class DeferredHealthComponent(loggerFactory: NamedLoggerFactory, uninitializedName: String) extends ComponentHealth with NamedLogging with Product with Serializable
Deferred Health component, use when the health component is not instantiated at bootstrap time
- uninitializedName
name used to identify this component while it has not been initialized yet
- Self Type
- DeferredHealthComponent
- Alphabetic
- By Inheritance
- DeferredHealthComponent
- Serializable
- Product
- Equals
- NamedLogging
- ComponentHealth
- HealthElement
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DeferredHealthComponent(loggerFactory: NamedLoggerFactory, uninitializedName: String)
- uninitializedName
name used to identify this component while it has not been initialized yet
Type Members
- type HealthListener = (DeferredHealthComponent.this.type, State, TraceContext) => Unit
- Definition Classes
- HealthElement
- type State = ComponentState
- Definition Classes
- ComponentHealth → HealthElement
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
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- 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: State
Current state
Current state
- Definition Classes
- DeferredHealthComponent → ComponentHealth → HealthElement
- val initialState: ComponentState
Initial state of the component
Initial state of the component
- Attributes
- protected
- Definition Classes
- DeferredHealthComponent → ComponentHealth
- 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
- DeferredHealthComponent → ComponentHealth → HealthElement
- val listeners: AtomicReference[List[HealthListener]]
- Attributes
- protected
- Definition Classes
- HealthElement
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Definition Classes
- DeferredHealthComponent → NamedLogging
- def name: String
Name of the health element.
Name of the health element. Used for logging.
- Definition Classes
- DeferredHealthComponent → HealthElement
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def registerOnHealthChange(listener: 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
- def set(element: ComponentHealth): Unit
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val uninitializedName: String
- 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])