1 /*******************************************************************************
2 * ============LICENSE_START==================================================
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
11 * * http://www.apache.org/licenses/LICENSE-2.0
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====================================================
20 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 ******************************************************************************/
25 package org.onap.dmaap.datarouter.node;
28 * Interface to allow independent testing of the DeliveryQueue code
30 * This interface represents all of the configuration information and
31 * feedback mechanisms that a delivery queue needs.
33 public interface DeliveryQueueHelper {
35 * Get the timeout (milliseconds) before retrying after an initial delivery failure
37 long getInitFailureTimer();
40 * Get the timeout before retrying after delivery and wait for file processing
42 long getWaitForFileProcessFailureTimer();
45 * Get the ratio between timeouts on consecutive delivery attempts
47 double getFailureBackoff();
50 * Get the maximum timeout (milliseconds) between delivery attempts
52 long getMaxFailureTimer();
55 * Get the expiration timer (milliseconds) for deliveries
57 long getExpirationTimer();
60 * Get the maximum number of file delivery attempts before checking
61 * if another queue has work to be performed.
63 int getFairFileLimit();
66 * Get the maximum amount of time spent delivering files before checking if another queue has work to be performed.
68 long getFairTimeLimit();
71 * Get the URL for delivering a file
73 * @param destinationInfo The destination information for the file to be delivered.
74 * @param fileid The file id for the file to be delivered.
75 * @return The URL for delivering the file (typically, destinationInfo.getURL() + "/" + fileid).
77 String getDestURL(DestInfo destinationInfo, String fileid);
80 * Forget redirections associated with a subscriber
82 * @param destinationInfo Destination information to forget
84 void handleUnreachable(DestInfo destinationInfo);
87 * Post redirection for a subscriber
89 * @param destinationInfo Destination information to update
90 * @param location Location given by subscriber
91 * @param fileid File ID of request
92 * @return true if this 3xx response is retryable, otherwise, false.
94 boolean handleRedirection(DestInfo destinationInfo, String location, String fileid);
97 * Should I handle 3xx responses differently than 4xx responses?
99 boolean isFollowRedirects();
102 * Get the feed ID for a subscription
104 * @param subid The subscription ID
105 * @return The feed ID
107 String getFeedId(String subid);