diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/AbstractHealthIndicator.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/AbstractHealthIndicator.java new file mode 100644 index 00000000000..c5abc45dfaf --- /dev/null +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/AbstractHealthIndicator.java @@ -0,0 +1,51 @@ +/* + * Copyright 2012-2014 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.actuate.health; + +/** + * Base {@link HealthIndicator} implementations that encapsulates creation of + * {@link Health} instance and error handling. + * + *
+ * This implementation is only suitable if an {@link Exception} raised from
+ * {@link #doHealthCheck(Health)} should create a {@link Status#DOWN} health status.
+ *
+ * @author Christian Dupuis
+ * @since 1.1.0
+ */
+public abstract class AbstractHealthIndicator implements HealthIndicator {
+
+ @Override
+ public final Health health() {
+ Health health = new Health();
+ try {
+ doHealthCheck(health);
+ }
+ catch (Exception ex) {
+ health.down().withException(ex);
+ }
+ return health;
+ }
+
+ /**
+ * Actual health check logic.
+ * @param health {@link Health} instance of report status.
+ * @throws Exception any {@link Exception} that should create a {@link Status#DOWN}
+ * system status.
+ */
+ protected abstract void doHealthCheck(Health health) throws Exception;
+}
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/MongoHealthIndicator.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/MongoHealthIndicator.java
index 729ff1ce52e..c9d099d60cc 100644
--- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/MongoHealthIndicator.java
+++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/MongoHealthIndicator.java
@@ -28,7 +28,7 @@ import com.mongodb.CommandResult;
* @author Christian Dupuis
* @since 1.1.0
*/
-public class MongoHealthIndicator implements HealthIndicator {
+public class MongoHealthIndicator extends AbstractHealthIndicator {
private final MongoTemplate mongoTemplate;
@@ -38,17 +38,9 @@ public class MongoHealthIndicator implements HealthIndicator {
}
@Override
- public Health health() {
- Health health = new Health();
- try {
- CommandResult result = this.mongoTemplate
- .executeCommand("{ serverStatus: 1 }");
- health.up().withDetail("version", result.getString("version"));
- }
- catch (Exception ex) {
- health.down().withException(ex);
- }
- return health;
+ protected void doHealthCheck(Health health) throws Exception {
+ CommandResult result = this.mongoTemplate.executeCommand("{ serverStatus: 1 }");
+ health.up().withDetail("version", result.getString("version"));
}
}
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/RabbitHealthIndicator.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/RabbitHealthIndicator.java
index 366475cd4ca..fd6a0efe93c 100644
--- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/RabbitHealthIndicator.java
+++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/RabbitHealthIndicator.java
@@ -31,7 +31,7 @@ import com.rabbitmq.client.Channel;
* @author Christian Dupuis
* @since 1.1.0
*/
-public class RabbitHealthIndicator implements HealthIndicator {
+public class RabbitHealthIndicator extends AbstractHealthIndicator {
private final RabbitTemplate rabbitTemplate;
@@ -41,23 +41,17 @@ public class RabbitHealthIndicator implements HealthIndicator {
}
@Override
- public Health health() {
- Health health = new Health();
- try {
- health.up().withDetail("version",
- this.rabbitTemplate.execute(new ChannelCallback