org.springframework.boot.actuate.couchbase

Class CouchbaseHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.couchbase.CouchbaseHealthIndicator

All Implemented Interfaces:

HealthIndicator

public class CouchbaseHealthIndicator
extends AbstractHealthIndicator

HealthIndicator for Couchbase.

Since:

2.0.0

Author:

Eddú Meléndez, Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
CouchbaseHealthIndicator(com.couchbase.client.java.Cluster cluster) Create an indicator with the specified Cluster.
CouchbaseHealthIndicator(org.springframework.data.couchbase.core.CouchbaseOperations couchbaseOperations) Deprecated. as of 2.0.5 in favour of CouchbaseHealthIndicator(CouchbaseOperations, Duration)
CouchbaseHealthIndicator(org.springframework.data.couchbase.core.CouchbaseOperations couchbaseOperations, Duration timeout) Deprecated. since 2.0.6 in favour of CouchbaseHealthIndicator(Cluster)

Method Summary

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

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

health

Methods inherited from class java.lang.Object

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

Constructor Detail

CouchbaseHealthIndicator

@Deprecated
public CouchbaseHealthIndicator(org.springframework.data.couchbase.core.CouchbaseOperations couchbaseOperations,
                                            Duration timeout)

Deprecated. since 2.0.6 in favour of CouchbaseHealthIndicator(Cluster)

Create an indicator with the specified CouchbaseOperations and timeout.

Parameters:

couchbaseOperations - the couchbase operations

timeout - the request timeout

CouchbaseHealthIndicator

@Deprecated
public CouchbaseHealthIndicator(org.springframework.data.couchbase.core.CouchbaseOperations couchbaseOperations)

Deprecated. as of 2.0.5 in favour of CouchbaseHealthIndicator(CouchbaseOperations, Duration)

Create an indicator with the specified CouchbaseOperations.

Parameters:

couchbaseOperations - the couchbase operations

CouchbaseHealthIndicator

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

Create an indicator with the specified Cluster.

Parameters:

cluster - the Couchbase Cluster

Since:

2.0.6

Method Detail

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.