Package gov.usgs.earthquake.indexer

Interface IndexerListener

All Superinterfaces:
Configurable
All Known Implementing Classes:
DefaultIndexerListener, ExtentIndexerListener, ExternalIndexerListener, ExternalPreferredListener, ReliableIndexerListener
public interface IndexerListener extends Configurable
Listen for notifications that the index has changed.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMaxTries()
    An indexer that generates a IndexerEvent will attempt to deliver the event at most this many times, if the listener throws an Exception while processing.
    long
    getTimeout()
    A IndexerListener has this many milliseconds to process an event before being interrupted.
    void
    onIndexerEvent(IndexerEvent change)
    This method is called when the indexer makes a change to the ProductIndex.

    Methods inherited from interface gov.usgs.util.Configurable

    configure, getName, setName, shutdown, startup

  • Method Details

    • onIndexerEvent

      void onIndexerEvent(IndexerEvent change) throws Exception
      This method is called when the indexer makes a change to the ProductIndex.
      Parameters:
      change - description of the change.
      Throws:
      Exception - if error occurs

    • getMaxTries

      int getMaxTries()
      An indexer that generates a IndexerEvent will attempt to deliver the event at most this many times, if the listener throws an Exception while processing.
      Returns:
      A value of less than one means never attempt to deliver.

    • getTimeout

      long getTimeout()
      A IndexerListener has this many milliseconds to process an event before being interrupted.
      Returns:
      number of milliseconds before timing out. A value of 0 or less means never time out.