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 c9f1ef8..b9068f2 100644 (file)
@@ -1,72 +1,84 @@
-/*******************************************************************************\r
- * ============LICENSE_START==================================================\r
- * * org.onap.dmaap\r
- * * ===========================================================================\r
- * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
- * * ===========================================================================\r
- * * Licensed under the Apache License, Version 2.0 (the "License");\r
- * * you may not use this file except in compliance with the License.\r
- * * You may obtain a copy of the License at\r
- * * \r
- *  *      http://www.apache.org/licenses/LICENSE-2.0\r
- * * \r
- *  * Unless required by applicable law or agreed to in writing, software\r
- * * distributed under the License is distributed on an "AS IS" BASIS,\r
- * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * * See the License for the specific language governing permissions and\r
- * * limitations under the License.\r
- * * ============LICENSE_END====================================================\r
- * *\r
- * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
- * *\r
- ******************************************************************************/\r
-\r
-\r
-package org.onap.dmaap.datarouter.node;\r
-\r
-/**\r
- *     Interface to allow independent testing of the DeliveryTask code.\r
- *     <p>\r
- *     This interface represents all the configuraiton information and\r
- *     feedback mechanisms that a delivery task needs.\r
- */\r
-\r
-public interface DeliveryTaskHelper    {\r
-       /**\r
-        *      Report that a delivery attempt failed due to an exception (like can't connect to remote host)\r
-        *      @param task     The task that failed\r
-        *      @param exception        The exception that occurred\r
-        */\r
-       public void reportException(DeliveryTask task, Exception exception);\r
-       /**\r
-        *      Report that a delivery attempt completed (successfully or unsuccessfully)\r
-        *      @param task     The task that failed\r
-        *      @param status   The HTTP status\r
-        *      @param xpubid   The publish ID from the far end (if any)\r
-        *      @param location The redirection location for a 3XX response\r
-        */\r
-       public void reportStatus(DeliveryTask task, int status, String xpubid, String location);\r
-       /**\r
-        *      Report that a delivery attempt either failed while sending data or that an error was returned instead of a 100 Continue.\r
-        *      @param task     The task that failed\r
-        *      @param sent     The number of bytes sent or -1 if an error was returned instead of 100 Continue.\r
-        */\r
-       public void reportDeliveryExtra(DeliveryTask task, long sent);\r
-       /**\r
-        *      Get the destination information for the delivery queue\r
-        *      @return The destination information\r
-        */\r
-       public DestInfo getDestInfo();\r
-       /**\r
-        *      Given a file ID, get the URL to deliver to\r
-        *      @param fileid   The file id\r
-        *      @return The URL to deliver to\r
-        */\r
-       public String   getDestURL(String fileid);\r
-       /**\r
-        *      Get the feed ID for a subscription\r
-        *      @param subid    The subscription ID\r
-        *      @return The feed iD\r
-        */\r
-       public String   getFeedId(String subid);\r
-}\r
+/*******************************************************************************
+ * ============LICENSE_START==================================================
+ * * org.onap.dmaap
+ * * ===========================================================================
+ * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+ * * ===========================================================================
+ * * Licensed 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.
+ * * ============LICENSE_END====================================================
+ * *
+ * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ * *
+ ******************************************************************************/
+
+
+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.
+ */
+
+public interface DeliveryTaskHelper {
+
+    /**
+     * Report that a delivery attempt failed due to an exception (like can't connect to remote host).
+     *
+     * @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).
+     *
+     * @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.
+     *
+     * @param task The task that failed
+     * @param sent The number of bytes sent or -1 if an error was returned instead of 100 Continue.
+     */
+    void reportDeliveryExtra(DeliveryTask task, long sent);
+
+    /**
+     * Get the destination information for the delivery queue.
+     *
+     * @return The destination information
+     */
+    DestInfo getDestinationInfo();
+
+    /**
+     * Given a file ID, get the URL to deliver to.
+     *
+     * @param fileid The file id
+     * @return The URL to deliver to
+     */
+    String getDestURL(String fileid);
+
+    /**
+     * Get the feed ID for a subscription.
+     *
+     * @param subid The subscription ID
+     * @return The feed iD
+     */
+    String getFeedId(String subid);
+}