This is an automated email from the ASF dual-hosted git repository. olli pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-clam.git
commit 3df4c599c4d44dfe7e877da6914044dec51b8077 Author: Oliver Lietz <[email protected]> AuthorDate: Fri Nov 5 17:10:43 2021 +0100 [checkstyle] (javadoc) MissingJavadocType --- .../java/org/apache/sling/clam/http/internal/ClamEventsServlet.java | 3 +++ .../java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java | 3 +++ src/main/java/org/apache/sling/clam/http/internal/RequestUtil.java | 3 +++ src/main/java/org/apache/sling/clam/http/internal/ResponseUtil.java | 3 +++ src/main/java/org/apache/sling/clam/internal/ClamUtil.java | 3 +++ .../org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java | 3 +++ .../clam/jcr/internal/DefaultNodeDescendingJcrPropertyDigger.java | 3 +++ .../org/apache/sling/clam/job/internal/JcrPropertyScanJobConsumer.java | 3 +++ .../apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java | 3 +++ .../org/apache/sling/clam/result/JcrPropertyScanResultHandler.java | 3 +++ .../sling/clam/result/internal/EventPublishingScanResultHandler.java | 3 +++ .../sling/clam/result/internal/MailSendingScanResultHandler.java | 3 +++ .../clam/result/internal/ResourcePersistingScanResultHandler.java | 3 +++ 13 files changed, 39 insertions(+) diff --git a/src/main/java/org/apache/sling/clam/http/internal/ClamEventsServlet.java b/src/main/java/org/apache/sling/clam/http/internal/ClamEventsServlet.java index cd85def..b016e52 100644 --- a/src/main/java/org/apache/sling/clam/http/internal/ClamEventsServlet.java +++ b/src/main/java/org/apache/sling/clam/http/internal/ClamEventsServlet.java @@ -52,6 +52,9 @@ import org.slf4j.LoggerFactory; import static org.apache.sling.clam.http.internal.ResponseUtil.json; +/** + * Service to publish scan results as Server-Sent Events. + */ @Component( service = { Servlet.class, diff --git a/src/main/java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java b/src/main/java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java index b2c3e99..4da18c0 100644 --- a/src/main/java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java +++ b/src/main/java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java @@ -56,6 +56,9 @@ import static org.apache.sling.clam.http.internal.RequestUtil.propertyTypes; import static org.apache.sling.clam.http.internal.ResponseUtil.handleError; import static org.apache.sling.clam.internal.ClamUtil.propertyTypesFromNames; +/** + * Service to provide an HTTP API to trigger JCR scans. + */ @Component( service = Servlet.class, property = { diff --git a/src/main/java/org/apache/sling/clam/http/internal/RequestUtil.java b/src/main/java/org/apache/sling/clam/http/internal/RequestUtil.java index a67eaeb..f682baf 100644 --- a/src/main/java/org/apache/sling/clam/http/internal/RequestUtil.java +++ b/src/main/java/org/apache/sling/clam/http/internal/RequestUtil.java @@ -31,6 +31,9 @@ import org.jetbrains.annotations.NotNull; import static org.apache.sling.clam.internal.ClamUtil.propertyTypesFromNames; +/** + * Util for HTTP Requests. + */ public final class RequestUtil { private RequestUtil() { diff --git a/src/main/java/org/apache/sling/clam/http/internal/ResponseUtil.java b/src/main/java/org/apache/sling/clam/http/internal/ResponseUtil.java index 879c814..137d8cd 100644 --- a/src/main/java/org/apache/sling/clam/http/internal/ResponseUtil.java +++ b/src/main/java/org/apache/sling/clam/http/internal/ResponseUtil.java @@ -33,6 +33,9 @@ import org.apache.sling.commons.clam.ScanResult; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; +/** + * Util for HTTP Responses. + */ public final class ResponseUtil { private ResponseUtil() { diff --git a/src/main/java/org/apache/sling/clam/internal/ClamUtil.java b/src/main/java/org/apache/sling/clam/internal/ClamUtil.java index d7bb45a..84e23af 100644 --- a/src/main/java/org/apache/sling/clam/internal/ClamUtil.java +++ b/src/main/java/org/apache/sling/clam/internal/ClamUtil.java @@ -29,6 +29,9 @@ import org.apache.sling.commons.clam.ScanResult; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; +/** + * Util for JCR and event properties and scan results. + */ public final class ClamUtil { public static final String PROPERTY_PATH = "path"; diff --git a/src/main/java/org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java b/src/main/java/org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java index 00d1a40..31e356f 100644 --- a/src/main/java/org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java +++ b/src/main/java/org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java @@ -26,6 +26,9 @@ import javax.jcr.Node; import org.jetbrains.annotations.NotNull; import org.osgi.annotation.versioning.ProviderType; +/** + * Service to dig JCR for matching properties. + */ @ProviderType public interface NodeDescendingJcrPropertyDigger { diff --git a/src/main/java/org/apache/sling/clam/jcr/internal/DefaultNodeDescendingJcrPropertyDigger.java b/src/main/java/org/apache/sling/clam/jcr/internal/DefaultNodeDescendingJcrPropertyDigger.java index a2f1922..720ac31 100644 --- a/src/main/java/org/apache/sling/clam/jcr/internal/DefaultNodeDescendingJcrPropertyDigger.java +++ b/src/main/java/org/apache/sling/clam/jcr/internal/DefaultNodeDescendingJcrPropertyDigger.java @@ -41,6 +41,9 @@ import static org.apache.sling.clam.internal.ClamUtil.checkLength; import static org.apache.sling.clam.internal.ClamUtil.properties; import static org.apache.sling.clam.internal.ClamUtil.scanJobTopic; +/** + * Service to dig JCR for matching properties and create scan jobs. + */ @Component( service = NodeDescendingJcrPropertyDigger.class, property = { diff --git a/src/main/java/org/apache/sling/clam/job/internal/JcrPropertyScanJobConsumer.java b/src/main/java/org/apache/sling/clam/job/internal/JcrPropertyScanJobConsumer.java index e6217ad..8571b64 100644 --- a/src/main/java/org/apache/sling/clam/job/internal/JcrPropertyScanJobConsumer.java +++ b/src/main/java/org/apache/sling/clam/job/internal/JcrPropertyScanJobConsumer.java @@ -47,6 +47,9 @@ import org.osgi.service.component.annotations.ReferencePolicyOption; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * Service to consume jobs and scan data with Clam service. + */ @Component( property = { JobExecutor.PROPERTY_TOPICS + "=org/apache/sling/clam/scan/jcr/property/*", diff --git a/src/main/java/org/apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java b/src/main/java/org/apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java index 7880744..3306e1f 100644 --- a/src/main/java/org/apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java +++ b/src/main/java/org/apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java @@ -53,6 +53,9 @@ import static org.apache.sling.clam.internal.ClamUtil.checkLength; import static org.apache.sling.clam.internal.ClamUtil.properties; import static org.apache.sling.clam.internal.ClamUtil.scanJobTopic; +/** + * Service to observe JCR nodes for matching properties. + */ @Component( service = Observer.class, immediate = true, diff --git a/src/main/java/org/apache/sling/clam/result/JcrPropertyScanResultHandler.java b/src/main/java/org/apache/sling/clam/result/JcrPropertyScanResultHandler.java index fb28ffa..ea97a4e 100644 --- a/src/main/java/org/apache/sling/clam/result/JcrPropertyScanResultHandler.java +++ b/src/main/java/org/apache/sling/clam/result/JcrPropertyScanResultHandler.java @@ -23,6 +23,9 @@ import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; import org.osgi.annotation.versioning.ConsumerType; +/** + * Service to handle JCR property scan results. + */ @ConsumerType public interface JcrPropertyScanResultHandler { diff --git a/src/main/java/org/apache/sling/clam/result/internal/EventPublishingScanResultHandler.java b/src/main/java/org/apache/sling/clam/result/internal/EventPublishingScanResultHandler.java index 6b33cf0..612c894 100644 --- a/src/main/java/org/apache/sling/clam/result/internal/EventPublishingScanResultHandler.java +++ b/src/main/java/org/apache/sling/clam/result/internal/EventPublishingScanResultHandler.java @@ -40,6 +40,9 @@ import org.slf4j.LoggerFactory; import static org.apache.sling.clam.internal.ClamUtil.properties; import static org.apache.sling.clam.internal.ClamUtil.resultEventTopic; +/** + * Service to publish scan results as OSGi Event. + */ @Component( configurationPolicy = ConfigurationPolicy.REQUIRE, property = { diff --git a/src/main/java/org/apache/sling/clam/result/internal/MailSendingScanResultHandler.java b/src/main/java/org/apache/sling/clam/result/internal/MailSendingScanResultHandler.java index d8fb738..7454553 100644 --- a/src/main/java/org/apache/sling/clam/result/internal/MailSendingScanResultHandler.java +++ b/src/main/java/org/apache/sling/clam/result/internal/MailSendingScanResultHandler.java @@ -53,6 +53,9 @@ import org.thymeleaf.templatemode.TemplateMode; import static org.apache.sling.clam.internal.ClamUtil.properties; +/** + * Service to send scan results as mail. + */ @Component( configurationPolicy = ConfigurationPolicy.REQUIRE, property = { diff --git a/src/main/java/org/apache/sling/clam/result/internal/ResourcePersistingScanResultHandler.java b/src/main/java/org/apache/sling/clam/result/internal/ResourcePersistingScanResultHandler.java index 57103b0..8bc97ad 100644 --- a/src/main/java/org/apache/sling/clam/result/internal/ResourcePersistingScanResultHandler.java +++ b/src/main/java/org/apache/sling/clam/result/internal/ResourcePersistingScanResultHandler.java @@ -56,6 +56,9 @@ import static org.apache.jackrabbit.JcrConstants.JCR_MIXINTYPES; import static org.apache.jackrabbit.JcrConstants.JCR_PRIMARYTYPE; import static org.apache.sling.clam.internal.ClamUtil.properties; +/** + * Service to persist scan results as <code>Resource</code>. + */ @Component( configurationPolicy = ConfigurationPolicy.REQUIRE, property = {
