org.springframework.boot.actuate.neo4j

Class Neo4jHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.neo4j.Neo4jHealthIndicator

All Implemented Interfaces:

HealthContributor, HealthIndicator

public class Neo4jHealthIndicator
extends AbstractHealthIndicator

HealthIndicator that tests the status of a Neo4j by executing a Cypher statement.

Since:

2.0.0

Constructor Summary

Constructors

Constructor and Description
Neo4jHealthIndicator(org.neo4j.ogm.session.SessionFactory sessionFactory) Create a new Neo4jHealthIndicator using the specified SessionFactory.

Method Summary

Modifier and Type	Method and Description
protected void	doHealthCheck(Health.Builder builder) Actual health check logic.
protected void	extractResult(org.neo4j.ogm.session.Session session, Health.Builder builder) Provide health details using the specified Session and Builder.

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

Methods inherited from interface org.springframework.boot.actuate.health.HealthIndicator

getHealth

Constructor Detail

Neo4jHealthIndicator

public Neo4jHealthIndicator(org.neo4j.ogm.session.SessionFactory sessionFactory)

Create a new Neo4jHealthIndicator using the specified SessionFactory.

Parameters:

sessionFactory - the SessionFactory

Method Detail

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws java.lang.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:

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

extractResult

protected void extractResult(org.neo4j.ogm.session.Session session,
                             Health.Builder builder)
                      throws java.lang.Exception

Provide health details using the specified Session and Builder.

Parameters:

session - the session to use to execute a cypher statement

builder - the builder to add details to

Throws:

java.lang.Exception - if getting health details failed