Class JmsHealthIndicator
java.lang.Object
org.springframework.boot.health.contributor.AbstractHealthIndicator
org.springframework.boot.jms.health.JmsHealthIndicator
- All Implemented Interfaces:
HealthContributor, HealthIndicator
HealthIndicator for a JMS ConnectionFactory.- Since:
- 4.0.0
- Author:
- Stephane Nicoll, Venkata Naga Sai Srikanth Gollapudi
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DurationDefault timeout to use when starting a connection for the health check. -
Constructor Summary
ConstructorsConstructorDescriptionJmsHealthIndicator(ConnectionFactory connectionFactory) Create a newJmsHealthIndicatorinstance with a default start timeout.JmsHealthIndicator(ConnectionFactory connectionFactory, Duration startTimeout) Create a newJmsHealthIndicatorinstance with the givenstartTimeout. -
Method Summary
Modifier and TypeMethodDescriptionprotected voiddoHealthCheck(Health.Builder builder) Actual health check logic.Methods inherited from class AbstractHealthIndicator
healthMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface HealthIndicator
health
-
Field Details
-
DEFAULT_START_TIMEOUT
Default timeout to use when starting a connection for the health check.
-
-
Constructor Details
-
JmsHealthIndicator
Create a newJmsHealthIndicatorinstance with a default start timeout.- Parameters:
connectionFactory- the connection factory to use
-
JmsHealthIndicator
Create a newJmsHealthIndicatorinstance with the givenstartTimeout.- Parameters:
connectionFactory- the connection factory to usestartTimeout- timeout to use when starting a connection for the health check- Since:
- 4.2.0
-
-
Method Details
-
doHealthCheck
Description copied from class:AbstractHealthIndicatorActual health check logic.- Specified by:
doHealthCheckin classAbstractHealthIndicator- Parameters:
builder- theHealth.Builderto report health status and details- Throws:
Exception- anyExceptionthat should create aStatus.DOWNsystem status.
-