org.springframework.boot.availability

Class LivenessStateChangedEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.boot.availability.LivenessStateChangedEvent

All Implemented Interfaces:

Serializable

public class LivenessStateChangedEvent
extends ApplicationEvent

ApplicationEvent sent when the LivenessState of the application changes.

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

Since:

2.3.0

Author:

Brian Clozel

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Method Summary

Modifier and Type	Method and Description
static LivenessStateChangedEvent	broken(String cause) Create a new ApplicationEvent signaling that the LivenessState is broken.
static LivenessStateChangedEvent	broken(Throwable throwable) Create a new ApplicationEvent signaling that the LivenessState is broken.
LivenessState	getLivenessState()
static LivenessStateChangedEvent	live(String cause) Create a new ApplicationEvent signaling that the LivenessState is live.

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getLivenessState

public LivenessState getLivenessState()

live

public static LivenessStateChangedEvent live(String cause)

Create a new ApplicationEvent signaling that the LivenessState is live.

Parameters:

cause - the cause of the live internal state of the application

Returns:

the application event

broken

public static LivenessStateChangedEvent broken(String cause)

Create a new ApplicationEvent signaling that the LivenessState is broken.

Parameters:

cause - the cause of the broken internal state of the application

Returns:

the application event

broken

public static LivenessStateChangedEvent broken(Throwable throwable)

Create a new ApplicationEvent signaling that the LivenessState is broken.

Parameters:

throwable - the exception that caused the broken internal state of the application

Returns:

the application event