svn commit: r1614841 - /sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext

[bd...@apache.org]

Author: bdelacretaz
Date: Thu Jul 31 09:40:21 2014
New Revision: 1614841

URL: http://svn.apache.org/r1614841
Log:
SLING-3624 - document SlingHealthCheck annotation

Modified:
    sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext

Modified: sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext?rev=1614841&r1=1614840&r2=1614841&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext (original)
+++ sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext Thu Jul 31 09:40:21 2014
@@ -70,6 +70,25 @@ selects all `HealthCheck` having the `sl
 Besides executing them programmatically, Health checks can be executed via a webconsole plugin or via JMX, 
 as described below.
 
+### SlingHealthCheck annotation
+The `SlingHealthCheck` annotation makes it easier to specify the required `HealthCheck` service properties.
+
+Here's an example from the `samples` module - see the `annotations` module for more details.
+
+    @SlingHealthCheck(
+        name="Annotated Health Check Sample", 
+        mbeanName="annotatedHC",
+        description="Sample Health Check defined by a java annotation",
+        tags={"sample","annotation"})
+
+    public class AnnotatedHealthCheckSample implements HealthCheck{
+
+        @Override
+        public Result execute() {
+            ...health check code
+        }
+    }
+
 ## Health Check bundles
 The Health Check subsystem consists of the following bundles: