Remove major and minor code smells in dr-node
[dmaap/datarouter.git] / datarouter-node / src / main / java / org / onap / dmaap / datarouter / node / DeliveryTaskHelper.java
index d4ac8bd..b9068f2 100644 (file)
@@ -26,32 +26,33 @@ package org.onap.dmaap.datarouter.node;
 
 /**
  * Interface to allow independent testing of the DeliveryTask code.
- * <p>
- * This interface represents all the configuraiton information and
- * feedback mechanisms that a delivery task needs.
+ *
+ * <p>This interface represents all the configuraiton information and feedback mechanisms that a delivery task needs.
  */
 
 public interface DeliveryTaskHelper {
+
     /**
-     * Report that a delivery attempt failed due to an exception (like can't connect to remote host)
+     * Report that a delivery attempt failed due to an exception (like can't connect to remote host).
      *
-     * @param task      The task that failed
+     * @param task The task that failed
      * @param exception The exception that occurred
      */
     void reportException(DeliveryTask task, Exception exception);
 
     /**
-     * Report that a delivery attempt completed (successfully or unsuccessfully)
+     * Report that a delivery attempt completed (successfully or unsuccessfully).
      *
-     * @param task     The task that failed
-     * @param status   The HTTP status
-     * @param xpubid   The publish ID from the far end (if any)
+     * @param task The task that failed
+     * @param status The HTTP status
+     * @param xpubid The publish ID from the far end (if any)
      * @param location The redirection location for a 3XX response
      */
     void reportStatus(DeliveryTask task, int status, String xpubid, String location);
 
     /**
-     * Report that a delivery attempt either failed while sending data or that an error was returned instead of a 100 Continue.
+     * Report that a delivery attempt either failed while sending data or that an error was returned instead of a 100
+     * Continue.
      *
      * @param task The task that failed
      * @param sent The number of bytes sent or -1 if an error was returned instead of 100 Continue.
@@ -59,14 +60,14 @@ public interface DeliveryTaskHelper {
     void reportDeliveryExtra(DeliveryTask task, long sent);
 
     /**
-     * Get the destination information for the delivery queue
+     * Get the destination information for the delivery queue.
      *
      * @return The destination information
      */
     DestInfo getDestinationInfo();
 
     /**
-     * Given a file ID, get the URL to deliver to
+     * Given a file ID, get the URL to deliver to.
      *
      * @param fileid The file id
      * @return The URL to deliver to
@@ -74,7 +75,7 @@ public interface DeliveryTaskHelper {
     String getDestURL(String fileid);
 
     /**
-     * Get the feed ID for a subscription
+     * Get the feed ID for a subscription.
      *
      * @param subid The subscription ID
      * @return The feed iD