+++ /dev/null
-/*******************************************************************************\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 com.att.research.datarouter.node;\r
-\r
-import java.io.*;\r
-import java.util.*;\r
-\r
-/**\r
- * Mechanism for monitoring and controlling delivery of files to a destination.\r
- * <p>\r
- * The DeliveryQueue class maintains lists of DeliveryTasks for a single\r
- * destination (a subscription or another data router node) and assigns\r
- * delivery threads to try to deliver them. It also maintains a delivery\r
- * status that causes it to back off on delivery attempts after a failure.\r
- * <p>\r
- * If the most recent delivery result was a failure, then no more attempts\r
- * will be made for a period of time. Initially, and on the first failure\r
- * following a success, this delay will be DeliveryQueueHelper.getInitFailureTimer() (milliseconds).\r
- * If, after this delay, additional failures occur, each failure will\r
- * multiply the delay by DeliveryQueueHelper.getFailureBackoff() up to a\r
- * maximum delay specified by DeliveryQueueHelper.getMaxFailureTimer().\r
- * Note that this behavior applies to the delivery queue as a whole and not\r
- * to individual files in the queue. If multiple files are being\r
- * delivered and one fails, the delay will be started. If a second\r
- * delivery fails while the delay was active, it will not change the delay\r
- * or change the duration of any subsequent delay.\r
- * If, however, it succeeds, it will cancel the delay.\r
- * <p>\r
- * The queue maintains 3 collections of files to deliver: A todo list of\r
- * files that will be attempted, a working set of files that are being\r
- * attempted, and a retry set of files that were attempted and failed.\r
- * Whenever the todo list is empty and needs to be refilled, a scan of the\r
- * spool directory is made and the file names sorted. Any files in the working set are ignored.\r
- * If a DeliveryTask for the file is in the retry set, then that delivery\r
- * task is placed on the todo list. Otherwise, a new DeliveryTask for the\r
- * file is created and placed on the todo list.\r
- * If, when a DeliveryTask is about to be removed from the todo list, its\r
- * age exceeds DeliveryQueueHelper.getExpirationTimer(), then it is instead\r
- * marked as expired.\r
- * <p>\r
- * A delivery queue also maintains a skip flag. This flag is true if the\r
- * failure timer is active or if no files are found in a directory scan.\r
- */\r
-public class DeliveryQueue implements Runnable, DeliveryTaskHelper {\r
- private DeliveryQueueHelper dqh;\r
- private DestInfo di;\r
- private Hashtable<String, DeliveryTask> working = new Hashtable<String, DeliveryTask>();\r
- private Hashtable<String, DeliveryTask> retry = new Hashtable<String, DeliveryTask>();\r
- private int todoindex;\r
- private boolean failed;\r
- private long failduration;\r
- private long resumetime;\r
- File dir;\r
- private Vector<DeliveryTask> todo = new Vector<DeliveryTask>();\r
- /**\r
- * Try to cancel a delivery task.\r
- * @return The length of the task in bytes or 0 if the task cannot be cancelled.\r
- */\r
- public synchronized long cancelTask(String pubid) {\r
- if (working.get(pubid) != null) {\r
- return(0);\r
- }\r
- DeliveryTask dt = retry.get(pubid);\r
- if (dt == null) {\r
- for (int i = todoindex; i < todo.size(); i++) {\r
- DeliveryTask xdt = todo.get(i);\r
- if (xdt.getPublishId().equals(pubid)) {\r
- dt = xdt;\r
- break;\r
- }\r
- }\r
- }\r
- if (dt == null) {\r
- dt = new DeliveryTask(this, pubid);\r
- if (dt.getFileId() == null) {\r
- return(0);\r
- }\r
- }\r
- if (dt.isCleaned()) {\r
- return(0);\r
- }\r
- StatusLog.logExp(dt.getPublishId(), dt.getFeedId(), dt.getSubId(), dt.getURL(), dt.getMethod(), dt.getCType(), dt.getLength(), "diskFull", dt.getAttempts());\r
- dt.clean();\r
- return(dt.getLength());\r
- }\r
- /**\r
- * Mark that a delivery task has succeeded.\r
- */\r
- public synchronized void markSuccess(DeliveryTask task) {\r
- working.remove(task.getPublishId());\r
- task.clean();\r
- failed = false;\r
- failduration = 0;\r
- }\r
- /**\r
- * Mark that a delivery task has expired.\r
- */\r
- public synchronized void markExpired(DeliveryTask task) {\r
- task.clean();\r
- }\r
- /**\r
- * Mark that a delivery task has failed permanently.\r
- */\r
- public synchronized void markFailNoRetry(DeliveryTask task) {\r
- working.remove(task.getPublishId());\r
- task.clean();\r
- failed = false;\r
- failduration = 0;\r
- }\r
- private void fdupdate() {\r
- if (!failed) {\r
- failed = true;\r
- if (failduration == 0) {\r
- failduration = dqh.getInitFailureTimer();\r
- }\r
- resumetime = System.currentTimeMillis() + failduration;\r
- long maxdur = dqh.getMaxFailureTimer();\r
- failduration = (long)(failduration * dqh.getFailureBackoff());\r
- if (failduration > maxdur) {\r
- failduration = maxdur;\r
- }\r
- }\r
- }\r
- /**\r
- * Mark that a delivery task has been redirected.\r
- */\r
- public synchronized void markRedirect(DeliveryTask task) {\r
- working.remove(task.getPublishId());\r
- retry.put(task.getPublishId(), task);\r
- }\r
- /**\r
- * Mark that a delivery task has temporarily failed.\r
- */\r
- public synchronized void markFailWithRetry(DeliveryTask task) {\r
- working.remove(task.getPublishId());\r
- retry.put(task.getPublishId(), task);\r
- fdupdate();\r
- }\r
- /**\r
- * Get the next task.\r
- */\r
- public synchronized DeliveryTask getNext() {\r
- DeliveryTask ret = peekNext();\r
- if (ret != null) {\r
- todoindex++;\r
- working.put(ret.getPublishId(), ret);\r
- }\r
- return(ret);\r
- }\r
- /**\r
- * Peek at the next task.\r
- */\r
- public synchronized DeliveryTask peekNext() {\r
- long now = System.currentTimeMillis();\r
- long mindate = now - dqh.getExpirationTimer();\r
- if (failed) {\r
- if (now > resumetime) {\r
- failed = false;\r
- } else {\r
- return(null);\r
- }\r
- }\r
- while (true) {\r
- if (todoindex >= todo.size()) {\r
- todoindex = 0;\r
- todo = new Vector<DeliveryTask>();\r
- String[] files = dir.list();\r
- Arrays.sort(files);\r
- for (String fname: files) {\r
- if (!fname.endsWith(".M")) {\r
- continue;\r
- }\r
- String fname2 = fname.substring(0, fname.length() - 2);\r
- long pidtime = 0;\r
- int dot = fname2.indexOf('.');\r
- if (dot < 1) {\r
- continue;\r
- }\r
- try {\r
- pidtime = Long.parseLong(fname2.substring(0, dot));\r
- } catch (Exception e) {\r
- }\r
- if (pidtime < 1000000000000L) {\r
- continue;\r
- }\r
- if (working.get(fname2) != null) {\r
- continue;\r
- }\r
- DeliveryTask dt = retry.get(fname2);\r
- if (dt == null) {\r
- dt = new DeliveryTask(this, fname2);\r
- }\r
- todo.add(dt);\r
- }\r
- retry = new Hashtable<String, DeliveryTask>();\r
- }\r
- if (todoindex < todo.size()) {\r
- DeliveryTask dt = todo.get(todoindex);\r
- if (dt.isCleaned()) {\r
- todoindex++;\r
- continue;\r
- }\r
- if (dt.getDate() >= mindate) {\r
- return(dt);\r
- }\r
- todoindex++;\r
- reportExpiry(dt);\r
- continue;\r
- }\r
- return(null);\r
- }\r
- }\r
- /**\r
- * Create a delivery queue for a given destination info\r
- */\r
- public DeliveryQueue(DeliveryQueueHelper dqh, DestInfo di) {\r
- this.dqh = dqh;\r
- this.di = di;\r
- dir = new File(di.getSpool());\r
- dir.mkdirs();\r
- }\r
- /**\r
- * Update the destination info for this delivery queue\r
- */\r
- public void config(DestInfo di) {\r
- this.di = di;\r
- }\r
- /**\r
- * Get the dest info\r
- */\r
- public DestInfo getDestInfo() {\r
- return(di);\r
- }\r
- /**\r
- * Get the config manager\r
- */\r
- public DeliveryQueueHelper getConfig() {\r
- return(dqh);\r
- }\r
- /**\r
- * Exceptional condition occurred during delivery\r
- */\r
- public void reportDeliveryExtra(DeliveryTask task, long sent) {\r
- StatusLog.logDelExtra(task.getPublishId(), task.getFeedId(), task.getSubId(), task.getLength(), sent);\r
- }\r
- /**\r
- * Message too old to deliver\r
- */\r
- public void reportExpiry(DeliveryTask task) {\r
- StatusLog.logExp(task.getPublishId(), task.getFeedId(), task.getSubId(), task.getURL(), task.getMethod(), task.getCType(), task.getLength(), "retriesExhausted", task.getAttempts());\r
- markExpired(task);\r
- }\r
- /**\r
- * Completed a delivery attempt\r
- */\r
- public void reportStatus(DeliveryTask task, int status, String xpubid, String location) {\r
- if (status < 300) {\r
- StatusLog.logDel(task.getPublishId(), task.getFeedId(), task.getSubId(), task.getURL(), task.getMethod(), task.getCType(), task.getLength(), di.getAuthUser(), status, xpubid);\r
- markSuccess(task);\r
- } else if (status < 400 && dqh.isFollowRedirects()) {\r
- StatusLog.logDel(task.getPublishId(), task.getFeedId(), task.getSubId(), task.getURL(), task.getMethod(), task.getCType(), task.getLength(), di.getAuthUser(), status, location);\r
- if (dqh.handleRedirection(di, location, task.getFileId())) {\r
- markRedirect(task);\r
- } else {\r
- StatusLog.logExp(task.getPublishId(), task.getFeedId(), task.getSubId(), task.getURL(), task.getMethod(), task.getCType(), task.getLength(), "notRetryable", task.getAttempts());\r
- markFailNoRetry(task);\r
- }\r
- } else if (status < 500) {\r
- StatusLog.logDel(task.getPublishId(), task.getFeedId(), task.getSubId(), task.getURL(), task.getMethod(), task.getCType(), task.getLength(), di.getAuthUser(), status, location);\r
- StatusLog.logExp(task.getPublishId(), task.getFeedId(), task.getSubId(), task.getURL(), task.getMethod(), task.getCType(), task.getLength(), "notRetryable", task.getAttempts());\r
- markFailNoRetry(task);\r
- } else {\r
- StatusLog.logDel(task.getPublishId(), task.getFeedId(), task.getSubId(), task.getURL(), task.getMethod(), task.getCType(), task.getLength(), di.getAuthUser(), status, location);\r
- markFailWithRetry(task);\r
- }\r
- }\r
- /**\r
- * Delivery failed by reason of an exception\r
- */\r
- public void reportException(DeliveryTask task, Exception exception) {\r
- StatusLog.logDel(task.getPublishId(), task.getFeedId(), task.getSubId(), task.getURL(), task.getMethod(), task.getCType(), task.getLength(), di.getAuthUser(), -1, exception.toString());\r
- dqh.handleUnreachable(di);\r
- markFailWithRetry(task);\r
- }\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
- return(dqh.getFeedId(subid));\r
- }\r
- /**\r
- * Get the URL to deliver a message to given the file ID\r
- */\r
- public String getDestURL(String fileid) {\r
- return(dqh.getDestURL(di, fileid));\r
- }\r
- /**\r
- * Deliver files until there's a failure or there are no more\r
- * files to deliver\r
- */\r
- public void run() {\r
- DeliveryTask t;\r
- long endtime = System.currentTimeMillis() + dqh.getFairTimeLimit();\r
- int filestogo = dqh.getFairFileLimit();\r
- while ((t = getNext()) != null) {\r
- t.run();\r
- if (--filestogo <= 0 || System.currentTimeMillis() > endtime) {\r
- break;\r
- }\r
- }\r
- }\r
- /**\r
- * Is there no work to do for this queue right now?\r
- */\r
- public synchronized boolean isSkipSet() {\r
- return(peekNext() == null);\r
- }\r
- /**\r
- * Reset the retry timer\r
- */\r
- public void resetQueue() {\r
- resumetime = System.currentTimeMillis();\r
- }\r
-}\r
Code Review / dmaap / datarouter.git / blobdiff