Fix checkstyle contridictions on datarouter node
[dmaap/datarouter.git] / datarouter-node / src / main / java / org / onap / dmaap / datarouter / node / DeliveryQueueHelper.java
index b1734cd..5427faf 100644 (file)
@@ -26,78 +26,83 @@ package org.onap.dmaap.datarouter.node;
 
 /**
  * Interface to allow independent testing of the DeliveryQueue code
- * <p>
- * This interface represents all of the configuration information and
+ *
+ * <p>This interface represents all of the configuration information and
  * feedback mechanisms that a delivery queue needs.
  */
 public interface DeliveryQueueHelper {
     /**
-     * Get the timeout (milliseconds) before retrying after an initial delivery failure
+     * Get the timeout (milliseconds) before retrying after an initial delivery failure.
      */
-    public long getInitFailureTimer();
+    long getInitFailureTimer();
 
     /**
-     * Get the ratio between timeouts on consecutive delivery attempts
+     * Get the timeout before retrying after delivery and wait for file processing.
      */
-    public double getFailureBackoff();
+    long getWaitForFileProcessFailureTimer();
 
     /**
-     * Get the maximum timeout (milliseconds) between delivery attempts
+     * Get the ratio between timeouts on consecutive delivery attempts.
      */
-    public long getMaxFailureTimer();
+    double getFailureBackoff();
 
     /**
-     * Get the expiration timer (milliseconds) for deliveries
+     * Get the maximum timeout (milliseconds) between delivery attempts.
      */
-    public long getExpirationTimer();
+    long getMaxFailureTimer();
+
+    /**
+     * Get the expiration timer (milliseconds) for deliveries.
+     */
+    long getExpirationTimer();
 
     /**
      * Get the maximum number of file delivery attempts before checking
      * if another queue has work to be performed.
      */
-    public int getFairFileLimit();
+    int getFairFileLimit();
 
     /**
      * Get the maximum amount of time spent delivering files before checking if another queue has work to be performed.
      */
-    public long getFairTimeLimit();
+    long getFairTimeLimit();
 
     /**
-     * Get the URL for delivering a file
+     * Get the URL for delivering a file.
      *
-     * @param dest   The destination information for the file to be delivered.
+     * @param destinationInfo   The destination information for the file to be delivered.
      * @param fileid The file id for the file to be delivered.
-     * @return The URL for delivering the file (typically, dest.getURL() + "/" + fileid).
+     * @return The URL for delivering the file (typically, destinationInfo.getURL() + "/" + fileid).
      */
-    public String getDestURL(DestInfo dest, String fileid);
+    String getDestURL(DestInfo destinationInfo, String fileid);
 
     /**
-     * Forget redirections associated with a subscriber
+     * Forget redirections associated with a subscriber.
      *
-     * @param    dest    Destination information to forget
+     * @param    destinationInfo    Destination information to forget
      */
-    public void handleUnreachable(DestInfo dest);
+    void handleUnreachable(DestInfo destinationInfo);
 
     /**
-     * Post redirection for a subscriber
+     * Post redirection for a subscriber.
      *
-     * @param    dest    Destination information to update
+     * @param    destinationInfo    Destination information to update
      * @param    location    Location given by subscriber
      * @param    fileid    File ID of request
      * @return true if this 3xx response is retryable, otherwise, false.
      */
-    public boolean handleRedirection(DestInfo dest, String location, String fileid);
+    boolean handleRedirection(DestInfo destinationInfo, String location, String fileid);
 
     /**
-     * Should I handle 3xx responses differently than 4xx responses?
+     * Should I handle 3xx responses differently than 4xx responses?.
      */
-    public boolean isFollowRedirects();
+    boolean isFollowRedirects();
 
     /**
-     * Get the feed ID for a subscription
+     * Get the feed ID for a subscription.
      *
      * @param subid The subscription ID
      * @return The feed ID
      */
-    public String getFeedId(String subid);
+    String getFeedId(String subid);
 }