Class CouchbaseHealthIndicator

java.lang.Object

org.springframework.boot.health.contributor.AbstractHealthIndicator

org.springframework.boot.couchbase.health.CouchbaseHealthIndicator

All Implemented Interfaces:

HealthContributor, HealthIndicator

public class CouchbaseHealthIndicator
extends AbstractHealthIndicator

HealthIndicator for Couchbase.

Since:

4.0.0

Author:

Eddú Meléndez, Stephane Nicoll

Constructor Summary

Constructors

Constructor	Description
CouchbaseHealthIndicator(com.couchbase.client.java.Cluster cluster)	Create an indicator with the specified Cluster.

Method Summary

Modifier and Type	Method	Description
protected void	doHealthCheck(Health.Builder builder)	Actual health check logic.

Methods inherited from class org.springframework.boot.health.contributor.AbstractHealthIndicator

health

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.health.contributor.HealthIndicator

health

Constructor Details

CouchbaseHealthIndicator

public CouchbaseHealthIndicator(com.couchbase.client.java.Cluster cluster)

Create an indicator with the specified Cluster.

Parameters:

cluster - the Couchbase Cluster

Method Details

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws Exception

Description copied from class: AbstractHealthIndicator

Actual health check logic.

Specified by:

doHealthCheck in class AbstractHealthIndicator

Parameters:

builder - the Health.Builder to report health status and details

Throws:

Exception - any Exception that should create a Status.DOWN system status.