SLING-7877 Provide Clam support for Sling
authorOliver Lietz <olli@apache.org>
Sat, 1 Sep 2018 13:46:18 +0000 (15:46 +0200)
committerOliver Lietz <olli@apache.org>
Sat, 1 Sep 2018 13:46:18 +0000 (15:46 +0200)
rename JcrPropertyDigger to NodeObservingJcrPropertyDigger

README.md
src/main/java/org/apache/sling/clam/oak/internal/NodeObservingJcrPropertyDigger.java [moved from src/main/java/org/apache/sling/clam/oak/internal/JcrPropertyDigger.java with 92% similarity]
src/main/java/org/apache/sling/clam/oak/internal/NodeObservingJcrPropertyDiggerConfiguration.java [moved from src/main/java/org/apache/sling/clam/oak/internal/JcrPropertyDiggerConfiguration.java with 94% similarity]

index 277f9d4..642a345 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ This module provides support for Clam in Sling.
 
 ## Finding data to scan for malware
 
-`JcrPropertyDigger` observes Oak's NodeStore, digs properties based on type, path and length and creates scan jobs.
+`NodeObservingJcrPropertyDigger` observes Oak's NodeStore, digs properties based on type, path and length and creates scan jobs.
 
 **NOTE**: Ensure to exclude scan jobs in `/var/eventing` and scan results in `/var/clam/results` from scanning.
 
@@ -58,15 +58,15 @@ import static org.apache.sling.clam.internal.ClamUtil.scanJobTopic;
 @Component(
     immediate = true,
     property = {
-        Constants.SERVICE_DESCRIPTION + "=Apache Sling Clam JCR Property Digger",
+        Constants.SERVICE_DESCRIPTION + "=Apache Sling Clam Node Observing JCR Property Digger",
         Constants.SERVICE_VENDOR + "=The Apache Software Foundation"
     }
 )
 @Designate(
-    ocd = JcrPropertyDiggerConfiguration.class,
+    ocd = NodeObservingJcrPropertyDiggerConfiguration.class,
     factory = true
 )
-public class JcrPropertyDigger extends NodeObserver {
+public class NodeObservingJcrPropertyDigger extends NodeObserver {
 
     @Reference
     private volatile NodeStore nodeStore;
@@ -100,16 +100,16 @@ public class JcrPropertyDigger extends NodeObserver {
 
     private Closeable closeable;
 
-    private JcrPropertyDiggerConfiguration configuration;
+    private NodeObservingJcrPropertyDiggerConfiguration configuration;
 
-    private final Logger logger = LoggerFactory.getLogger(JcrPropertyDigger.class);
+    private final Logger logger = LoggerFactory.getLogger(NodeObservingJcrPropertyDigger.class);
 
-    public JcrPropertyDigger() {
+    public NodeObservingJcrPropertyDigger() {
         super("/");
     }
 
     @Activate
-    private void activate(final JcrPropertyDiggerConfiguration configuration) {
+    private void activate(final NodeObservingJcrPropertyDiggerConfiguration configuration) {
         logger.debug("activating");
         this.configuration = configuration;
         configure(configuration);
@@ -119,7 +119,7 @@ public class JcrPropertyDigger extends NodeObserver {
     }
 
     @Modified
-    private void modified(final JcrPropertyDiggerConfiguration configuration) {
+    private void modified(final NodeObservingJcrPropertyDiggerConfiguration configuration) {
         logger.debug("modifying");
         this.configuration = configuration;
         configure(configuration);
@@ -137,7 +137,7 @@ public class JcrPropertyDigger extends NodeObserver {
         configuration = null;
     }
 
-    private void configure(final JcrPropertyDiggerConfiguration configuration) {
+    private void configure(final NodeObservingJcrPropertyDiggerConfiguration configuration) {
         pattern = Pattern.compile(configuration.property_path_pattern());
         propertyType = PropertyType.valueFromName(configuration.property_type());
     }
@@ -24,10 +24,10 @@ import org.osgi.service.metatype.annotations.ObjectClassDefinition;
 import org.osgi.service.metatype.annotations.Option;
 
 @ObjectClassDefinition(
-    name = "Apache Sling Clam JCR Property Digger",
+    name = "Apache Sling Clam Node Observing JCR Property Digger",
     description = "Observes the node store and adds scan jobs for matching JCR properties"
 )
-@interface JcrPropertyDiggerConfiguration {
+@interface NodeObservingJcrPropertyDiggerConfiguration {
 
     @AttributeDefinition(
         name = "property type",