aboutsummaryrefslogtreecommitdiffstats
path: root/datarouter-node/src/main/java/org/onap/dmaap/datarouter/node/DeliveryTaskHelper.java
blob: b9068f2f51ed3dc6e9aa099cb85f606d1f9820a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*******************************************************************************
 * ============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);
}