datarouter-node/src/main/java/org/onap/dmaap/datarouter/node/DeliveryTaskHelper.java

   1 /*******************************************************************************
   2  * ============LICENSE_START==================================================
   3  * * org.onap.dmaap
   4  * * ===========================================================================
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * * ===========================================================================
   7  * * Licensed under the Apache License, Version 2.0 (the "License");
   8  * * you may not use this file except in compliance with the License.
   9  * * You may obtain a copy of the License at
  10  * *
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0
  12  * *
  13  *  * Unless required by applicable law or agreed to in writing, software
  14  * * distributed under the License is distributed on an "AS IS" BASIS,
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * * See the License for the specific language governing permissions and
  17  * * limitations under the License.
  18  * * ============LICENSE_END====================================================
  19  * *
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  * *
  22  ******************************************************************************/
  23
  24
  25 package org.onap.dmaap.datarouter.node;
  26
  27 /**
  28  * Interface to allow independent testing of the DeliveryTask code.
  29  *
  30  * <p>This interface represents all the configuraiton information and feedback mechanisms that a delivery task needs.
  31  */
  32
  33 public interface DeliveryTaskHelper {
  34
  35     /**
  36      * Report that a delivery attempt failed due to an exception (like can't connect to remote host).
  37      *
  38      * @param task The task that failed
  39      * @param exception The exception that occurred
  40      */
  41     void reportException(DeliveryTask task, Exception exception);
  42
  43     /**
  44      * Report that a delivery attempt completed (successfully or unsuccessfully).
  45      *
  46      * @param task The task that failed
  47      * @param status The HTTP status
  48      * @param xpubid The publish ID from the far end (if any)
  49      * @param location The redirection location for a 3XX response
  50      */
  51     void reportStatus(DeliveryTask task, int status, String xpubid, String location);
  52
  53     /**
  54      * Report that a delivery attempt either failed while sending data or that an error was returned instead of a 100
  55      * Continue.
  56      *
  57      * @param task The task that failed
  58      * @param sent The number of bytes sent or -1 if an error was returned instead of 100 Continue.
  59      */
  60     void reportDeliveryExtra(DeliveryTask task, long sent);
  61
  62     /**
  63      * Get the destination information for the delivery queue.
  64      *
  65      * @return The destination information
  66      */
  67     DestInfo getDestinationInfo();
  68
  69     /**
  70      * Given a file ID, get the URL to deliver to.
  71      *
  72      * @param fileid The file id
  73      * @return The URL to deliver to
  74      */
  75     String getDestURL(String fileid);
  76
  77     /**
  78      * Get the feed ID for a subscription.
  79      *
  80      * @param subid The subscription ID
  81      * @return The feed iD
  82      */
  83     String getFeedId(String subid);
  84 }