This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new c441098 CAMEL-15081: Polished
c441098 is described below
commit c4410982ad53ff9b00b83107cb6d0365988fe714
Author: Claus Ibsen
AuthorDate: Tue May 26 13:25:48 2020 +0200
CAMEL-15081: Polished
---
.../java/org/apache/camel/health/HealthCheck.java | 10 --
.../org/apache/camel/health/HealthCheckFilter.java | 1 +
.../apache/camel/health/HealthCheckRepository.java | 1 +
.../camel/health/HealthCheckResultBuilder.java | 2 +-
.../org/apache/camel/health/HealthCheckService.java | 3 ++-
.../impl/health/DefaultHealthCheckService.java | 21 +++--
.../impl/health/RoutesHealthCheckRepository.java| 4 +---
.../impl/health/DefaultHealthCheckServiceTest.java | 3 +--
8 files changed, 18 insertions(+), 27 deletions(-)
diff --git
a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheck.java
b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheck.java
index 6e037cb..d98dc01 100644
--- a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheck.java
+++ b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheck.java
@@ -24,7 +24,11 @@ import org.apache.camel.Ordered;
import org.apache.camel.spi.HasGroup;
import org.apache.camel.spi.HasId;
+/**
+ * Health check
+ */
public interface HealthCheck extends HasGroup, HasId, Ordered {
+
enum State {
UP,
DOWN,
@@ -51,14 +55,16 @@ public interface HealthCheck extends HasGroup, HasId,
Ordered {
/**
* Invoke the check.
*
- * @see {@link #call(Map)}
+ * @see #call(Map)
*/
default Result call() {
return call(Collections.emptyMap());
}
/**
- * Invoke the check. The implementation is responsible to eventually
perform
+ * Invoke the check.
+ *
+ * The implementation is responsible to eventually perform
* the check according to the limitation of the third party system i.e.
* it should not be performed too often to avoid rate limiting. The options
* argument can be used to pass information specific to the check like
diff --git
a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckFilter.java
b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckFilter.java
index 88857d1..e9d5367 100644
---
a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckFilter.java
+++
b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckFilter.java
@@ -21,6 +21,7 @@ package org.apache.camel.health;
*/
@FunctionalInterface
public interface HealthCheckFilter {
+
/**
* Determine if the given {@link HealthCheck} has to be filtered out.
*
diff --git
a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckRepository.java
b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckRepository.java
index 680b7ed..39fdf75 100644
---
a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckRepository.java
+++
b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckRepository.java
@@ -22,6 +22,7 @@ import java.util.stream.Stream;
* A repository for health checks.
*/
public interface HealthCheckRepository {
+
/**
* Returns a sequential {@code Stream} with the known {@link HealthCheck}
* as its source.
diff --git
a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckResultBuilder.java
b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckResultBuilder.java
index 39e8c7d..6349fde 100644
---
a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckResultBuilder.java
+++
b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckResultBuilder.java
@@ -25,7 +25,7 @@ import org.apache.camel.Builder;
import org.apache.camel.util.ObjectHelper;
/**
- * A builder helper to create a result.
+ * A builder helper to create a {@link HealthCheck} result.
*/
public final class HealthCheckResultBuilder implements
Builder {
private HealthCheck check;
diff --git
a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckService.java
b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckService.java
index 3e1e3f9..b3e12a6 100644
---
a/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckService.java
+++
b/core/camel-api/src/main/java/org/apache/camel/health/HealthCheckService.java
@@ -30,6 +30,7 @@ import org.apache.camel.Service;
* according to a schedule.
*/
public interface HealthCheckService extends Service, CamelContextAware {
+
/**
* Add a listener to invoke when the state of a check change.
*
@@ -54,7 +55,7 @@ public interface HealthCheckService extends Service,
CamelContextAware {
void setHealthCheckOptions(String id, Map