spring-boot/org.springframework.boot.availability/AvailabilityChangeEvent

AvailabilityChangeEvent

open class AvailabilityChangeEvent<S : AvailabilityState?> : PayloadApplicationEvent<T>

ApplicationEvent sent when the AvailabilityState of the application changes.

Any application component can send such events to update the state of the application.

Author

Brian Clozel

Phillip Webb

Since

2.3.0

Parameters

<S>

the availability state type

Constructors

AvailabilityChangeEvent

constructor(source: Any, state: S)

Create a new AvailabilityChangeEvent instance.

Properties

val timestamp: Long

Functions

getResolvableType

open fun getResolvableType(): ResolvableType

open fun getSource(): Any

open fun getState(): S

Return the changed availability state.

open fun <S : AvailabilityState?> publish(context: ApplicationContext, state: S)

open fun <S : AvailabilityState?> publish(publisher: ApplicationEventPublisher, source: Any, state: S)

Convenience method that can be used to publish an AvailabilityChangeEvent to the given application context.

open fun toString(): String