ApplicationAvailabilityBean (spring-boot 3.1.8)

java.lang.Object

org.springframework.boot.availability.ApplicationAvailabilityBean

All Implemented Interfaces:: EventListener, ApplicationAvailability, org.springframework.context.ApplicationListener<AvailabilityChangeEvent<?>>

public class ApplicationAvailabilityBean extends Object implements ApplicationAvailability, org.springframework.context.ApplicationListener<AvailabilityChangeEvent<?>>

Bean that provides an ApplicationAvailability implementation by listening for change events.

Since:

2.3.0

See Also:

ApplicationAvailability

Constructor Summary

Constructors

Constructor

Description

ApplicationAvailabilityBean()
Method Summary

Modifier and Type

Method

Description

<S extends AvailabilityState> AvailabilityChangeEvent<S>

getLastChangeEvent(Class<S> stateType)

Return the last AvailabilityChangeEvent received for a given state type.

<S extends AvailabilityState> S

getState(Class<S> stateType)

Return AvailabilityState information for the application.

<S extends AvailabilityState> S

getState(Class<S> stateType, S defaultState)

Return AvailabilityState information for the application.

void

onApplicationEvent(AvailabilityChangeEvent<?> event)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.boot.availability.ApplicationAvailability
getLivenessState, getReadinessState

Constructor Details
- ApplicationAvailabilityBean
  
  public ApplicationAvailabilityBean()
Method Details
- getState
  
  public <S extends AvailabilityState> S getState(Class<S> stateType, S defaultState)
  
  Description copied from interface: ApplicationAvailability
  
  Return AvailabilityState information for the application.
  Specified by:
  
  getState in interface ApplicationAvailability
  
  Type Parameters:
  
  S - the state type
  
  Parameters:
  
  stateType - the state type
  
  defaultState - the default state to return if no event of the given type has been published yet (must not be null).
  
  Returns:
  
  the readiness state
  
  See Also:
  
  ApplicationAvailability.getState(Class)
- getState
  
  public <S extends AvailabilityState> S getState(Class<S> stateType)
  
  Description copied from interface: ApplicationAvailability
  
  Return AvailabilityState information for the application.
  Specified by:
  
  getState in interface ApplicationAvailability
  
  Type Parameters:
  
  S - the state type
  
  Parameters:
  
  stateType - the state type
  
  Returns:
  
  the readiness state or null if no event of the given type has been published yet
  
  See Also:
  
  ApplicationAvailability.getState(Class, AvailabilityState)
- getLastChangeEvent
  
  public <S extends AvailabilityState> AvailabilityChangeEvent<S> getLastChangeEvent(Class<S> stateType)
  
  Description copied from interface: ApplicationAvailability
  
  Return the last AvailabilityChangeEvent received for a given state type.
  
  Specified by:
  
  getLastChangeEvent in interface ApplicationAvailability
  
  Type Parameters:
  
  S - the state type
  
  Parameters:
  
  stateType - the state type
  
  Returns:
  
  the readiness state or null if no event of the given type has been published yet
- onApplicationEvent
  
  public void onApplicationEvent(AvailabilityChangeEvent<?> event)
  
  Specified by:
  
  onApplicationEvent in interface org.springframework.context.ApplicationListener<AvailabilityChangeEvent<?>>

Class ApplicationAvailabilityBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.boot.availability.ApplicationAvailability

Constructor Details

ApplicationAvailabilityBean

Method Details

getState

getState

getLastChangeEvent

onApplicationEvent