You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2022/03/27 20:16:23 UTC

[sling-org-apache-sling-clam] branch master updated (429833b -> c9adaa7)

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

olli pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-clam.git.


    from 429833b  SLING-10886 Update to Sling Bundle Parent 46
     new 6660fbc  SLING-10891 Enable code checks with Checkstyle
     new 996ddd2  SLING-10892 Enable code checks with PMD
     new 6d5cad6  SLING-10893 Enable code checks with SpotBugs
     new f47fdc3  [checkstyle] (design) DesignForExtension
     new 6186e6e  [checkstyle] (design) FinalClass
     new 3b2ae21  [checkstyle] (modifier) RedundantModifier
     new 18d7faa  [checkstyle] (misc) FinalParameters
     new 2227d53  [checkstyle] (modifier) InterfaceMemberImpliedModifier
     new bfe8cce  [checkstyle] (javadoc) JavadocPackage
     new 59cfe24  [checkstyle] (javadoc) MissingJavadocPackage
     new ca52e5c  [checkstyle] (whitespace) OperatorWrap
     new 2a9a9a0  [checkstyle] (coding) DeclarationOrder
     new 3bf7361  style
     new 3df4c59  [checkstyle] (javadoc) MissingJavadocType
     new c50a796  [checkstyle] (javadoc) SummaryJavadoc
     new bd77316  [checkstyle] (javadoc) MissingJavadocMethod
     new 9e01fa0  [checkstyle] (coding) MissingCtor
     new 9c7d8ab  log event instead of event count
     new 0997219  [checkstyle] (coding) UnnecessaryParenthese
     new 3f8656c  [checkstyle] (design) VisibilityModifier
     new 5ece08f  [checkstyle] (coding) MultipleStringLiterals
     new 1c072c0  [checkstyle] (coding) DeclarationOrder
     new 4c3e69c  [checkstyle] (coding) OverloadMethodsDeclarationOrder
     new a0c24f1  [checkstyle] (coding) IllegalCatch
     new ebcad2d  [checkstyle] (coding) NestedIfDepth
     new e944b83  [checkstyle] (coding) AvoidInlineConditionals
     new 5198e8c  [checkstyle] (coding) ReturnCount
     new d9e084e  [checkstyle] (sizes) ExecutableStatementCount
     new f7c87f2  [checkstyle] (metrics) CyclomaticComplexity
     new b4f1c8d  [checkstyle] (metrics) NPathComplexity
     new cfa1950  [checkstyle] (metrics) ClassFanOutComplexity
     new 3168033  style
     new 76a2ee7  SLING-10891 Enable code checks with Checkstyle
     new 573020c  SLING-10892 Enable code checks with PMD
     new c888309  SLING-10893 Enable code checks with SpotBugs
     new 062769f  SLING-11222 Update to Sling Bundle Parent 47
     new 79d7c76  [pmd] UnusedPrivateMethod
     new 1c09ed3  [pmd] UnusedPrivateField
     new cae468b  [pmd] TooManyStaticImports
     new 34c856e  [spotbugs] exclude SE_BAD_FIELD
     new c00cbfd  [spotbugs] STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE
     new b6acb91  [spotbugs] exclude VA_FORMAT_STRING_USES_NEWLINE
     new 5d1c45e  [spotbugs] exclude REC_CATCH_EXCEPTION
     new c9adaa7  [spotbugs] exclude RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE

The 44 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 checkstyle-suppressions.xml                        | 29 +++++++++
 pmd-exclude.properties                             | 22 +++++++
 pom.xml                                            | 72 +++++++++++++++++++++-
 spotbugs-exclude.xml                               | 42 +++++++++++++
 .../clam/http/internal/ClamEventsServlet.java      | 35 +++++++----
 .../clam/http/internal/ClamJcrScanServlet.java     |  9 ++-
 .../sling/clam/http/internal/RequestUtil.java      | 10 ++-
 .../sling/clam/http/internal/ResponseUtil.java     |  9 ++-
 .../sling/clam/http/internal/package-info.java     |  7 ++-
 .../org/apache/sling/clam/internal/ClamUtil.java   |  3 +
 .../apache/sling/clam/internal/package-info.java   |  7 ++-
 .../clam/jcr/NodeDescendingJcrPropertyDigger.java  |  7 ++-
 .../DefaultNodeDescendingJcrPropertyDigger.java    | 25 ++++++--
 .../sling/clam/jcr/internal/package-info.java      |  7 ++-
 .../org/apache/sling/clam/jcr/package-info.java    |  4 ++
 .../job/internal/JcrPropertyScanJobConsumer.java   | 14 +++--
 .../sling/clam/job/internal/package-info.java      |  7 ++-
 .../internal/NodeObservingJcrPropertyDigger.java   | 14 ++++-
 .../sling/clam/oak/internal/package-info.java      |  7 ++-
 .../clam/result/JcrPropertyScanResultHandler.java  | 11 +++-
 .../internal/EventPublishingScanResultHandler.java | 12 +++-
 .../internal/MailSendingScanResultHandler.java     | 17 +++--
 .../MailSendingScanResultHandlerConfiguration.java | 16 ++---
 .../ResourcePersistingScanResultHandler.java       | 40 +++++++-----
 .../sling/clam/result/internal/package-info.java   |  7 ++-
 .../org/apache/sling/clam/result/package-info.java |  4 ++
 26 files changed, 360 insertions(+), 77 deletions(-)
 create mode 100644 checkstyle-suppressions.xml
 create mode 100644 pmd-exclude.properties
 create mode 100644 spotbugs-exclude.xml
 copy Jenkinsfile => src/main/java/org/apache/sling/clam/http/internal/package-info.java (88%)
 copy Jenkinsfile => src/main/java/org/apache/sling/clam/internal/package-info.java (88%)
 copy Jenkinsfile => src/main/java/org/apache/sling/clam/jcr/internal/package-info.java (84%)
 copy Jenkinsfile => src/main/java/org/apache/sling/clam/job/internal/package-info.java (89%)
 copy Jenkinsfile => src/main/java/org/apache/sling/clam/oak/internal/package-info.java (87%)
 copy Jenkinsfile => src/main/java/org/apache/sling/clam/result/internal/package-info.java (86%)

[sling-org-apache-sling-clam] 05/44: [checkstyle] (design) FinalClass

Posted by ol...@apache.org.
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 6186e6e14c8652025ea63129a4eccfb2837b6616
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Oct 27 23:29:56 2021 +0200

    [checkstyle] (design) FinalClass
---
 .../java/org/apache/sling/clam/http/internal/ClamEventsServlet.java     | 2 +-
 src/main/java/org/apache/sling/clam/http/internal/RequestUtil.java      | 2 +-
 src/main/java/org/apache/sling/clam/http/internal/ResponseUtil.java     | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

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 1e5d59e..cd85def 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
@@ -124,7 +124,7 @@ public final class ClamEventsServlet extends HttpServlet implements JcrPropertyS
 
     }
 
