You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cs...@apache.org on 2019/10/23 07:07:12 UTC

[sling-org-apache-sling-distribution-journal] branch master updated: SLING-8797 - static analysis improvements (javadoc, logs, etc.) (#13)

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

cschneider pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-distribution-journal.git


The following commit(s) were added to refs/heads/master by this push:
     new 0b977db  SLING-8797 - static analysis improvements (javadoc, logs, etc.) (#13)
0b977db is described below

commit 0b977dbd4782291c14f4173e76ef1451568100a2
Author: Tommaso Teofili <to...@apache.org>
AuthorDate: Wed Oct 23 09:07:03 2019 +0200

    SLING-8797 - static analysis improvements (javadoc, logs, etc.) (#13)
---
 .../sling/distribution/journal/impl/event/DistributionEvent.java  | 2 +-
 .../distribution/journal/impl/publisher/DistPublisherJMX.java     | 2 +-
 .../journal/impl/publisher/PackageDistributedNotifier.java        | 4 ++--
 .../journal/impl/publisher/PackageQueuedNotifier.java             | 2 +-
 .../sling/distribution/journal/impl/queue/QueueItemFactory.java   | 2 +-
 .../sling/distribution/journal/impl/queue/impl/PubQueue.java      | 2 +-
 .../sling/distribution/journal/impl/queue/impl/PubQueueCache.java | 4 ++--
 .../sling/distribution/journal/impl/queue/impl/RangePoller.java   | 2 +-
 .../journal/impl/shared/DistributionMetricsService.java           | 6 +++---
 .../distribution/journal/impl/shared/PackageViewerPlugin.java     | 6 +++---
 .../journal/impl/subscriber/ContentPackageExtractor.java          | 8 ++++----
 .../journal/impl/subscriber/DistributionSubscriber.java           | 3 +--
 .../distribution/journal/impl/subscriber/PackageHandling.java     | 2 +-
 .../journal/impl/subscriber/PackageStatusWatcher.java             | 5 ++---
 14 files changed, 24 insertions(+), 26 deletions(-)

diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/event/DistributionEvent.java b/src/main/java/org/apache/sling/distribution/journal/impl/event/DistributionEvent.java
index 7e55199..77cf31c 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/event/DistributionEvent.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/event/DistributionEvent.java
@@ -69,7 +69,7 @@ public class DistributionEvent {
         List<String> pathsList = pkgMsg.getPathsList();
         return buildEvent(topic, kind, agentName,
                 pkgMsg.getReqType().name(),
-                pathsList.toArray(new String[pathsList.size()]),
+                pathsList.toArray(new String[0]),
                 pkgMsg.getPkgId());
     }
 
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/publisher/DistPublisherJMX.java b/src/main/java/org/apache/sling/distribution/journal/impl/publisher/DistPublisherJMX.java
index 61b50a1..e471ee6 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/publisher/DistPublisherJMX.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/publisher/DistPublisherJMX.java
@@ -86,7 +86,7 @@ class DistPublisherJMX extends StandardMBean implements DistPublisherJMXMBean {
             if (queue != null) {
                 for (DistributionQueueEntry item : queue.getEntries(0, 1000)) {
                     CompositeData row = new CompositeDataSupport(rowType, itemNames,
-                            new Object[] { item.getId(), (Long)item.getItem().get("offset") });
+                            new Object[] { item.getId(), item.getItem().get("offset")});
                     table.put(row);
                 }
             }
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/publisher/PackageDistributedNotifier.java b/src/main/java/org/apache/sling/distribution/journal/impl/publisher/PackageDistributedNotifier.java
index 09713bd..591a0cf 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/publisher/PackageDistributedNotifier.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/publisher/PackageDistributedNotifier.java
@@ -85,8 +85,8 @@ public class PackageDistributedNotifier implements TopologyChangeHandler {
     }
 
     /**
-     * 
-     * @param offsetsSupplier range of offsets, from smallest offset to largest offset.
+     * @param  pubAgentName the name of the publisher agent
+     * @param offsets range of offsets, from smallest offset to largest offset.
      */
     private void processOffsets(String pubAgentName, Supplier<LongStream> offsets) {
         long minOffset = offsets.get().findFirst().getAsLong();
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/publisher/PackageQueuedNotifier.java b/src/main/java/org/apache/sling/distribution/journal/impl/publisher/PackageQueuedNotifier.java
index 0d59254..29c559e 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/publisher/PackageQueuedNotifier.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/publisher/PackageQueuedNotifier.java
@@ -53,7 +53,7 @@ public class PackageQueuedNotifier implements EventHandler {
     @Deactivate
     public void deactivate() {
         receiveCallbacks.forEach((packageId, callback) -> {
-            LOG.debug("Cancel wait condition for package", packageId);
+            LOG.debug("Cancel wait condition for package {}", packageId);
             callback.cancel(true);
         });
         LOG.info("Package queue notifier service stopped");
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/queue/QueueItemFactory.java b/src/main/java/org/apache/sling/distribution/journal/impl/queue/QueueItemFactory.java
index 3638123..5296b62 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/queue/QueueItemFactory.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/queue/QueueItemFactory.java
@@ -99,6 +99,6 @@ public final class QueueItemFactory {
 
 	@Nonnull
     private static String[] toArray(List<String> paths) {
-        return paths.isEmpty() ? new String[]{} : paths.toArray(new String[paths.size()]);
+        return paths.isEmpty() ? new String[]{} : paths.toArray(new String[0]);
     }
 }
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/PubQueue.java b/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/PubQueue.java
index c767b11..b6874c5 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/PubQueue.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/PubQueue.java
@@ -53,7 +53,7 @@ public class PubQueue implements DistributionQueue {
 
     private final String queueName;
 
-    private Set<String> capabilities = new HashSet<>();
+    private final Set<String> capabilities = new HashSet<>();
 
     private final OffsetQueue<DistributionQueueItem> offsetQueue;
 
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/PubQueueCache.java b/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/PubQueueCache.java
index 89a001f..5128dc6 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/PubQueueCache.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/PubQueueCache.java
@@ -116,7 +116,7 @@ public class PubQueueCache {
 
     private final String topic;
 
-    private DistributionMetricsService distributionMetricsService;
+    private final DistributionMetricsService distributionMetricsService;
 
     /**
      * Way out for the threads awaiting on the seeded
@@ -124,7 +124,7 @@ public class PubQueueCache {
      */
     private volatile boolean closed;
 
-    private Thread seeder;
+    private final Thread seeder;
 
 
     public PubQueueCache(MessagingProvider messagingProvider, EventAdmin eventAdmin, DistributionMetricsService distributionMetricsService, String topic) {
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/RangePoller.java b/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/RangePoller.java
index 850d4d6..194439b 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/RangePoller.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/queue/impl/RangePoller.java
@@ -51,7 +51,7 @@ public class RangePoller {
 
     private final CountDownLatch fetched = new CountDownLatch(1);
 
-    private List<FullMessage<PackageMessage>> messages;
+    private final List<FullMessage<PackageMessage>> messages;
     
     public RangePoller(MessagingProvider messagingProvider,
                           String packageTopic,
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/shared/DistributionMetricsService.java b/src/main/java/org/apache/sling/distribution/journal/impl/shared/DistributionMetricsService.java
index c44d2ee..23c09ff 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/shared/DistributionMetricsService.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/shared/DistributionMetricsService.java
@@ -50,7 +50,7 @@ public class DistributionMetricsService {
 
     public static final String SUB_COMPONENT = BASE_COMPONENT + ".subscriber";
     
-    private Logger log = LoggerFactory.getLogger(this.getClass());
+    private final Logger log = LoggerFactory.getLogger(this.getClass());
 
     @Reference
     private MetricsService metricsService;
@@ -327,8 +327,8 @@ public class DistributionMetricsService {
     public class GaugeService<T> implements Gauge<T>, Closeable {
         
         @SuppressWarnings("rawtypes")
-        private ServiceRegistration<Gauge> reg;
-        private Supplier<T> supplier;
+        private final ServiceRegistration<Gauge> reg;
+        private final Supplier<T> supplier;
 
         private GaugeService(String name, String description, Supplier<T> supplier) {
             this.supplier = supplier;
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/shared/PackageViewerPlugin.java b/src/main/java/org/apache/sling/distribution/journal/impl/shared/PackageViewerPlugin.java
index 0ba1ce0..a1648e8 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/shared/PackageViewerPlugin.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/shared/PackageViewerPlugin.java
@@ -77,11 +77,11 @@ public class PackageViewerPlugin extends AbstractWebConsolePlugin {
     
     @Override
     protected void renderContent(HttpServletRequest req, HttpServletResponse res)
-            throws ServletException, IOException {
+            throws IOException {
         Optional<Long> offset = getOffset(req);
         if (!offset.isPresent()) {
             String startOffsetSt = req.getParameter("startOffset");
-            long startOffset = startOffsetSt != null ? new Long(startOffsetSt) : 0;
+            long startOffset = startOffsetSt != null ? Long.parseLong(startOffsetSt) : 0;
             renderPackageList(startOffset, res.getWriter());
         } else {
             writePackage(offset.get(), res);
@@ -136,7 +136,7 @@ public class PackageViewerPlugin extends AbstractWebConsolePlugin {
         int startIndex = LABEL.length() + 2;
         if (startIndex <= req.getPathInfo().length()) {
             String offsetSt = req.getPathInfo().substring(startIndex);
-            return Optional.of(new Long(offsetSt));
+            return Optional.of(Long.valueOf(offsetSt));
         } else {
             return Optional.empty();
         }
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/ContentPackageExtractor.java b/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/ContentPackageExtractor.java
index 401d038..3196a2c 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/ContentPackageExtractor.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/ContentPackageExtractor.java
@@ -44,10 +44,10 @@ import org.slf4j.LoggerFactory;
 public class ContentPackageExtractor {
     private static final String PACKAGE_BASE_PATH = "/etc/packages/";
 
-    private Logger log = LoggerFactory.getLogger(this.getClass());
+    private final Logger log = LoggerFactory.getLogger(this.getClass());
 
-    private Packaging packageService;
-    private PackageHandling packageHandling;
+    private final Packaging packageService;
+    private final PackageHandling packageHandling;
     
     public ContentPackageExtractor(Packaging packageService, PackageHandling packageHandling) {
         this.packageService = packageService;
@@ -69,7 +69,7 @@ public class ContentPackageExtractor {
                         installPackage(path, node);
                     }
                 } else {
-                    log.warn("Imported node does not exist. Skipping.", path);
+                    log.warn("Imported node {} does not exist. Skipping.", path);
                 }
             } catch (RepositoryException e) {
                 log.warn("Error trying check if {} contains a content package to extract.", path, e);
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/DistributionSubscriber.java b/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/DistributionSubscriber.java
index 1694e38..7f18cb4 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/DistributionSubscriber.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/DistributionSubscriber.java
@@ -392,8 +392,7 @@ public class DistributionSubscriber implements DistributionAgent {
     @Nonnull
     @Override
     public DistributionResponse execute(ResourceResolver resourceResolver,
-                                        DistributionRequest request)
-            throws DistributionException {
+                                        DistributionRequest request) {
         return executeUnsupported(request);
     }
 
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/PackageHandling.java b/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/PackageHandling.java
index 0be7ca8..55dc55e 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/PackageHandling.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/PackageHandling.java
@@ -19,5 +19,5 @@
 package org.apache.sling.distribution.journal.impl.subscriber;
 
 public enum PackageHandling {
-    Off, Extract, Install;
+    Off, Extract, Install
 }
diff --git a/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/PackageStatusWatcher.java b/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/PackageStatusWatcher.java
index 22a2824..81063e3 100644
--- a/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/PackageStatusWatcher.java
+++ b/src/main/java/org/apache/sling/distribution/journal/impl/subscriber/PackageStatusWatcher.java
@@ -40,12 +40,11 @@ public class PackageStatusWatcher implements Closeable {
     private static final Logger LOG = LoggerFactory.getLogger(PackageStatusWatcher.class);
 
     private final Closeable poller;
-    private final String topicName;
     private final String subAgentName;
     private final NavigableMap<Long, FullMessage<PackageStatusMessage>> cache = new ConcurrentSkipListMap<>();
 
     public PackageStatusWatcher(MessagingProvider messagingProvider, Topics topics, String subAgentName) {
-        this.topicName = topics.getStatusTopic();
+        String topicName = topics.getStatusTopic();
         this.subAgentName = subAgentName;
 
         poller = messagingProvider.createPoller(
@@ -80,7 +79,7 @@ public class PackageStatusWatcher implements Closeable {
 
     /**
      * Clear all offsets in the cache smaller to the given pkgOffset.
-     * @param pkgOffset
+     * @param pkgOffset package offset
      */
     public void clear(long pkgOffset) {
         NavigableMap<Long, FullMessage<PackageStatusMessage>> removed = cache.headMap(pkgOffset, false);