[sling-org-apache-sling-hc-api] branch master updated: SLING-7980 Deprecated Health Check API (with link to migration instructions to Felix Health Checks)

[gh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ghenzler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-hc-api.git


The following commit(s) were added to refs/heads/master by this push:
     new fdec4a8  SLING-7980 Deprecated Health Check API (with link to migration instructions to Felix Health Checks)
fdec4a8 is described below

commit fdec4a8999284d860a35acf11631f454d54e147e
Author: georg.henzler <ge...@netcentric.biz>
AuthorDate: Fri Mar 29 23:15:32 2019 +0100

    SLING-7980 Deprecated Health Check API
    (with link to migration instructions to Felix Health Checks)
---
 src/main/java/org/apache/sling/hc/api/HealthCheck.java  | 17 ++++++++---------
 src/main/java/org/apache/sling/hc/api/Result.java       |  1 +
 src/main/java/org/apache/sling/hc/api/ResultLog.java    |  1 +
 .../hc/api/execution/HealthCheckExecutionOptions.java   |  1 +
 .../hc/api/execution/HealthCheckExecutionResult.java    |  1 +
 .../sling/hc/api/execution/HealthCheckExecutor.java     |  1 +
 .../sling/hc/api/execution/HealthCheckSelector.java     |  7 +++----
 .../org/apache/sling/hc/util/FormattingResultLog.java   |  1 +
 .../org/apache/sling/hc/util/HealthCheckFilter.java     |  7 ++++---
 .../org/apache/sling/hc/util/HealthCheckMetadata.java   |  1 +
 .../apache/sling/hc/util/SimpleConstraintChecker.java   |  1 +
 11 files changed, 23 insertions(+), 16 deletions(-)

diff --git a/src/main/java/org/apache/sling/hc/api/HealthCheck.java b/src/main/java/org/apache/sling/hc/api/HealthCheck.java
index f32b483..6044c52 100644
--- a/src/main/java/org/apache/sling/hc/api/HealthCheck.java
+++ b/src/main/java/org/apache/sling/hc/api/HealthCheck.java
@@ -19,18 +19,17 @@ package org.apache.sling.hc.api;
 
 import org.osgi.annotation.versioning.ConsumerType;
 
-/**
- * Health Check services can be executed and
- * return an execution {@link Result}.
+/** Health Check services can be executed and return an execution {@link Result}.
  *
- * Clients should not look up health checks directly but
- * rather use the {@link org.apache.sling.hc.api.execution.HealthCheckExecutor}
+ * Clients should not look up health checks directly but rather use the {@link org.apache.sling.hc.api.execution.HealthCheckExecutor}
  * service and executed checks based on tags.
  *
- * If the {@link #MBEAN_NAME} service registration property is set,
- * the health check is registered as an mbean and can be invoked
- * by getting the MBean from the JMX registry.
- */
+ * If the {@link #MBEAN_NAME} service registration property is set, the health check is registered as an mbean and can be invoked by getting
+ * the MBean from the JMX registry.
+ * 
+ * @deprecated Use Apache Felix Health Checks now, see {@link https://sling.apache.org/documentation/bundles/sling-health-check-tool.html}
+ *             for migration guide. */
+@Deprecated
 @ConsumerType
 public interface HealthCheck {
 
diff --git a/src/main/java/org/apache/sling/hc/api/Result.java b/src/main/java/org/apache/sling/hc/api/Result.java
index 85e4153..a03c039 100644
--- a/src/main/java/org/apache/sling/hc/api/Result.java
+++ b/src/main/java/org/apache/sling/hc/api/Result.java
@@ -20,6 +20,7 @@ package org.apache.sling.hc.api;
 import java.util.Iterator;
 
 /** The result of executing a {@link HealthCheck} */
+@Deprecated
 public class Result implements Iterable <ResultLog.Entry> {
 
     protected final ResultLog resultLog;
diff --git a/src/main/java/org/apache/sling/hc/api/ResultLog.java b/src/main/java/org/apache/sling/hc/api/ResultLog.java
index a5f1d0e..1844be3 100644
--- a/src/main/java/org/apache/sling/hc/api/ResultLog.java
+++ b/src/main/java/org/apache/sling/hc/api/ResultLog.java
@@ -26,6 +26,7 @@ import org.apache.sling.hc.api.Result.Status;
 
 /** The log of a Result, allows for providing multiple lines
  *  of information which are aggregated as a single Result. */
+@Deprecated
 public class ResultLog implements Iterable<ResultLog.Entry> {
 
     private List<Entry> entries = new LinkedList<Entry>();
diff --git a/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutionOptions.java b/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutionOptions.java
index 460323d..79d1fcb 100644
--- a/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutionOptions.java
+++ b/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutionOptions.java
@@ -19,6 +19,7 @@ package org.apache.sling.hc.api.execution;
 
 
 /** Options for behavior of health check execution. */
+@Deprecated
 public class HealthCheckExecutionOptions {
 
     private boolean forceInstantExecution = false;
diff --git a/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutionResult.java b/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutionResult.java
index 0f8ecd7..e8b28b8 100644
--- a/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutionResult.java
+++ b/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutionResult.java
@@ -30,6 +30,7 @@ import org.osgi.annotation.versioning.ProviderType;
  * If the execution of the health check timed out, the method
  *
  */
+@Deprecated
 @ProviderType
 public interface HealthCheckExecutionResult {
 
diff --git a/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutor.java b/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutor.java
index 4cab49c..2083f8e 100644
--- a/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutor.java
+++ b/src/main/java/org/apache/sling/hc/api/execution/HealthCheckExecutor.java
@@ -28,6 +28,7 @@ import org.osgi.annotation.versioning.ProviderType;
  * implementing the interface {@link HealthCheck}.
  *
  */
+@Deprecated
 @ProviderType
 public interface HealthCheckExecutor {
 
diff --git a/src/main/java/org/apache/sling/hc/api/execution/HealthCheckSelector.java b/src/main/java/org/apache/sling/hc/api/execution/HealthCheckSelector.java
index 362d817..5bd59b3 100644
--- a/src/main/java/org/apache/sling/hc/api/execution/HealthCheckSelector.java
+++ b/src/main/java/org/apache/sling/hc/api/execution/HealthCheckSelector.java
@@ -16,15 +16,14 @@
  */
 package org.apache.sling.hc.api.execution;
 
-import org.apache.sling.hc.api.HealthCheck;
-import org.apache.sling.hc.util.HealthCheckFilter;
-import org.osgi.annotation.versioning.ProviderType;
-
 import java.util.Arrays;
 
+import org.osgi.annotation.versioning.ProviderType;
+
 /**
  * Parameter class to pass a set of tags and names to the filter.
  */
+@Deprecated
 @ProviderType
 public final class HealthCheckSelector {
 
diff --git a/src/main/java/org/apache/sling/hc/util/FormattingResultLog.java b/src/main/java/org/apache/sling/hc/util/FormattingResultLog.java
index 2493722..852b163 100644
--- a/src/main/java/org/apache/sling/hc/util/FormattingResultLog.java
+++ b/src/main/java/org/apache/sling/hc/util/FormattingResultLog.java
@@ -26,6 +26,7 @@ import org.osgi.annotation.versioning.ProviderType;
 import org.slf4j.helpers.MessageFormatter;
 
 /** Utility that provides a logging-like facade on a ResultLog */
+@Deprecated
 @ProviderType
 public class FormattingResultLog extends ResultLog {
     
diff --git a/src/main/java/org/apache/sling/hc/util/HealthCheckFilter.java b/src/main/java/org/apache/sling/hc/util/HealthCheckFilter.java
index c851a66..c54846a 100644
--- a/src/main/java/org/apache/sling/hc/util/HealthCheckFilter.java
+++ b/src/main/java/org/apache/sling/hc/util/HealthCheckFilter.java
@@ -17,6 +17,9 @@
  */
 package org.apache.sling.hc.util;
 
+import static org.apache.sling.hc.api.execution.HealthCheckSelector.empty;
+import static org.apache.sling.hc.api.execution.HealthCheckSelector.tags;
+
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -33,9 +36,6 @@ import org.osgi.framework.ServiceReference;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import static org.apache.sling.hc.api.execution.HealthCheckSelector.tags;
-import static org.apache.sling.hc.api.execution.HealthCheckSelector.empty;
-
 /**
  * Select from available {@link HealthCheck} services.
  * Once this filter object and the returned health check services are no longer
@@ -45,6 +45,7 @@ import static org.apache.sling.hc.api.execution.HealthCheckSelector.empty;
  * This class is not thread safe and instances shouldn't be used concurrently
  * from different threads.
  */
+@Deprecated
 @ProviderType
 public class HealthCheckFilter {
 
diff --git a/src/main/java/org/apache/sling/hc/util/HealthCheckMetadata.java b/src/main/java/org/apache/sling/hc/util/HealthCheckMetadata.java
index f996652..7d582e9 100644
--- a/src/main/java/org/apache/sling/hc/util/HealthCheckMetadata.java
+++ b/src/main/java/org/apache/sling/hc/util/HealthCheckMetadata.java
@@ -30,6 +30,7 @@ import org.osgi.framework.ServiceReference;
  * This class helps retrieving meta data information about a health check service.
  * @since 1.1
  */
+@Deprecated
 @ProviderType
 public class HealthCheckMetadata {
 
diff --git a/src/main/java/org/apache/sling/hc/util/SimpleConstraintChecker.java b/src/main/java/org/apache/sling/hc/util/SimpleConstraintChecker.java
index b506840..0f17b4d 100644
--- a/src/main/java/org/apache/sling/hc/util/SimpleConstraintChecker.java
+++ b/src/main/java/org/apache/sling/hc/util/SimpleConstraintChecker.java
@@ -24,6 +24,7 @@ import org.apache.sling.hc.api.ResultLog;
  *  like &lt; N, &gt; N, between two values etc.
  *  See the SimpleConstraintCheckerTest for examples.
  */
+@Deprecated
 public class SimpleConstraintChecker {
 
     public static final String CONTAINS = "contains";