-    private class Client implements AsyncListener, WriteListener {
+    private final class Client implements AsyncListener, WriteListener {
 
         private final AsyncContext context;
 
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 c946439..a67eaeb 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,7 +31,7 @@ import org.jetbrains.annotations.NotNull;
 
 import static org.apache.sling.clam.internal.ClamUtil.propertyTypesFromNames;
 
-public class RequestUtil {
+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 2406286..79f31d9 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,7 +33,7 @@ import org.apache.sling.commons.clam.ScanResult;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-public class ResponseUtil {
+public final class ResponseUtil {
 
     private ResponseUtil() {
     }

[sling-org-apache-sling-clam] 11/44: [checkstyle] (whitespace) OperatorWrap

Posted by ol...@apache.org.
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 ca52e5c9649f025761adb4edddde087a74855993
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Oct 29 08:34:53 2021 +0200

    [checkstyle] (whitespace) OperatorWrap
---
 .../MailSendingScanResultHandlerConfiguration.java       | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/main/java/org/apache/sling/clam/result/internal/MailSendingScanResultHandlerConfiguration.java b/src/main/java/org/apache/sling/clam/result/internal/MailSendingScanResultHandlerConfiguration.java
index f319285..483c46d 100644
--- a/src/main/java/org/apache/sling/clam/result/internal/MailSendingScanResultHandlerConfiguration.java
+++ b/src/main/java/org/apache/sling/clam/result/internal/MailSendingScanResultHandlerConfiguration.java
@@ -71,14 +71,14 @@ import org.osgi.service.metatype.annotations.ObjectClassDefinition;
         description = "Mail Text template (available variables: path, index, message, status, userId, started, size, timestamp)",
         required = false
     ) // newlines get lost in scr and metatype XML
-    String mail_text() default "status: [(${status})]\n" +
-        "message: [(${message})]\n" +
-        "path: [(${path})]\n" +
-        "[# th:if=\"${index}\"]index: [(${index})][/]\n" +
-        "size: [(${size})]\n" +
-        "[# th:if=\"${userId}\"]userId: [(${userId})][/]\n" +
-        "started: [(${#dates.formatISO(new java.util.Date(started))})]\n" +
-        "timestamp: [(${#dates.formatISO(new java.util.Date(timestamp))})]\n";
+    String mail_text() default "status: [(${status})]\n"
+        + "message: [(${message})]\n"
+        + "path: [(${path})]\n"
+        + "[# th:if=\"${index}\"]index: [(${index})][/]\n"
+        + "size: [(${size})]\n"
+        + "[# th:if=\"${userId}\"]userId: [(${userId})][/]\n"
+        + "started: [(${#dates.formatISO(new java.util.Date(started))})]\n"
+        + "timestamp: [(${#dates.formatISO(new java.util.Date(timestamp))})]\n";
 
     @AttributeDefinition(
         name = "Mail HTML",

[sling-org-apache-sling-clam] 13/44: style

Posted by ol...@apache.org.
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 3bf736188ed4f374bd2a58c341482ef15afe0ebf
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Oct 29 12:10:11 2021 +0200

    style
---
 .../clam/result/internal/ResourcePersistingScanResultHandler.java   | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

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 872cc4f..57103b0 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
@@ -70,6 +70,8 @@ import static org.apache.sling.clam.internal.ClamUtil.properties;
 @SuppressWarnings("java:S3077")
 public final class ResourcePersistingScanResultHandler implements JcrPropertyScanResultHandler {
 
+    private static final SimpleDateFormat PATH_DATE_FORMAT = new SimpleDateFormat("yyyy/MM/dd/HH/mm/ss");
+
     private static final String NT_SLING_ORDERED_FOLDER = "sling:OrderedFolder";
 
     private static final String SLING_RESOURCE_TYPE_PROPERTY = "sling:resourceType";
@@ -93,8 +95,6 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
 
     private ResourcePersistingScanResultHandlerConfiguration configuration;
 
-    private final SimpleDateFormat format = new SimpleDateFormat("yyyy/MM/dd/HH/mm/ss");
-
     private final Logger logger = LoggerFactory.getLogger(ResourcePersistingScanResultHandler.class);
 
     public ResourcePersistingScanResultHandler() { //
@@ -157,7 +157,7 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
     }
 
     private Resource getOrCreateParent(final ResourceResolver resourceResolver) throws PersistenceException {
-        final String path = String.format("%s/%s", configuration.result_root_path(), format.format(new Date()));
+        final String path = String.format("%s/%s", configuration.result_root_path(), PATH_DATE_FORMAT.format(new Date()));
         return ResourceUtil.getOrCreateResource(resourceResolver, path, NT_SLING_ORDERED_FOLDER, NT_SLING_ORDERED_FOLDER, true);
     }
 

[sling-org-apache-sling-clam] 01/44: SLING-10891 Enable code checks with Checkstyle

Posted by ol...@apache.org.
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 6660fbce6d4b34e7bcaaa545a0d8701dc91b5323
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Oct 27 23:12:20 2021 +0200

    SLING-10891 Enable code checks with Checkstyle
---
 pom.xml | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/pom.xml b/pom.xml
index 97f8430..f12509d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -82,6 +82,34 @@
           </systemPropertyVariables>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>3.1.2</version>
+        <dependencies>
+          <dependency>
+            <groupId>com.puppycrawl.tools</groupId>
+            <artifactId>checkstyle</artifactId>
+            <version>9.0.1</version>
+          </dependency>
+          <dependency>
+            <groupId>de.bildschirmarbeiter</groupId>
+            <artifactId>checkstyle</artifactId>
+            <version>3</version>
+          </dependency>
+        </dependencies>
+        <configuration>
+          <configLocation>checks.xml</configLocation>
+        </configuration>
+        <executions>
+          <execution>
+            <phase>validate</phase>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

[sling-org-apache-sling-clam] 14/44: [checkstyle] (javadoc) MissingJavadocType

Posted by ol...@apache.org.
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 <ol...@apache.org>
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 = {

[sling-org-apache-sling-clam] 15/44: [checkstyle] (javadoc) SummaryJavadoc

Posted by ol...@apache.org.
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 c50a7969823ec179ce904f419b58fd956b248c3f
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Nov 5 20:30:13 2021 +0100

    [checkstyle] (javadoc) SummaryJavadoc
---
 .../org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java    | 2 ++
 .../org/apache/sling/clam/result/JcrPropertyScanResultHandler.java    | 4 ++++
 2 files changed, 6 insertions(+)

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 31e356f..c0628ff 100644
--- a/src/main/java/org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java
+++ b/src/main/java/org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java
@@ -33,6 +33,8 @@ import org.osgi.annotation.versioning.ProviderType;
 public interface NodeDescendingJcrPropertyDigger {
 
     /**
+     * Digs JCR for matching properties.
+     *
      * @param node          The entry node for digging
      * @param pattern       The pattern a property path has to match
      * @param propertyTypes The property types to take into account
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 ea97a4e..03e4241 100644
--- a/src/main/java/org/apache/sling/clam/result/JcrPropertyScanResultHandler.java
+++ b/src/main/java/org/apache/sling/clam/result/JcrPropertyScanResultHandler.java
@@ -30,6 +30,8 @@ import org.osgi.annotation.versioning.ConsumerType;
 public interface JcrPropertyScanResultHandler {
 
     /**
+     * Handles scan results of single-value properties.
+     *
      * @param scanResult   The scan result from Clam service
      * @param path         The path of the scanned single-value property
      * @param propertyType The type of the scanned property
@@ -38,6 +40,8 @@ public interface JcrPropertyScanResultHandler {
     public abstract void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int propertyType, @Nullable final String userId);
 
     /**
+     * Handles scan results of multi-value properties.
+     *
      * @param scanResult   The scan result from Clam service
      * @param path         The path of the scanned multi-value property
      * @param index        The index of the scanned property value

[sling-org-apache-sling-clam] 04/44: [checkstyle] (design) DesignForExtension

Posted by ol...@apache.org.
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 f47fdc3a79690b6d1ed0dffd73b2ccc9443a2c6f
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Oct 27 23:27:50 2021 +0200

    [checkstyle] (design) DesignForExtension
---
 .../java/org/apache/sling/clam/http/internal/ClamEventsServlet.java     | 2 +-
 .../java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java    | 2 +-
 .../sling/clam/jcr/internal/DefaultNodeDescendingJcrPropertyDigger.java | 2 +-
 .../org/apache/sling/clam/job/internal/JcrPropertyScanJobConsumer.java  | 2 +-
 .../apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java  | 2 +-
 .../sling/clam/result/internal/EventPublishingScanResultHandler.java    | 2 +-
 .../apache/sling/clam/result/internal/MailSendingScanResultHandler.java | 2 +-
 .../sling/clam/result/internal/ResourcePersistingScanResultHandler.java | 2 +-
 8 files changed, 8 insertions(+), 8 deletions(-)

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 4ce9ece..1e5d59e 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
@@ -70,7 +70,7 @@ import static org.apache.sling.clam.http.internal.ResponseUtil.json;
     ocd = ClamEventsServletConfiguration.class
 )
 @SuppressWarnings("java:S1948")
-public class ClamEventsServlet extends HttpServlet implements JcrPropertyScanResultHandler {
+public final class ClamEventsServlet extends HttpServlet implements JcrPropertyScanResultHandler {
 
     private final List<Client> clients = Collections.synchronizedList(new ArrayList<>());
 
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 63dc53b..b2c3e99 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
@@ -67,7 +67,7 @@ import static org.apache.sling.clam.internal.ClamUtil.propertyTypesFromNames;
     ocd = ClamJcrScanServletConfiguration.class
 )
 @SuppressWarnings({"java:S1948", "java:S3077"})
-public class ClamJcrScanServlet extends SlingAllMethodsServlet {
+public final class ClamJcrScanServlet extends SlingAllMethodsServlet {
 
     @Reference(
         policy = ReferencePolicy.DYNAMIC,
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 0719bf7..a2f1922 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
@@ -49,7 +49,7 @@ import static org.apache.sling.clam.internal.ClamUtil.scanJobTopic;
     }
 )
 @SuppressWarnings("java:S3077")
-public class DefaultNodeDescendingJcrPropertyDigger implements NodeDescendingJcrPropertyDigger {
+public final class DefaultNodeDescendingJcrPropertyDigger implements NodeDescendingJcrPropertyDigger {
 
     @Reference(
         policy = ReferencePolicy.DYNAMIC,
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 9a9c1ad..498d3be 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
@@ -55,7 +55,7 @@ import org.slf4j.LoggerFactory;
     }
 )
 @SuppressWarnings("java:S3077")
-public class JcrPropertyScanJobConsumer implements JobConsumer {
+public final class JcrPropertyScanJobConsumer implements JobConsumer {
 
     @Reference(
         policy = ReferencePolicy.DYNAMIC,
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 ebb64cc..7c20c01 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
@@ -66,7 +66,7 @@ import static org.apache.sling.clam.internal.ClamUtil.scanJobTopic;
     factory = true
 )
 @SuppressWarnings("java:S3077")
-public class NodeObservingJcrPropertyDigger extends NodeObserver {
+public final class NodeObservingJcrPropertyDigger extends NodeObserver {
 
     @Reference(
         policy = ReferencePolicy.DYNAMIC,
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 5bfef06..c16d15e 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
@@ -51,7 +51,7 @@ import static org.apache.sling.clam.internal.ClamUtil.resultEventTopic;
     ocd = EventPublishingScanResultHandlerConfiguration.class
 )
 @SuppressWarnings("java:S3077")
-public class EventPublishingScanResultHandler implements JcrPropertyScanResultHandler {
+public final class EventPublishingScanResultHandler implements JcrPropertyScanResultHandler {
 
     @Reference(
         policy = ReferencePolicy.DYNAMIC,
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 a6590ba..486753e 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
@@ -65,7 +65,7 @@ import static org.apache.sling.clam.internal.ClamUtil.properties;
     factory = true
 )
 @SuppressWarnings("java:S3077")
-public class MailSendingScanResultHandler implements JcrPropertyScanResultHandler {
+public final class MailSendingScanResultHandler implements JcrPropertyScanResultHandler {
 
     @Reference(
         policy = ReferencePolicy.DYNAMIC,
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 04808f9..a3af1a1 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
@@ -68,7 +68,7 @@ import static org.apache.sling.clam.internal.ClamUtil.properties;
     factory = true
 )
 @SuppressWarnings("java:S3077")
-public class ResourcePersistingScanResultHandler implements JcrPropertyScanResultHandler {
+public final class ResourcePersistingScanResultHandler implements JcrPropertyScanResultHandler {
 
     @Reference(
         policy = ReferencePolicy.DYNAMIC,

[sling-org-apache-sling-clam] 41/44: [spotbugs] STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE

Posted by ol...@apache.org.
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 c00cbfd1433c75175e2b7c369caf671510ad13d3
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 20:50:11 2022 +0200

    [spotbugs] STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE
---
 .../clam/result/internal/ResourcePersistingScanResultHandler.java    | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

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 c254e9e..4d1cfec 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
@@ -73,7 +73,7 @@ import static org.apache.sling.clam.internal.ClamUtil.properties;
 @SuppressWarnings("java:S3077")
 public final class ResourcePersistingScanResultHandler implements JcrPropertyScanResultHandler {
 
-    private static final SimpleDateFormat PATH_DATE_FORMAT = new SimpleDateFormat("yyyy/MM/dd/HH/mm/ss");
+    private static final String PATH_DATE_PATTERN = "yyyy/MM/dd/HH/mm/ss";
 
     private static final String NT_SLING_ORDERED_FOLDER = "sling:OrderedFolder";
 
@@ -164,7 +164,8 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
     }
 
     private Resource getOrCreateParent(final ResourceResolver resourceResolver) throws PersistenceException {
-        final String path = String.format("%s/%s", configuration.result_root_path(), PATH_DATE_FORMAT.format(new Date()));
+        final SimpleDateFormat format = new SimpleDateFormat(PATH_DATE_PATTERN);
+        final String path = String.format("%s/%s", configuration.result_root_path(), format.format(new Date()));
         return ResourceUtil.getOrCreateResource(resourceResolver, path, NT_SLING_ORDERED_FOLDER, NT_SLING_ORDERED_FOLDER, true);
     }
 

[sling-org-apache-sling-clam] 12/44: [checkstyle] (coding) DeclarationOrder

Posted by ol...@apache.org.
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 2a9a9a0961431c55ed8fd19add2c3f527165a6b1
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Oct 29 12:09:47 2021 +0200

    [checkstyle] (coding) DeclarationOrder
---
 .../internal/ResourcePersistingScanResultHandler.java    | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

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 d9c3eb1..872cc4f 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
@@ -70,6 +70,14 @@ import static org.apache.sling.clam.internal.ClamUtil.properties;
 @SuppressWarnings("java:S3077")
 public final class ResourcePersistingScanResultHandler implements JcrPropertyScanResultHandler {
 
+    private static final String NT_SLING_ORDERED_FOLDER = "sling:OrderedFolder";
+
+    private static final String SLING_RESOURCE_TYPE_PROPERTY = "sling:resourceType";
+
+    private static final String JCR_RESULT_RESOURCE_TYPE = "sling/clam/jcr/result";
+
+    private static final String SUBSERVICE = "result-writer";
+
     @Reference(
         policy = ReferencePolicy.DYNAMIC,
         policyOption = ReferencePolicyOption.GREEDY
@@ -87,14 +95,6 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
 
     private final SimpleDateFormat format = new SimpleDateFormat("yyyy/MM/dd/HH/mm/ss");
 
-    private static final String NT_SLING_ORDERED_FOLDER = "sling:OrderedFolder";
-
-    private static final String SLING_RESOURCE_TYPE_PROPERTY = "sling:resourceType";
-
-    private static final String JCR_RESULT_RESOURCE_TYPE = "sling/clam/jcr/result";
-
-    private static final String SUBSERVICE = "result-writer";
-
     private final Logger logger = LoggerFactory.getLogger(ResourcePersistingScanResultHandler.class);
 
     public ResourcePersistingScanResultHandler() { //

[sling-org-apache-sling-clam] 02/44: SLING-10892 Enable code checks with PMD

Posted by ol...@apache.org.
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 996ddd2cb51b194fec9c0859f64de80c1353bbdb
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Oct 27 23:13:14 2021 +0200

    SLING-10892 Enable code checks with PMD
---
 pom.xml | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/pom.xml b/pom.xml
index f12509d..e632c62 100644
--- a/pom.xml
+++ b/pom.xml
@@ -110,6 +110,22 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-pmd-plugin</artifactId>
+        <version>3.15.0</version>
+        <configuration>
+          <targetJdk>${sling.java.version}</targetJdk>
+        </configuration>
+        <executions>
+          <execution>
+            <phase>process-classes</phase>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

[sling-org-apache-sling-clam] 33/44: SLING-10891 Enable code checks with Checkstyle

Posted by ol...@apache.org.
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 76a2ee72e9099b7f9cfd80c74cdfd0126abc7110
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 16:30:27 2022 +0200

    SLING-10891 Enable code checks with Checkstyle
    
    update dependency
---
 pom.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pom.xml b/pom.xml
index fcc8768..ada0d49 100644
--- a/pom.xml
+++ b/pom.xml
@@ -90,7 +90,7 @@
           <dependency>
             <groupId>com.puppycrawl.tools</groupId>
             <artifactId>checkstyle</artifactId>
-            <version>9.0.1</version>
+            <version>10.0</version>
           </dependency>
           <dependency>
             <groupId>de.bildschirmarbeiter</groupId>

[sling-org-apache-sling-clam] 28/44: [checkstyle] (sizes) ExecutableStatementCount

Posted by ol...@apache.org.
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 d9e084e1f5ec4c96807616102c4068454c65a2ce
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 15:31:51 2022 +0200

    [checkstyle] (sizes) ExecutableStatementCount
---
 .../java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java    | 2 +-
 .../apache/sling/clam/result/internal/MailSendingScanResultHandler.java | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

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 6055244..cc7d18e 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
@@ -117,7 +117,7 @@ public final class ClamJcrScanServlet extends SlingAllMethodsServlet {
     }
 
     @Override
-    @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:ReturnCount"})
+    @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:ReturnCount", "checkstyle:ExecutableStatementCount"})
     protected void doPost(@NotNull final SlingHttpServletRequest request, @NotNull final SlingHttpServletResponse response) throws ServletException, IOException {
         final List<String> groups = Arrays.asList(configuration.scan_authorized_groups());
         if (!groups.isEmpty()) {
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 70d4e2e..98c230f 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
@@ -133,6 +133,7 @@ public final class MailSendingScanResultHandler implements JcrPropertyScanResult
         return !scanResult.isOk() || configuration.result_status_ok_send();
     }
 
+    @SuppressWarnings("checkstyle:ExecutableStatementCount")
     private void sendMail(final Map<String, Object> properties) throws Exception {
         final MailService mailService = this.mailService;
         final MessageBuilder builder = mailService.getMessageBuilder();

[sling-org-apache-sling-clam] 25/44: [checkstyle] (coding) NestedIfDepth

Posted by ol...@apache.org.
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 ebcad2d938dd99102db99a567e551fee40c0038c
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 14:55:33 2022 +0200

    [checkstyle] (coding) NestedIfDepth
---
 .../sling/clam/jcr/internal/DefaultNodeDescendingJcrPropertyDigger.java | 1 +
 .../apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java  | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

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 720ac31..362fc87 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
@@ -70,6 +70,7 @@ public final class DefaultNodeDescendingJcrPropertyDigger implements NodeDescend
         _dig(node, pattern, propertyTypes, maxLength, absoluteMaxDepth);
     }
 
+    @SuppressWarnings("checkstyle:NestedIfDepth")
     private void _dig(@NotNull final Node node, @NotNull final Pattern pattern, @NotNull final Set<Integer> propertyTypes, final long maxLength, final int maxDepth) throws Exception {
         final PropertyIterator properties = node.getProperties();
         while (properties.hasNext()) {
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 4511b2b..3a2e2b2 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
@@ -198,7 +198,7 @@ public final class NodeObservingJcrPropertyDigger extends NodeObserver {
         }
 
         @Override
-        @SuppressWarnings("checkstyle:IllegalCatch")
+        @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:NestedIfDepth"})
         public void run() {
             final Set<String> paths = filter(path, names, pattern);
             try (ResourceResolver resourceResolver = resourceResolverFactory.getServiceResourceResolver(null)) {

[sling-org-apache-sling-clam] 19/44: [checkstyle] (coding) UnnecessaryParenthese

Posted by ol...@apache.org.
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 099721911ea992acc3fc10c03af342321c0216f1
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Nov 5 20:39:26 2021 +0100

    [checkstyle] (coding) UnnecessaryParenthese
---
 .../sling/clam/result/internal/ResourcePersistingScanResultHandler.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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 8bc97ad..46d81da 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
@@ -92,7 +92,7 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
     @Reference(
         policy = ReferencePolicy.DYNAMIC,
         policyOption = ReferencePolicyOption.GREEDY,
-        target = ("(" + ServiceUserMapped.SUBSERVICENAME + "=" + SUBSERVICE + ")")
+        target = "(" + ServiceUserMapped.SUBSERVICENAME + "=" + SUBSERVICE + ")"
     )
     private volatile ServiceUserMapped serviceUserMapped;
 

[sling-org-apache-sling-clam] 35/44: SLING-10893 Enable code checks with SpotBugs

Posted by ol...@apache.org.
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 c888309ff1f1c0a10d9c35942e66cd7746ede577
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 16:32:16 2022 +0200

    SLING-10893 Enable code checks with SpotBugs
    
    update dependency
---
 pom.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pom.xml b/pom.xml
index 4a40f85..2a7f87d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -132,7 +132,7 @@
       <plugin>
         <groupId>com.github.spotbugs</groupId>
         <artifactId>spotbugs-maven-plugin</artifactId>
-        <version>4.4.2.2</version>
+        <version>4.6.0.0</version>
         <configuration>
           <plugins>
             <plugin>

[sling-org-apache-sling-clam] 09/44: [checkstyle] (javadoc) JavadocPackage

Posted by ol...@apache.org.
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 bfe8cce0e010c7de9133adf7204e2c610c28da95
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Thu Oct 28 18:07:56 2021 +0200

    [checkstyle] (javadoc) JavadocPackage
---
 .../sling/clam/http/internal/package-info.java     | 23 ++++++++++++++++++++++
 .../apache/sling/clam/internal/package-info.java   | 23 ++++++++++++++++++++++
 .../sling/clam/jcr/internal/package-info.java      | 23 ++++++++++++++++++++++
 .../sling/clam/job/internal/package-info.java      | 23 ++++++++++++++++++++++
 .../sling/clam/oak/internal/package-info.java      | 23 ++++++++++++++++++++++
 .../sling/clam/result/internal/package-info.java   | 23 ++++++++++++++++++++++
 6 files changed, 138 insertions(+)

diff --git a/src/main/java/org/apache/sling/clam/http/internal/package-info.java b/src/main/java/org/apache/sling/clam/http/internal/package-info.java
new file mode 100644
index 0000000..3a92346
--- /dev/null
+++ b/src/main/java/org/apache/sling/clam/http/internal/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+
+/**
+ * Provides services to trigger and monitor JCR scans.
+ */
+package org.apache.sling.clam.http.internal;
diff --git a/src/main/java/org/apache/sling/clam/internal/package-info.java b/src/main/java/org/apache/sling/clam/internal/package-info.java
new file mode 100644
index 0000000..0e6af5b
--- /dev/null
+++ b/src/main/java/org/apache/sling/clam/internal/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+
+/**
+ * Provides an util to deal with scan jobs and results.
+ */
+package org.apache.sling.clam.internal;
diff --git a/src/main/java/org/apache/sling/clam/jcr/internal/package-info.java b/src/main/java/org/apache/sling/clam/jcr/internal/package-info.java
new file mode 100644
index 0000000..a58f3a9
--- /dev/null
+++ b/src/main/java/org/apache/sling/clam/jcr/internal/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+
+/**
+ * Provides an implementation of <code>NodeDescendingJcrPropertyDigger</code> which creates scan jobs.
+ */
+package org.apache.sling.clam.jcr.internal;
diff --git a/src/main/java/org/apache/sling/clam/job/internal/package-info.java b/src/main/java/org/apache/sling/clam/job/internal/package-info.java
new file mode 100644
index 0000000..2691e80
--- /dev/null
+++ b/src/main/java/org/apache/sling/clam/job/internal/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+
+/**
+ * Provides a consumer for JCR scan jobs.
+ */
+package org.apache.sling.clam.job.internal;
diff --git a/src/main/java/org/apache/sling/clam/oak/internal/package-info.java b/src/main/java/org/apache/sling/clam/oak/internal/package-info.java
new file mode 100644
index 0000000..16ec55c
--- /dev/null
+++ b/src/main/java/org/apache/sling/clam/oak/internal/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+
+/**
+ * Provides a service to observe JCR nodes which creates scan jobs.
+ */
+package org.apache.sling.clam.oak.internal;
diff --git a/src/main/java/org/apache/sling/clam/result/internal/package-info.java b/src/main/java/org/apache/sling/clam/result/internal/package-info.java
new file mode 100644
index 0000000..fff5a02
--- /dev/null
+++ b/src/main/java/org/apache/sling/clam/result/internal/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+
+/**
+ * Provides implementations of <code>JcrPropertyScanResultHandler</code>.
+ */
+package org.apache.sling.clam.result.internal;

[sling-org-apache-sling-clam] 20/44: [checkstyle] (design) VisibilityModifier

Posted by ol...@apache.org.
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 3f8656c0e8e01dd026ac2564ac62356c4a0664ae
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Nov 5 20:50:29 2021 +0100

    [checkstyle] (design) VisibilityModifier
---
 .../apache/sling/clam/http/internal/ClamEventsServlet.java | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

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 2bd520c..992f895 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
@@ -116,15 +116,23 @@ public final class ClamEventsServlet extends HttpServlet implements JcrPropertyS
 
     private static class Event {
 
-        final String type;
+        private final String type;
 
-        final String data;
+        private final String data;
 
         Event(final String type, final String data) {
             this.type = type;
             this.data = data;
         }
 
+        public String getType() {
+            return type;
+        }
+
+        public String getData() {
+            return data;
+        }
+
     }
 
     private final class Client implements AsyncListener, WriteListener {
@@ -166,7 +174,7 @@ public final class ClamEventsServlet extends HttpServlet implements JcrPropertyS
             final ServletOutputStream outputStream = context.getResponse().getOutputStream();
             while (outputStream.isReady() && events.peek() != null) {
                 final Event event = events.poll();
-                final String data = String.format("event: %s\ndata: %s\n\n", event.type, event.data);
+                final String data = String.format("event: %s\ndata: %s\n\n", event.getType(), event.getData());
                 outputStream.write(data.getBytes(StandardCharsets.UTF_8));
                 flushIfReady(outputStream);
             }

[sling-org-apache-sling-clam] 22/44: [checkstyle] (coding) DeclarationOrder

Posted by ol...@apache.org.
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 1c072c00879f1186b5efbf91eb1dda1ea877d942
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Nov 17 10:51:57 2021 +0100

    [checkstyle] (coding) DeclarationOrder
---
 .../java/org/apache/sling/clam/http/internal/ClamEventsServlet.java   | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

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 992f895..9696c5c 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
@@ -74,10 +74,10 @@ import static org.apache.sling.clam.http.internal.ResponseUtil.json;
 @SuppressWarnings("java:S1948")
 public final class ClamEventsServlet extends HttpServlet implements JcrPropertyScanResultHandler {
 
-    private final List<Client> clients = Collections.synchronizedList(new ArrayList<>());
-
     private static final String JCR_RESULT_EVENT_TYPE = "sling/clam/jcr/result";
 
+    private final List<Client> clients = Collections.synchronizedList(new ArrayList<>());
+
     private final Logger logger = LoggerFactory.getLogger(ClamEventsServlet.class);
 
     public ClamEventsServlet() { //

[sling-org-apache-sling-clam] 26/44: [checkstyle] (coding) AvoidInlineConditionals

Posted by ol...@apache.org.
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 e944b8366c3821b792b9aa04610693a92cdd2a82
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 15:01:14 2022 +0200

    [checkstyle] (coding) AvoidInlineConditionals
---
 .../sling/clam/jcr/internal/DefaultNodeDescendingJcrPropertyDigger.java  | 1 +
 1 file changed, 1 insertion(+)

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 362fc87..fb2c8b9 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
@@ -66,6 +66,7 @@ public final class DefaultNodeDescendingJcrPropertyDigger implements NodeDescend
     }
 
     public void dig(@NotNull final Node node, @NotNull final Pattern pattern, @NotNull final Set<Integer> propertyTypes, final long maxLength, final int maxDepth) throws Exception {
+        @SuppressWarnings("checkstyle:AvoidInlineConditionals")
         final int absoluteMaxDepth = maxDepth < 0 ? -1 : node.getDepth() + maxDepth;
         _dig(node, pattern, propertyTypes, maxLength, absoluteMaxDepth);
     }

[sling-org-apache-sling-clam] 24/44: [checkstyle] (coding) IllegalCatch

Posted by ol...@apache.org.
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 a0c24f101074dcf58bd674786df0cbc1d9d61ff2
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 14:18:22 2022 +0200

    [checkstyle] (coding) IllegalCatch
---
 .../java/org/apache/sling/clam/http/internal/ClamEventsServlet.java   | 1 +
 .../java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java  | 1 +
 src/main/java/org/apache/sling/clam/http/internal/RequestUtil.java    | 4 ++++
 .../apache/sling/clam/job/internal/JcrPropertyScanJobConsumer.java    | 2 ++
 .../sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java       | 1 +
 .../sling/clam/result/internal/MailSendingScanResultHandler.java      | 2 ++
 6 files changed, 11 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 9696c5c..e29128e 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
@@ -194,6 +194,7 @@ public final class ClamEventsServlet extends HttpServlet implements JcrPropertyS
             }
         }
 
+        @SuppressWarnings("checkstyle:IllegalCatch")
         private void addEvent(final Event event) {
             logger.debug("adding event: {}", event);
             events.add(event);
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 4da18c0..e61229f 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
@@ -117,6 +117,7 @@ public final class ClamJcrScanServlet extends SlingAllMethodsServlet {
     }
 
     @Override
+    @SuppressWarnings("checkstyle:IllegalCatch")
     protected void doPost(@NotNull final SlingHttpServletRequest request, @NotNull final SlingHttpServletResponse response) throws ServletException, IOException {
         final List<String> groups = Arrays.asList(configuration.scan_authorized_groups());
         if (!groups.isEmpty()) {
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 f682baf..094bc7c 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
@@ -48,6 +48,7 @@ public final class RequestUtil {
         }
     }
 
+    @SuppressWarnings("checkstyle:IllegalCatch")
     static Pattern pattern(@NotNull final SlingHttpServletRequest request, @NotNull final Pattern defaultPattern) throws Exception {
         final String value = request.getParameter("pattern");
         if (value == null) {
@@ -61,6 +62,7 @@ public final class RequestUtil {
         }
     }
 
+    @SuppressWarnings("checkstyle:IllegalCatch")
     static Set<Integer> propertyTypes(@NotNull final SlingHttpServletRequest request, @NotNull final Set<Integer> defaultPropertyTypes) throws Exception {
         final String[] values = request.getParameterValues("propertyTypes");
         if (values == null || values.length == 0) {
@@ -73,6 +75,7 @@ public final class RequestUtil {
         }
     }
 
+    @SuppressWarnings("checkstyle:IllegalCatch")
     static long maxLength(@NotNull final SlingHttpServletRequest request, final long defaultMaxLength) throws Exception {
         final String value = request.getParameter("maxLength");
         if (value == null) {
@@ -86,6 +89,7 @@ public final class RequestUtil {
         }
     }
 
+    @SuppressWarnings("checkstyle:IllegalCatch")
     static int maxDepth(@NotNull final SlingHttpServletRequest request, final int defaultMaxDepth) throws Exception {
         final String value = request.getParameter("maxDepth");
         if (value == null) {
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 8571b64..998653b 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
@@ -91,6 +91,7 @@ public final class JcrPropertyScanJobConsumer implements JobConsumer {
     }
 
     @Override
+    @SuppressWarnings("checkstyle:IllegalCatch")
     public JobResult process(final Job job) {
         try (ResourceResolver resourceResolver = resourceResolverFactory.getServiceResourceResolver(null)) {
             final String path = job.getProperty(ClamUtil.PROPERTY_PATH, String.class);
@@ -131,6 +132,7 @@ public final class JcrPropertyScanJobConsumer implements JobConsumer {
         }
     }
 
+    @SuppressWarnings("checkstyle:IllegalCatch")
     private void invokeScanResultHandlers(final ScanResult scanResult, final String path, final Integer index, final int propertyType, final String userId) {
         if (scanResultHandlers != null) {
             for (final JcrPropertyScanResultHandler scanResultHandler : scanResultHandlers) {
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 3306e1f..4511b2b 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
@@ -198,6 +198,7 @@ public final class NodeObservingJcrPropertyDigger extends NodeObserver {
         }
 
         @Override
+        @SuppressWarnings("checkstyle:IllegalCatch")
         public void run() {
             final Set<String> paths = filter(path, names, pattern);
             try (ResourceResolver resourceResolver = resourceResolverFactory.getServiceResourceResolver(null)) {
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 7454553..70d4e2e 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
@@ -104,6 +104,7 @@ public final class MailSendingScanResultHandler implements JcrPropertyScanResult
     }
 
     @Override
+    @SuppressWarnings("checkstyle:IllegalCatch")
     public void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int propertyType, @Nullable final String userId) {
         if (checkPublish(scanResult)) {
             final Map<String, Object> properties = properties(path, userId, scanResult);
@@ -116,6 +117,7 @@ public final class MailSendingScanResultHandler implements JcrPropertyScanResult
     }
 
     @Override
+    @SuppressWarnings("checkstyle:IllegalCatch")
     public void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int index, final int propertyType, @Nullable final String userId) {
         if (checkPublish(scanResult)) {
             final Map<String, Object> properties = properties(path, index, userId, scanResult);

[sling-org-apache-sling-clam] 38/44: [pmd] UnusedPrivateField

Posted by ol...@apache.org.
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 1c09ed3111427f3b20c9d8a9664db111707ae3fd
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 20:10:50 2022 +0200

    [pmd] UnusedPrivateField
---
 .../org/apache/sling/clam/job/internal/JcrPropertyScanJobConsumer.java   | 1 +
 .../apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java   | 1 +
 .../sling/clam/result/internal/ResourcePersistingScanResultHandler.java  | 1 +
 3 files changed, 3 insertions(+)

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 998653b..2735630 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
@@ -83,6 +83,7 @@ public final class JcrPropertyScanJobConsumer implements JobConsumer {
         policy = ReferencePolicy.DYNAMIC,
         policyOption = ReferencePolicyOption.GREEDY
     )
+    @SuppressWarnings("unused")
     private volatile ServiceUserMapped serviceUserMapped;
 
     private final Logger logger = LoggerFactory.getLogger(JcrPropertyScanJobConsumer.class);
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 9d754ce..9b1db18 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
@@ -90,6 +90,7 @@ public final class NodeObservingJcrPropertyDigger extends NodeObserver {
         policy = ReferencePolicy.DYNAMIC,
         policyOption = ReferencePolicyOption.GREEDY
     )
+    @SuppressWarnings("unused")
     private volatile ServiceUserMapped serviceUserMapped;
 
     private Pattern pattern;
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 d53b5f4..c254e9e 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
@@ -94,6 +94,7 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
         policyOption = ReferencePolicyOption.GREEDY,
         target = "(" + ServiceUserMapped.SUBSERVICENAME + "=" + SUBSERVICE + ")"
     )
+    @SuppressWarnings("unused")
     private volatile ServiceUserMapped serviceUserMapped;
 
     private ResourcePersistingScanResultHandlerConfiguration configuration;

[sling-org-apache-sling-clam] 27/44: [checkstyle] (coding) ReturnCount

Posted by ol...@apache.org.
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 5198e8c71fc99f9368ac8ba498de5b759536b5e6
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 15:20:37 2022 +0200

    [checkstyle] (coding) ReturnCount
---
 .../java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java    | 2 +-
 src/main/java/org/apache/sling/clam/http/internal/RequestUtil.java      | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

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 e61229f..6055244 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
@@ -117,7 +117,7 @@ public final class ClamJcrScanServlet extends SlingAllMethodsServlet {
     }
 
     @Override
-    @SuppressWarnings("checkstyle:IllegalCatch")
+    @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:ReturnCount"})
     protected void doPost(@NotNull final SlingHttpServletRequest request, @NotNull final SlingHttpServletResponse response) throws ServletException, IOException {
         final List<String> groups = Arrays.asList(configuration.scan_authorized_groups());
         if (!groups.isEmpty()) {
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 094bc7c..e5194b4 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
@@ -103,6 +103,7 @@ public final class RequestUtil {
         }
     }
 
+    @SuppressWarnings("checkstyle:ReturnCount")
     static boolean isAuthorized(@NotNull final SlingHttpServletRequest request, @NotNull final Collection<String> authorizedGroups) throws Exception {
         final Authorizable authorizable = request.getResourceResolver().adaptTo(Authorizable.class);
         if (authorizable == null) {

[sling-org-apache-sling-clam] 30/44: [checkstyle] (metrics) NPathComplexity

Posted by ol...@apache.org.
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 b4f1c8d1c3b096400907784f2d0e95325c7c1dc4
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 15:41:44 2022 +0200

    [checkstyle] (metrics) NPathComplexity
---
 .../apache/sling/clam/result/internal/MailSendingScanResultHandler.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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 29f11e9..92eeac8 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
@@ -133,7 +133,7 @@ public final class MailSendingScanResultHandler implements JcrPropertyScanResult
         return !scanResult.isOk() || configuration.result_status_ok_send();
     }
 
-    @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:ExecutableStatementCount"})
+    @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:ExecutableStatementCount", "checkstyle:NPathComplexity"})
     private void sendMail(final Map<String, Object> properties) throws Exception {
         final MailService mailService = this.mailService;
         final MessageBuilder builder = mailService.getMessageBuilder();

[sling-org-apache-sling-clam] 23/44: [checkstyle] (coding) OverloadMethodsDeclarationOrder

Posted by ol...@apache.org.
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 4c3e69c42a251f9d58250e07e58bd18bc8f182b9
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Nov 19 13:00:28 2021 +0100

    [checkstyle] (coding) OverloadMethodsDeclarationOrder
---
 checkstyle-suppressions.xml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
index b55c53c..0193656 100644
--- a/checkstyle-suppressions.xml
+++ b/checkstyle-suppressions.xml
@@ -20,6 +20,7 @@
 <!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
 <suppressions>
   <suppress checks="MissingJavadocMethod" files=".*\/internal\/.*\.java"/>
+  <suppress checks="OverloadMethodsDeclarationOrder" files=".*\/ClamEventsServlet\.java"/>
   <suppress checks="MultipleStringLiterals" files=".*\/ClamEventsServlet\.java"/>
   <suppress checks="MultipleStringLiterals" files=".*\/ClamEventsServletConfiguration\.java"/>
   <suppress checks="MultipleStringLiterals" files=".*\/ClamJcrScanServletConfiguration\.java"/>

[sling-org-apache-sling-clam] 18/44: log event instead of event count

Posted by ol...@apache.org.
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 9c7d8abf64c848de8444542ca9c235b07dcce578
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Nov 5 20:36:49 2021 +0100

    log event instead of event count
---
 .../java/org/apache/sling/clam/http/internal/ClamEventsServlet.java | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)

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 50697a4..2bd520c 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
@@ -25,7 +25,6 @@ import java.util.Collections;
 import java.util.List;
 import java.util.Queue;
 import java.util.concurrent.ConcurrentLinkedQueue;
-import java.util.concurrent.atomic.AtomicLong;
 
 import javax.servlet.AsyncContext;
 import javax.servlet.AsyncEvent;
@@ -77,8 +76,6 @@ public final class ClamEventsServlet extends HttpServlet implements JcrPropertyS
 
     private final List<Client> clients = Collections.synchronizedList(new ArrayList<>());
 
-    private final AtomicLong counter = new AtomicLong(0);
-
     private static final String JCR_RESULT_EVENT_TYPE = "sling/clam/jcr/result";
 
     private final Logger logger = LoggerFactory.getLogger(ClamEventsServlet.class);
@@ -190,8 +187,7 @@ public final class ClamEventsServlet extends HttpServlet implements JcrPropertyS
         }
 
         private void addEvent(final Event event) {
-            final long count = counter.incrementAndGet();
-            logger.debug("adding event: {}", count);
+            logger.debug("adding event: {}", event);
             events.add(event);
             try {
                 onWritePossible();

[sling-org-apache-sling-clam] 17/44: [checkstyle] (coding) MissingCtor

Posted by ol...@apache.org.
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 9e01fa08a42dc597835cc9bff448654fc1a562eb
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Nov 5 20:36:07 2021 +0100

    [checkstyle] (coding) MissingCtor
---
 .../java/org/apache/sling/clam/http/internal/ClamEventsServlet.java    | 3 +++
 1 file changed, 3 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 b016e52..50697a4 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
@@ -83,6 +83,9 @@ public final class ClamEventsServlet extends HttpServlet implements JcrPropertyS
 
     private final Logger logger = LoggerFactory.getLogger(ClamEventsServlet.class);
 
+    public ClamEventsServlet() { //
+    }
+
     @Override
     protected void doGet(final HttpServletRequest request, final HttpServletResponse response) throws ServletException, IOException {
         response.setCharacterEncoding(StandardCharsets.UTF_8.name());

[sling-org-apache-sling-clam] 36/44: SLING-11222 Update to Sling Bundle Parent 47

Posted by ol...@apache.org.
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 062769f98e6481de94ae7282bd5e0e7424a70ba1
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 16:46:35 2022 +0200

    SLING-11222 Update to Sling Bundle Parent 47
---
 pom.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pom.xml b/pom.xml
index 2a7f87d..e5be814 100644
--- a/pom.xml
+++ b/pom.xml
@@ -24,7 +24,7 @@
   <parent>
     <groupId>org.apache.sling</groupId>
     <artifactId>sling-bundle-parent</artifactId>
-    <version>46</version>
+    <version>47</version>
     <relativePath />
   </parent>
 

[sling-org-apache-sling-clam] 37/44: [pmd] UnusedPrivateMethod

Posted by ol...@apache.org.
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 79d7c76d14e2e8a3e8ba645b438f8249b6c28ce6
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 20:08:52 2022 +0200

    [pmd] UnusedPrivateMethod
---
 .../java/org/apache/sling/clam/http/internal/ClamJcrScanServlet.java   | 3 +++
 .../apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java | 3 +++
 .../sling/clam/result/internal/EventPublishingScanResultHandler.java   | 3 +++
 .../sling/clam/result/internal/MailSendingScanResultHandler.java       | 3 +++
 .../clam/result/internal/ResourcePersistingScanResultHandler.java      | 3 +++
 5 files changed, 15 insertions(+)

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 cc7d18e..6b4b5e6 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
@@ -90,6 +90,7 @@ public final class ClamJcrScanServlet extends SlingAllMethodsServlet {
     }
 
     @Activate
+    @SuppressWarnings("unused")
     private void activate(final ClamJcrScanServletConfiguration configuration) throws Exception {
         logger.debug("activating");
         this.configuration = configuration;
@@ -97,6 +98,7 @@ public final class ClamJcrScanServlet extends SlingAllMethodsServlet {
     }
 
     @Modified
+    @SuppressWarnings("unused")
     private void modified(final ClamJcrScanServletConfiguration configuration) throws Exception {
         logger.debug("modifying");
         this.configuration = configuration;
@@ -104,6 +106,7 @@ public final class ClamJcrScanServlet extends SlingAllMethodsServlet {
     }
 
     @Deactivate
+    @SuppressWarnings("unused")
     private void deactivate() {
         logger.debug("deactivating");
         configuration = null;
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 3a2e2b2..9d754ce 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
@@ -107,6 +107,7 @@ public final class NodeObservingJcrPropertyDigger extends NodeObserver {
     }
 
     @Activate
+    @SuppressWarnings("unused")
     private void activate(final NodeObservingJcrPropertyDiggerConfiguration configuration) {
         logger.debug("activating");
         this.configuration = configuration;
@@ -115,6 +116,7 @@ public final class NodeObservingJcrPropertyDigger extends NodeObserver {
     }
 
     @Modified
+    @SuppressWarnings("unused")
     private void modified(final NodeObservingJcrPropertyDiggerConfiguration configuration) {
         logger.debug("modifying");
         this.configuration = configuration;
@@ -122,6 +124,7 @@ public final class NodeObservingJcrPropertyDigger extends NodeObserver {
     }
 
     @Deactivate
+    @SuppressWarnings("unused")
     private void deactivate() {
         logger.debug("deactivating");
         threadPoolManager.release(threadPool);
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 612c894..1b60503 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
@@ -70,18 +70,21 @@ public final class EventPublishingScanResultHandler implements JcrPropertyScanRe
     }
 
     @Activate
+    @SuppressWarnings("unused")
     private void activate(final EventPublishingScanResultHandlerConfiguration configuration) {
         logger.debug("activating");
         this.configuration = configuration;
     }
 
     @Modified
+    @SuppressWarnings("unused")
     private void modified(final EventPublishingScanResultHandlerConfiguration configuration) {
         logger.debug("modifying");
         this.configuration = configuration;
     }
 
     @Deactivate
+    @SuppressWarnings("unused")
     private void deactivate() {
         logger.debug("deactivating");
         this.configuration = null;
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 d14be90..0e6f198 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
@@ -86,18 +86,21 @@ public final class MailSendingScanResultHandler implements JcrPropertyScanResult
     }
 
     @Activate
+    @SuppressWarnings("unused")
     private void activate(final MailSendingScanResultHandlerConfiguration configuration) {
         logger.debug("activating");
         this.configuration = configuration;
     }
 
     @Modified
+    @SuppressWarnings("unused")
     private void modified(final MailSendingScanResultHandlerConfiguration configuration) {
         logger.debug("modifying");
         this.configuration = configuration;
     }
 
     @Deactivate
+    @SuppressWarnings("unused")
     private void deactivate() {
         logger.debug("deactivating");
         this.configuration = null;
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 46d81da..d53b5f4 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
@@ -104,18 +104,21 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
     }
 
     @Activate
+    @SuppressWarnings("unused")
     private void activate(final ResourcePersistingScanResultHandlerConfiguration configuration) {
         logger.debug("activating");
         this.configuration = configuration;
     }
 
     @Modified
+    @SuppressWarnings("unused")
     private void modified(final ResourcePersistingScanResultHandlerConfiguration configuration) {
         logger.debug("modifying");
         this.configuration = configuration;
     }
 
     @Deactivate
+    @SuppressWarnings("unused")
     private void deactivate() {
         logger.debug("deactivating");
         this.configuration = null;

[sling-org-apache-sling-clam] 44/44: [spotbugs] exclude RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE

Posted by ol...@apache.org.
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 c9adaa70173b7266dd4e0c915fd784e66381c902
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 21:48:58 2022 +0200

    [spotbugs] exclude RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE
---
 spotbugs-exclude.xml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml
index 38d5c44..6eb3ea0 100644
--- a/spotbugs-exclude.xml
+++ b/spotbugs-exclude.xml
@@ -33,4 +33,10 @@
     <Class name="org.apache.sling.clam.oak.internal.NodeObservingJcrPropertyDigger$DigTask"/>
     <Method name="run"/>
   </Match>
+  <Match>
+    <!-- https://github.com/spotbugs/spotbugs/issues/868 -->
+    <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
+    <Class name="org.apache.sling.clam.http.internal.ResponseUtil"/>
+    <Method name="handleError"/>
+  </Match>
 </FindBugsFilter>

[sling-org-apache-sling-clam] 06/44: [checkstyle] (modifier) RedundantModifier

Posted by ol...@apache.org.
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 3b2ae21d1b57f034ac8a1a1f91aa938732dff95b
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Oct 27 23:36:14 2021 +0200

    [checkstyle] (modifier) RedundantModifier
---
 src/main/java/org/apache/sling/clam/http/internal/ResponseUtil.java | 2 +-
 .../apache/sling/clam/job/internal/JcrPropertyScanJobConsumer.java  | 6 +++---
 .../sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java     | 2 +-
 .../clam/result/internal/ResourcePersistingScanResultHandler.java   | 2 +-
 4 files changed, 6 insertions(+), 6 deletions(-)

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 79f31d9..1baada6 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
@@ -46,7 +46,7 @@ public final class ResponseUtil {
             if (message != null) {
                 final JsonObjectBuilder error = Json.createObjectBuilder();
                 error.add("message", message);
-                try (final JsonGenerator generator = Json.createGenerator(response.getWriter())) {
+                try (JsonGenerator generator = Json.createGenerator(response.getWriter())) {
                     generator.write(error.build()).flush();
                 }
             }
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 498d3be..e6217ad 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
@@ -89,7 +89,7 @@ public final class JcrPropertyScanJobConsumer implements JobConsumer {
 
     @Override
     public JobResult process(final Job job) {
-        try (final ResourceResolver resourceResolver = resourceResolverFactory.getServiceResourceResolver(null)) {
+        try (ResourceResolver resourceResolver = resourceResolverFactory.getServiceResourceResolver(null)) {
             final String path = job.getProperty(ClamUtil.PROPERTY_PATH, String.class);
             final String userId = job.getProperty(ClamUtil.USER_ID, String.class);
             final Session session = resourceResolver.adaptTo(Session.class);
@@ -100,13 +100,13 @@ public final class JcrPropertyScanJobConsumer implements JobConsumer {
                 final int index = job.getProperty(ClamUtil.VALUE_INDEX, Integer.class);
                 final Value[] values = property.getValues();
                 final Value value = values[index];
-                try (final InputStream inputStream = getInputStream(value)) {
+                try (InputStream inputStream = getInputStream(value)) {
                     logger.debug("scanning property of type {} at {} [{}]", PropertyType.nameFromValue(propertyType), path, index);
                     final ScanResult scanResult = clamService.scan(inputStream);
                     invokeScanResultHandlers(scanResult, path, index, propertyType, userId);
                 }
             } else { // single property value
-                try (final InputStream inputStream = getInputStream(property.getValue())) {
+                try (InputStream inputStream = getInputStream(property.getValue())) {
                     logger.debug("scanning property of type {} at {}", PropertyType.nameFromValue(propertyType), path);
                     final ScanResult scanResult = clamService.scan(inputStream);
                     invokeScanResultHandlers(scanResult, path, null, propertyType, userId);
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 7c20c01..bb8c3b1 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
@@ -197,7 +197,7 @@ public final class NodeObservingJcrPropertyDigger extends NodeObserver {
         @Override
         public void run() {
             final Set<String> paths = filter(path, names, pattern);
-            try (final ResourceResolver resourceResolver = resourceResolverFactory.getServiceResourceResolver(null)) {
+            try (ResourceResolver resourceResolver = resourceResolverFactory.getServiceResourceResolver(null)) {
                 final Session session = resourceResolver.adaptTo(Session.class);
                 assert session != null;
                 for (final String path : paths) {
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 a3af1a1..a668f3c 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
@@ -137,7 +137,7 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
     }
 
     private void persistResult(@NotNull ScanResult scanResult, @NotNull String path, Integer index, int propertyType, @Nullable String userId) {
-        try (final ResourceResolver resourceResolver = serviceResourceResolver()) {
+        try (ResourceResolver resourceResolver = serviceResourceResolver()) {
             final Map<String, Object> properties = properties(path, index, userId, scanResult);
             properties.put(JCR_PRIMARYTYPE, NT_UNSTRUCTURED);
             properties.put(JCR_MIXINTYPES, MIX_CREATED);

[sling-org-apache-sling-clam] 16/44: [checkstyle] (javadoc) MissingJavadocMethod

Posted by ol...@apache.org.
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 bd77316a908755c24d76a940174e34b50ab07cfe
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri Nov 5 20:31:48 2021 +0100

    [checkstyle] (javadoc) MissingJavadocMethod
---
 checkstyle-suppressions.xml | 23 +++++++++++++++++++++++
 pom.xml                     |  2 ++
 2 files changed, 25 insertions(+)

diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
new file mode 100644
index 0000000..12cdfea
--- /dev/null
+++ b/checkstyle-suppressions.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you 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.
+-->
+<!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+<suppressions>
+  <suppress checks="MissingJavadocMethod" files=".*\/internal\/.*\.java"/>
+</suppressions>
diff --git a/pom.xml b/pom.xml
index 77d8d85..fcc8768 100644
--- a/pom.xml
+++ b/pom.xml
@@ -100,6 +100,8 @@
         </dependencies>
         <configuration>
           <configLocation>checks.xml</configLocation>
+          <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
+          <suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExpression>
         </configuration>
         <executions>
           <execution>

[sling-org-apache-sling-clam] 29/44: [checkstyle] (metrics) CyclomaticComplexity

Posted by ol...@apache.org.
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 f7c87f2b7c0513fc232c24740390a879e18bfc9c
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 15:36:09 2022 +0200

    [checkstyle] (metrics) CyclomaticComplexity
---
 .../sling/clam/jcr/internal/DefaultNodeDescendingJcrPropertyDigger.java | 2 +-
 .../apache/sling/clam/result/internal/MailSendingScanResultHandler.java | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

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 fb2c8b9..29bf2b4 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
@@ -71,7 +71,7 @@ public final class DefaultNodeDescendingJcrPropertyDigger implements NodeDescend
         _dig(node, pattern, propertyTypes, maxLength, absoluteMaxDepth);
     }
 
-    @SuppressWarnings("checkstyle:NestedIfDepth")
+    @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:NestedIfDepth"})
     private void _dig(@NotNull final Node node, @NotNull final Pattern pattern, @NotNull final Set<Integer> propertyTypes, final long maxLength, final int maxDepth) throws Exception {
         final PropertyIterator properties = node.getProperties();
         while (properties.hasNext()) {
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 98c230f..29f11e9 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
@@ -133,7 +133,7 @@ public final class MailSendingScanResultHandler implements JcrPropertyScanResult
         return !scanResult.isOk() || configuration.result_status_ok_send();
     }
 
-    @SuppressWarnings("checkstyle:ExecutableStatementCount")
+    @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:ExecutableStatementCount"})
     private void sendMail(final Map<String, Object> properties) throws Exception {
         final MailService mailService = this.mailService;
         final MessageBuilder builder = mailService.getMessageBuilder();

[sling-org-apache-sling-clam] 31/44: [checkstyle] (metrics) ClassFanOutComplexity

Posted by ol...@apache.org.
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 cfa1950f201247752e2a315a5d214badab853b00
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 15:43:13 2022 +0200

    [checkstyle] (metrics) ClassFanOutComplexity
---
 .../apache/sling/clam/result/internal/MailSendingScanResultHandler.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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 92eeac8..d14be90 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
@@ -67,7 +67,7 @@ import static org.apache.sling.clam.internal.ClamUtil.properties;
     ocd = MailSendingScanResultHandlerConfiguration.class,
     factory = true
 )
-@SuppressWarnings("java:S3077")
+@SuppressWarnings({"java:S3077", "checkstyle:ClassFanOutComplexity"})
 public final class MailSendingScanResultHandler implements JcrPropertyScanResultHandler {
 
     @Reference(

[sling-org-apache-sling-clam] 03/44: SLING-10893 Enable code checks with SpotBugs

Posted by ol...@apache.org.
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 6d5cad6524ccf995c987679f9872ffd9018f03c7
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Oct 27 23:13:56 2021 +0200

    SLING-10893 Enable code checks with SpotBugs
---
 pom.xml | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/pom.xml b/pom.xml
index e632c62..0f9e773 100644
--- a/pom.xml
+++ b/pom.xml
@@ -126,6 +126,28 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>com.github.spotbugs</groupId>
+        <artifactId>spotbugs-maven-plugin</artifactId>
+        <version>4.4.2.2</version>
+        <configuration>
+          <plugins>
+            <plugin>
+              <groupId>com.h3xstream.findsecbugs</groupId>
+              <artifactId>findsecbugs-plugin</artifactId>
+              <version>1.11.0</version>
+            </plugin>
+          </plugins>
+        </configuration>
+        <executions>
+          <execution>
+            <phase>process-classes</phase>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

[sling-org-apache-sling-clam] 43/44: [spotbugs] exclude REC_CATCH_EXCEPTION

Posted by ol...@apache.org.
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 5d1c45e179480c1b46dd5616ff47d5c759d5bec8
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 21:30:29 2022 +0200

    [spotbugs] exclude REC_CATCH_EXCEPTION
---
 spotbugs-exclude.xml | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml
index 91896a4..38d5c44 100644
--- a/spotbugs-exclude.xml
+++ b/spotbugs-exclude.xml
@@ -28,4 +28,9 @@
     <Class name="org.apache.sling.clam.http.internal.ClamEventsServlet$Client"/>
     <Method name="onWritePossible"/>
   </Match>
+  <Match>
+    <Bug pattern="REC_CATCH_EXCEPTION"/>
+    <Class name="org.apache.sling.clam.oak.internal.NodeObservingJcrPropertyDigger$DigTask"/>
+    <Method name="run"/>
+  </Match>
 </FindBugsFilter>

[sling-org-apache-sling-clam] 07/44: [checkstyle] (misc) FinalParameters

Posted by ol...@apache.org.
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 18d7faa555f7fe4ea88deec628fb23c20314efae
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Oct 27 23:48:26 2021 +0200

    [checkstyle] (misc) FinalParameters
---
 src/main/java/org/apache/sling/clam/http/internal/ResponseUtil.java | 2 +-
 .../sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java     | 2 +-
 .../clam/result/internal/EventPublishingScanResultHandler.java      | 4 ++--
 .../sling/clam/result/internal/MailSendingScanResultHandler.java    | 4 ++--
 .../clam/result/internal/ResourcePersistingScanResultHandler.java   | 6 +++---
 5 files changed, 9 insertions(+), 9 deletions(-)

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 1baada6..879c814 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
@@ -55,7 +55,7 @@ public final class ResponseUtil {
         }
     }
 
-    static String json(@NotNull ScanResult scanResult, @NotNull String path, @Nullable Integer index, int propertyType, @Nullable String userId) {
+    static String json(@NotNull final ScanResult scanResult, @NotNull final String path, @Nullable final Integer index, final int propertyType, @Nullable final String userId) {
         final JsonObjectBuilder event = Json.createObjectBuilder();
         event.add("timestamp", scanResult.getTimestamp());
         event.add("status", scanResult.getStatus().name());
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 bb8c3b1..7880744 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
@@ -165,7 +165,7 @@ public final class NodeObservingJcrPropertyDigger extends NodeObserver {
         return paths;
     }
 
-    private Set<String> concat(final Set<String> a, Set<String> b) {
+    private Set<String> concat(final Set<String> a, final Set<String> b) {
         final Set<String> set = new HashSet<>(a);
         set.addAll(b);
         return set;
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 c16d15e..6b33cf0 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
@@ -85,7 +85,7 @@ public final class EventPublishingScanResultHandler implements JcrPropertyScanRe
     }
 
     @Override
-    public void handleJcrPropertyScanResult(@NotNull ScanResult scanResult, @NotNull String path, int propertyType, @Nullable String userId) {
+    public void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int propertyType, @Nullable final String userId) {
         if (checkPublish(scanResult)) {
             final Event event = new Event(resultEventTopic(propertyType), properties(path, userId, scanResult));
             eventAdmin.postEvent(event);
@@ -93,7 +93,7 @@ public final class EventPublishingScanResultHandler implements JcrPropertyScanRe
     }
 
     @Override
-    public void handleJcrPropertyScanResult(@NotNull ScanResult scanResult, @NotNull String path, int index, int propertyType, @Nullable String userId) {
+    public void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int index, final int propertyType, @Nullable final String userId) {
         if (checkPublish(scanResult)) {
             final Event event = new Event(resultEventTopic(propertyType), properties(path, index, userId, scanResult));
             eventAdmin.postEvent(event);
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 486753e..d8fb738 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
@@ -101,7 +101,7 @@ public final class MailSendingScanResultHandler implements JcrPropertyScanResult
     }
 
     @Override
-    public void handleJcrPropertyScanResult(@NotNull ScanResult scanResult, @NotNull String path, int propertyType, @Nullable String userId) {
+    public void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int propertyType, @Nullable final String userId) {
         if (checkPublish(scanResult)) {
             final Map<String, Object> properties = properties(path, userId, scanResult);
             try {
@@ -113,7 +113,7 @@ public final class MailSendingScanResultHandler implements JcrPropertyScanResult
     }
 
     @Override
-    public void handleJcrPropertyScanResult(@NotNull ScanResult scanResult, @NotNull String path, int index, int propertyType, @Nullable String userId) {
+    public void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int index, final int propertyType, @Nullable final String userId) {
         if (checkPublish(scanResult)) {
             final Map<String, Object> properties = properties(path, index, userId, scanResult);
             try {
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 a668f3c..d9c3eb1 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
@@ -119,14 +119,14 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
     }
 
     @Override
-    public void handleJcrPropertyScanResult(@NotNull ScanResult scanResult, @NotNull String path, int propertyType, @Nullable String userId) {
+    public void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int propertyType, @Nullable final String userId) {
         if (checkPersist(scanResult)) {
             persistResult(scanResult, path, null, propertyType, userId);
         }
     }
 
     @Override
-    public void handleJcrPropertyScanResult(@NotNull ScanResult scanResult, @NotNull String path, int index, int propertyType, @Nullable String userId) {
+    public void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int index, final int propertyType, @Nullable final String userId) {
         if (checkPersist(scanResult)) {
             persistResult(scanResult, path, index, propertyType, userId);
         }
@@ -136,7 +136,7 @@ public final class ResourcePersistingScanResultHandler implements JcrPropertySca
         return !scanResult.isOk() || configuration.result_status_ok_persist();
     }
 
-    private void persistResult(@NotNull ScanResult scanResult, @NotNull String path, Integer index, int propertyType, @Nullable String userId) {
+    private void persistResult(@NotNull final ScanResult scanResult, @NotNull final String path, final Integer index, final int propertyType, @Nullable final String userId) {
         try (ResourceResolver resourceResolver = serviceResourceResolver()) {
             final Map<String, Object> properties = properties(path, index, userId, scanResult);
             properties.put(JCR_PRIMARYTYPE, NT_UNSTRUCTURED);

[sling-org-apache-sling-clam] 08/44: [checkstyle] (modifier) InterfaceMemberImpliedModifier

Posted by ol...@apache.org.
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 2227d53bdcba82edd432aa2311e5796545ba0bb5
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Thu Oct 28 00:01:59 2021 +0200

    [checkstyle] (modifier) InterfaceMemberImpliedModifier
---
 pmd-exclude.properties                               | 20 ++++++++++++++++++++
 pom.xml                                              |  1 +
 .../clam/jcr/NodeDescendingJcrPropertyDigger.java    |  2 +-
 .../clam/result/JcrPropertyScanResultHandler.java    |  4 ++--
 4 files changed, 24 insertions(+), 3 deletions(-)

diff --git a/pmd-exclude.properties b/pmd-exclude.properties
new file mode 100644
index 0000000..85cc37e
--- /dev/null
+++ b/pmd-exclude.properties
@@ -0,0 +1,20 @@
+################################################################################
+#
+#    Licensed to the Apache Software Foundation (ASF) under one or more
+#    contributor license agreements.  See the NOTICE file distributed with
+#    this work for additional information regarding copyright ownership.
+#    The ASF licenses this file to You 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.
+#
+################################################################################
+org.apache.sling.clam.jcr.NodeDescendingJcrPropertyDigger=UnnecessaryModifier
+org.apache.sling.clam.result.JcrPropertyScanResultHandler=UnnecessaryModifier
diff --git a/pom.xml b/pom.xml
index 0f9e773..77d8d85 100644
--- a/pom.xml
+++ b/pom.xml
@@ -116,6 +116,7 @@
         <version>3.15.0</version>
         <configuration>
           <targetJdk>${sling.java.version}</targetJdk>
+          <excludeFromFailureFile>pmd-exclude.properties</excludeFromFailureFile>
         </configuration>
         <executions>
           <execution>
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 472bcb8..00d1a40 100644
--- a/src/main/java/org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java
+++ b/src/main/java/org/apache/sling/clam/jcr/NodeDescendingJcrPropertyDigger.java
@@ -37,6 +37,6 @@ public interface NodeDescendingJcrPropertyDigger {
      * @param maxDepth      The maximum depth from entry node for digging
      * @throws Exception if digging in JCR fails
      */
-    void dig(@NotNull final Node node, @NotNull final Pattern pattern, @NotNull final Set<Integer> propertyTypes, final long maxLength, final int maxDepth) throws Exception;
+    public abstract void dig(@NotNull final Node node, @NotNull final Pattern pattern, @NotNull final Set<Integer> propertyTypes, final long maxLength, final int maxDepth) throws Exception;
 
 }
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 291d4c2..fb28ffa 100644
--- a/src/main/java/org/apache/sling/clam/result/JcrPropertyScanResultHandler.java
+++ b/src/main/java/org/apache/sling/clam/result/JcrPropertyScanResultHandler.java
@@ -32,7 +32,7 @@ public interface JcrPropertyScanResultHandler {
      * @param propertyType The type of the scanned property
      * @param userId       The id of the user who added or changed the property
      */
-    void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int propertyType, @Nullable final String userId);
+    public abstract void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int propertyType, @Nullable final String userId);
 
     /**
      * @param scanResult   The scan result from Clam service
@@ -41,6 +41,6 @@ public interface JcrPropertyScanResultHandler {
      * @param propertyType The type of the scanned property
      * @param userId       The id of the user who added or changed the property
      */
-    void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int index, final int propertyType, @Nullable final String userId);
+    public abstract void handleJcrPropertyScanResult(@NotNull final ScanResult scanResult, @NotNull final String path, final int index, final int propertyType, @Nullable final String userId);
 
 }

[sling-org-apache-sling-clam] 10/44: [checkstyle] (javadoc) MissingJavadocPackage

Posted by ol...@apache.org.
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 59cfe24f7918b4110d6ebeea5da58f24cdf40980
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Thu Oct 28 18:09:29 2021 +0200

    [checkstyle] (javadoc) MissingJavadocPackage
---
 src/main/java/org/apache/sling/clam/jcr/package-info.java    | 4 ++++
 src/main/java/org/apache/sling/clam/result/package-info.java | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/src/main/java/org/apache/sling/clam/jcr/package-info.java b/src/main/java/org/apache/sling/clam/jcr/package-info.java
index 9806d85..7a84e8f 100644
--- a/src/main/java/org/apache/sling/clam/jcr/package-info.java
+++ b/src/main/java/org/apache/sling/clam/jcr/package-info.java
@@ -16,6 +16,10 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+
+/**
+ * Provides the API for digging JCR.
+ */
 @Version("1.0.1")
 package org.apache.sling.clam.jcr;
 
diff --git a/src/main/java/org/apache/sling/clam/result/package-info.java b/src/main/java/org/apache/sling/clam/result/package-info.java
index f106c10..4614525 100644
--- a/src/main/java/org/apache/sling/clam/result/package-info.java
+++ b/src/main/java/org/apache/sling/clam/result/package-info.java
@@ -16,6 +16,10 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+
+/**
+ * Provides the API for handling scan results.
+ */
 @Version("1.0.0")
 package org.apache.sling.clam.result;
 

[sling-org-apache-sling-clam] 21/44: [checkstyle] (coding) MultipleStringLiterals

Posted by ol...@apache.org.
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 5ece08fd7ca46d2b284f674979d4ff3ba7fd6bf5
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Tue Nov 16 18:31:39 2021 +0100

    [checkstyle] (coding) MultipleStringLiterals
---
 checkstyle-suppressions.xml | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
index 12cdfea..b55c53c 100644
--- a/checkstyle-suppressions.xml
+++ b/checkstyle-suppressions.xml
@@ -20,4 +20,9 @@
 <!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
 <suppressions>
   <suppress checks="MissingJavadocMethod" files=".*\/internal\/.*\.java"/>
+  <suppress checks="MultipleStringLiterals" files=".*\/ClamEventsServlet\.java"/>
+  <suppress checks="MultipleStringLiterals" files=".*\/ClamEventsServletConfiguration\.java"/>
+  <suppress checks="MultipleStringLiterals" files=".*\/ClamJcrScanServletConfiguration\.java"/>
+  <suppress checks="MultipleStringLiterals" files=".*\/ResponseUtil\.java"/>
+  <suppress checks="MultipleStringLiterals" files=".*\/ClamUtil\.java"/>
 </suppressions>

[sling-org-apache-sling-clam] 32/44: style

Posted by ol...@apache.org.
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 316803316e306fb457ff8297293ebe051ba04fc3
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 15:50:39 2022 +0200

    style
---
 .../DefaultNodeDescendingJcrPropertyDigger.java      | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

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 29bf2b4..22f0675 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
@@ -25,6 +25,7 @@ import javax.jcr.Node;
 import javax.jcr.NodeIterator;
 import javax.jcr.Property;
 import javax.jcr.PropertyIterator;
+import javax.jcr.RepositoryException;
 
 import org.apache.sling.clam.jcr.NodeDescendingJcrPropertyDigger;
 import org.apache.sling.event.jobs.JobManager;
@@ -65,14 +66,21 @@ public final class DefaultNodeDescendingJcrPropertyDigger implements NodeDescend
     public DefaultNodeDescendingJcrPropertyDigger() { //
     }
 
+    private int calculateAbsoluteMaxDepth(@NotNull final Node node, final int maxDepth) throws RepositoryException {
+        if (maxDepth < 0) {
+            return -1;
+        } else {
+            return node.getDepth() + maxDepth;
+        }
+    }
+
     public void dig(@NotNull final Node node, @NotNull final Pattern pattern, @NotNull final Set<Integer> propertyTypes, final long maxLength, final int maxDepth) throws Exception {
-        @SuppressWarnings("checkstyle:AvoidInlineConditionals")
-        final int absoluteMaxDepth = maxDepth < 0 ? -1 : node.getDepth() + maxDepth;
-        _dig(node, pattern, propertyTypes, maxLength, absoluteMaxDepth);
+        final int absoluteMaxDepth = calculateAbsoluteMaxDepth(node, maxDepth);
+        digWithAbsoluteMaxDepth(node, pattern, propertyTypes, maxLength, absoluteMaxDepth);
     }
 
     @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:NestedIfDepth"})
-    private void _dig(@NotNull final Node node, @NotNull final Pattern pattern, @NotNull final Set<Integer> propertyTypes, final long maxLength, final int maxDepth) throws Exception {
+    private void digWithAbsoluteMaxDepth(@NotNull final Node node, @NotNull final Pattern pattern, @NotNull final Set<Integer> propertyTypes, final long maxLength, final int absoluteMaxDepth) throws Exception {
         final PropertyIterator properties = node.getProperties();
         while (properties.hasNext()) {
             final Property property = properties.nextProperty();
@@ -98,10 +106,10 @@ public final class DefaultNodeDescendingJcrPropertyDigger implements NodeDescend
                 }
             }
         }
-        if (maxDepth == -1 || node.getDepth() < maxDepth) {
+        if (absoluteMaxDepth == -1 || node.getDepth() < absoluteMaxDepth) {
             final NodeIterator nodes = node.getNodes();
             while (nodes.hasNext()) {
-                _dig(nodes.nextNode(), pattern, propertyTypes, maxLength, maxDepth);
+                digWithAbsoluteMaxDepth(nodes.nextNode(), pattern, propertyTypes, maxLength, absoluteMaxDepth);
             }
         }
     }

[sling-org-apache-sling-clam] 39/44: [pmd] TooManyStaticImports

Posted by ol...@apache.org.
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 cae468b0b4f8c6921fb386f9f85afe6ed1cd65ea
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 20:40:20 2022 +0200

    [pmd] TooManyStaticImports
---
 pmd-exclude.properties | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/pmd-exclude.properties b/pmd-exclude.properties
index 85cc37e..0b8ff59 100644
--- a/pmd-exclude.properties
+++ b/pmd-exclude.properties
@@ -16,5 +16,7 @@
 #    limitations under the License.
 #
 ################################################################################
+org.apache.sling.clam.http.internal.ClamJcrScanServlet=TooManyStaticImports
 org.apache.sling.clam.jcr.NodeDescendingJcrPropertyDigger=UnnecessaryModifier
 org.apache.sling.clam.result.JcrPropertyScanResultHandler=UnnecessaryModifier
+org.apache.sling.clam.result.internal.ResourcePersistingScanResultHandler=TooManyStaticImports

[sling-org-apache-sling-clam] 40/44: [spotbugs] exclude SE_BAD_FIELD

Posted by ol...@apache.org.
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 34c856ed4a45a3c0c356736d9e48233d2a143d76
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 20:41:38 2022 +0200

    [spotbugs] exclude SE_BAD_FIELD
---
 pom.xml              |  1 +
 spotbugs-exclude.xml | 26 ++++++++++++++++++++++++++
 2 files changed, 27 insertions(+)

diff --git a/pom.xml b/pom.xml
index e5be814..573fbf5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -134,6 +134,7 @@
         <artifactId>spotbugs-maven-plugin</artifactId>
         <version>4.6.0.0</version>
         <configuration>
+          <excludeFilterFile>spotbugs-exclude.xml</excludeFilterFile>
           <plugins>
             <plugin>
               <groupId>com.h3xstream.findsecbugs</groupId>
diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml
new file mode 100644
index 0000000..413764e
--- /dev/null
+++ b/spotbugs-exclude.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you 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.
+-->
+<FindBugsFilter>
+  <Match>
+    <Bug pattern="SE_BAD_FIELD"/>
+    <Class name="org.apache.sling.clam.http.internal.ClamEventsServlet"/>
+    <Field name="clients"/>
+  </Match>
+</FindBugsFilter>

[sling-org-apache-sling-clam] 34/44: SLING-10892 Enable code checks with PMD

Posted by ol...@apache.org.
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 573020c0ecace2beead603425f47681515af305a
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 16:31:33 2022 +0200

    SLING-10892 Enable code checks with PMD
    
    update dependency
---
 pom.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pom.xml b/pom.xml
index ada0d49..4a40f85 100644
--- a/pom.xml
+++ b/pom.xml
@@ -115,7 +115,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-pmd-plugin</artifactId>
-        <version>3.15.0</version>
+        <version>3.16.0</version>
         <configuration>
           <targetJdk>${sling.java.version}</targetJdk>
           <excludeFromFailureFile>pmd-exclude.properties</excludeFromFailureFile>

[sling-org-apache-sling-clam] 42/44: [spotbugs] exclude VA_FORMAT_STRING_USES_NEWLINE

Posted by ol...@apache.org.
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 b6acb9196e726276947d51806d375025ad40766a
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sun Mar 27 21:01:34 2022 +0200

    [spotbugs] exclude VA_FORMAT_STRING_USES_NEWLINE
---
 spotbugs-exclude.xml | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml
index 413764e..91896a4 100644
--- a/spotbugs-exclude.xml
+++ b/spotbugs-exclude.xml
@@ -23,4 +23,9 @@
     <Class name="org.apache.sling.clam.http.internal.ClamEventsServlet"/>
     <Field name="clients"/>
   </Match>
+  <Match>
+    <Bug pattern="VA_FORMAT_STRING_USES_NEWLINE"/>
+    <Class name="org.apache.sling.clam.http.internal.ClamEventsServlet$Client"/>
+    <Method name="onWritePossible"/>
+  </Match>
 </FindBugsFilter>