DefaultNotificationSender.java

  1. package gov.usgs.earthquake.distribution;

  3. import gov.usgs.earthquake.product.Product;
  4. import gov.usgs.earthquake.product.ProductId;
  5. import gov.usgs.util.Config;

  7. import java.util.Date;
  8. import java.util.Iterator;
  9. import java.util.List;
  10. import java.util.logging.Logger;

  12. /**
  13.  * The base class for all Notification senders.
  14.  *
  15.  * The DefaultNotificationSender references a general need to send notifications. It extends DefaultNotificationListener
  16.  * to allow forwarding of products from any subclass of DefaultNotificationReceiver. *
  17.  */
  18. public class DefaultNotificationSender extends DefaultNotificationListener {

  20.   private static final Logger LOGGER = Logger
  21.           .getLogger(DefaultNotificationSender.class.getName());

  23.   /** Property referencing the server host */
  24.   public static final String SERVER_HOST_PROPERTY = "serverHost";

  26.   /** Property referencing the server port */
  27.   public static final String SERVER_PORT_PROPERTY = "serverPort";

  29.   /** Property referencing product storage object to use */
  30.   public static final String PRODUCT_STORAGE_PROPERTY = "storage";

  32.   /** Property referencing the length of time products should be held in storage*/
  33.   public static final String PRODUCT_STORAGE_MAX_AGE_PROPERTY = "storageage";
  34.   /** property for max age of product in storage. 7000 days? */
  35.   public static final String DEFAULT_PRODUCT_STORAGE_MAX_AGE = "604800000";

  37.   /** Variable for String serverHost */
  38.   protected String serverHost;
  39.   /** Variable for String serverPort */
  40.   protected String serverPort;
  41.   /** Variable for URL productStorage */
  42.   protected URLProductStorage productStorage;
  43.   /** Variable for long productStorageMaxAge */
  44.   protected long productStorageMaxAge;


  47.   /**
  48.    * Configures based on configuration section.
  49.    *
  50.    * @param config
  51.    *            The config
  52.    * @throws Exception if something goes wrong
  53.    */
  54.   public void configure(Config config) throws Exception {
  55.     // let default notification listener configure itself
  56.     super.configure(config);

  58.     if (getNotificationIndex() == null) {
  59.       throw new ConfigurationException("[" + getName()
  60.               + "] 'index' is a required configuration property");
  61.     }

  63.     String productStorageName = config.getProperty(PRODUCT_STORAGE_PROPERTY);
  64.     if (productStorageName == null) {
  65.       throw new ConfigurationException("[" + getName() + "] '" + PRODUCT_STORAGE_PROPERTY + "' is a required property.");
  66.     }
  67.     LOGGER.config("[" + getName() + "] loading product storage '" + productStorageName + "'.");
  68.     this.productStorage = (URLProductStorage) Config.getConfig().getObject(productStorageName);
  69.     if (productStorage == null) {
  70.       throw new ConfigurationException("[" + getName() + "] product storage '" + productStorageName + "' improperly configured.");
  71.     }

  73.     productStorageMaxAge = Long.parseLong(config.getProperty(PRODUCT_STORAGE_MAX_AGE_PROPERTY,DEFAULT_PRODUCT_STORAGE_MAX_AGE));
  74.     LOGGER.config("[" + getName() + "] product storage max age: " + productStorageMaxAge + "ms");

  76.     serverHost = config.getProperty(SERVER_HOST_PROPERTY);
  77.     LOGGER.config("[" + getName() + "] messenger server host: " + serverHost);

  79.     serverPort = config.getProperty(SERVER_PORT_PROPERTY);
  80.     LOGGER.config("[" + getName() + "] messenger server port: " + serverPort);
  81.   }

  83.   /**
  84.    * Called on receipt of a new product. Stores this product and calls sendMessage()
  85.    * Most of this logic was lifted from the pre-08/2019 EIDSNotificationSender class.
  86.    *
  87.    * @param product
  88.    *            a product whose notification was accepted.
  89.    * @throws Exception if something goes wrong
  90.    */
  91.   public void onProduct(final Product product) throws Exception {
  92.     ProductId id = product.getId();

  94.     // store product
  95.     try {
  96.       productStorage.storeProduct(product);
  97.     } catch (ProductAlreadyInStorageException e) {
  98.       // ignore
  99.     }

  101.     // create notification
  102.     // make expiration relative to now
  103.     Date expirationDate = new Date(new Date().getTime()
  104.             + productStorageMaxAge);
  105.     URLNotification notification = new URLNotification(id, expirationDate,
  106.             product.getTrackerURL(), productStorage.getProductURL(id));

  108.     // remove any existing notifications, generally there won't be any
  109.     Iterator<Notification> existing = getNotificationIndex()
  110.             .findNotifications(id).iterator();
  111.     while (existing.hasNext()) {
  112.       getNotificationIndex().removeNotification(existing.next());
  113.     }

  115.     // send notification
  116.     try {
  117.       sendNotification(notification);
  118.     } catch (Exception e) {
  119.       // if fails, try to remove from storage
  120.       productStorage.removeProduct(id);
  121.       throw e;
  122.     }

  124.     // add created notification to index. Used to track which products
  125.     // have been processed, and to delete after expirationDate
  126.     // done after send in case send fails
  127.     getNotificationIndex().addNotification(notification);

  129.     // track that notification was sent
  130.     new ProductTracker(notification.getTrackerURL()).notificationSent(
  131.             this.getName(), notification);
  132.   }

  134.   /**
  135.    * Called just before this listener processes a notification.
  136.    *
  137.    * @param notification
  138.    *            notification about to be processed.
  139.    * @return true to process the notification, false to skip
  140.    * @throws Exception if something goes wrong
  141.    */
  142.   @Override
  143.   protected boolean onBeforeProcessNotification(
  144.           final Notification notification) throws Exception {
  145.     if (!isProcessDuplicates()) {
  146.       // only check if we care
  147.       List<Notification> notifications = getNotificationIndex()
  148.               .findNotifications(notification.getProductId());
  149.       if (notifications.size() > 0) {
  150.         if (productStorage.hasProduct(notification.getProductId())) {
  151.           LOGGER.finer("[" + getName()
  152.                   + "] skipping existing product "
  153.                   + notification.getProductId().toString());
  154.           return false;
  155.         } else {
  156.           LOGGER.finer("["
  157.                   + getName()
  158.                   + "] found notifications, but product missing from storage "
  159.                   + notification.getProductId().toString());
  160.         }
  161.       }
  162.     }

  164.     return true;
  165.   }

  167.   @Override
  168.   protected void onAfterProcessNotification(final Notification notification) {
  169.     // function replaced so notifications not added to index
  170.     // this class responds to the index
  171.   }

  173.   /**
  174.    * Called when a notification expires
  175.    *
  176.    * @param notification
  177.    *                The expired notification
  178.    * @throws Exception if something goes wrong
  179.    */
  180.   @Override
  181.   public void onExpiredNotification(final Notification notification) throws Exception{
  182.     List<Notification> notifications = getNotificationIndex()
  183.             .findNotifications(notification.getProductId());
  184.     if (notifications.size() <= 1) {
  185.       // this is called before removing notification from index.
  186.       productStorage.removeProduct(notification.getProductId());
  187.       LOGGER.finer("[" + getName()
  188.               + "] removed expired product from sender storage "
  189.               + notification.getProductId().toString());
  190.     } else {
  191.       // still have notifications left for product, don't remove
  192.     }
  193.   }

  195.   /**
  196.    * Utility method to do the actual notification sending. Should be overridden by subclasses.
  197.    *
  198.    * @param notification
  199.    *            The notification to send
  200.    * @throws Exception if something goes wrong
  201.    */
  202.   protected void sendNotification(final Notification notification) throws Exception {
  203.     LOGGER.info("[" + getName() + "] sent message " + notification.toString());
  204.   }

  206.   /**
  207.    * Start up storage
  208.    *
  209.    * @throws Exception if something goes wrong
  210.    */
  211.   public void startup() throws Exception{
  212.     productStorage.startup();
  213.     super.startup();
  214.   }

  216.   /**
  217.    * Shut down storage
  218.    *
  219.    * @throws Exception if something goes wrong
  220.    */
  221.   public void shutdown() throws Exception{
  222.     super.shutdown();
  223.     try {
  224.       productStorage.shutdown();
  225.     } catch (Exception e) {
  226.       //do nothing
  227.     }
  228.   }


  231.   /** @return serverHost */
  232.   public String getServerHost() {
  233.     return serverHost;
  234.   }

  236.   /** @param serverHost string to set */
  237.   public void setServerHost(String serverHost) {
  238.     this.serverHost = serverHost;
  239.   }

  241.   /** @return serverPort */
  242.   public String getServerPort() {
  243.     return serverPort;
  244.   }

  246.   /** @param serverPort string to set */
  247.   public void setServerPort(String serverPort) {
  248.     this.serverPort = serverPort;
  249.   }

  251.   /** @return productStorage */
  252.   public URLProductStorage getProductStorage() {
  253.     return productStorage;
  254.   }

  256.   /** @param productStorage URLProductStorage to set */
  257.   public void setProductStorage(URLProductStorage productStorage) {
  258.     this.productStorage = productStorage;
  259.   }

  261.   /** @return productStorageMaxAge */
  262.   public long getProductStorageMaxAge() {
  263.     return productStorageMaxAge;
  264.   }

  266.   /** @param productStorageMaxAge long to set */
  267.   public void setProductStorageMaxAge(long productStorageMaxAge) {
  268.     this.productStorageMaxAge = productStorageMaxAge;
  269.   }
  270. }
Created with JaCoCo 0.8.8.202204050719