QWEmbeddedClient.java

  1. /*
  2.  * QWEmbeddedClient
  3.  */
  4. package gov.usgs.earthquake.eidsutil;

  6. import com.isti.quakewatch.clientbase.QWTrackingClient;
  7. import com.isti.quakewatch.util.QWConnectionMgr;
  8. import com.isti.util.CfgProperties;

  10. import java.util.Iterator;
  11. import java.util.List;
  12. import java.util.LinkedList;

  14. /**
  15.  * An EIDS client that is a java event source.
  16.  */
  17. public class QWEmbeddedClient extends QWTrackingClient implements EIDSListener {

  19.     /** Version string for program. */
  20.     public static final String PROGRAM_VERSION = "0.2";

  22.     /** Name string for program. */
  23.     public static final String PROGRAM_NAME = "QWEmbeddedClient";

  25.     /** Default server host. */
  26.     public static final String DEFAULT_SERVER_HOST = "eids1.cr.usgs.gov";

  28.     /** Default server port number. */
  29.     public static final Integer DEFAULT_SERVER_PORT = 39977;

  31.     /** Default maxServerEventAgeDays parameter. */
  32.     public static final Double DEFAULT_MAX_SERVER_EVENT_AGE_DAYS = 3.0;

  34.     /** Default Tracking filename. */
  35.     public static final String DEFAULT_TRACKING_FILE_NAME = "EIDSClient_tracking.dat";

  37.     /** Server host name. */
  38.     private String serverHost;

  40.     /** Server port number. */
  41.     private Integer serverPort;

  43.     /** Comma delimited list of host:port s. */
  44.     private String alternateServersList;

  46.     /** The decimal age in days. */
  47.     private Double maxServerEventAgeDays;

  49.     /** Tracking file for EIDS client. */
  50.     private String trackingFileName;

  52.     /** An object that "processes" messages, by passing them up to this object. */
  53.     private QWEmbeddedMsgProcessor processor = new QWEmbeddedMsgProcessor(this);

  55.     /** Listeners to notify when a message is received. */
  56.     private List<EIDSListener> listeners = new LinkedList<EIDSListener>();

  58.     /** Whether this has been shutdown already. */
  59.     private boolean isShutdown = false;

  61.     /** Console log level. */
  62.     private String consoleLogLevel = "Info";

  64.     /** Constructor using the default host and port */
  65.     public QWEmbeddedClient() {
  66.         this(DEFAULT_SERVER_HOST, DEFAULT_SERVER_PORT);
  67.     }

  69.     /**
  70.      * Construct an EIDSClient using only server host and port.
  71.      *
  72.      * Calls other constructor with null values for other parameters.
  73.      *
  74.      * @param serverHost host of EIDS client
  75.      * @param serverPort port of EIDS client
  76.      */
  77.     public QWEmbeddedClient(final String serverHost, final Integer serverPort) {
  78.         this(serverHost, serverPort, "");
  79.     }

  81.     /**
  82.      * Construct an EIDSClient using serverHost, serverPort, and
  83.      * alternateServersList.
  84.      *
  85.      * @param serverHost host of EIDS client
  86.      * @param serverPort port of EIDS client
  87.      * @param alternateServersList
  88.      *            a comma delimited list of host:port that are used when unable
  89.      *            to connect to the primary serverHost and serverPort.
  90.      */
  91.     public QWEmbeddedClient(final String serverHost, final Integer serverPort,
  92.             final String alternateServersList) {
  93.         this(serverHost, serverPort, alternateServersList,
  94.                 DEFAULT_MAX_SERVER_EVENT_AGE_DAYS, DEFAULT_TRACKING_FILE_NAME);
  95.     }

  97.     /**
  98.      * Constructor with all options.
  99.      *
  100.      * @param serverHost
  101.      *            the eids server host or ip address.
  102.      * @param serverPort
  103.      *            the eids server port.
  104.      * @param alternateServersList
  105.      *            a comma delimited list of host:port that are used when unable
  106.      *            to connect to the primary serverHost and serverPort.
  107.      * @param maxServerEventAgeDays
  108.      *            number of days worth of messages to retrieve on first connect.
  109.      * @param trackingFileName
  110.      *            location where tracking file is stored. This file is used to
  111.      *            track which messages have been received.
  112.      */
  113.     public QWEmbeddedClient(final String serverHost, final Integer serverPort,
  114.             final String alternateServersList,
  115.             final Double maxServerEventAgeDays, final String trackingFileName) {
  116.         this.serverHost = serverHost;
  117.         this.serverPort = serverPort;
  118.         this.alternateServersList = alternateServersList;
  119.         this.maxServerEventAgeDays = maxServerEventAgeDays;
  120.         this.trackingFileName = trackingFileName;
  121.     }

  123.     /**
  124.      *
  125.      */
  126.     public void setupConfiguration(CfgProperties userPropsObj,
  127.             Object connGroupSelObj, Object logGroupSelObj,
  128.             boolean addPrependDeclFlag) {
  129.         super.setupConfiguration(userPropsObj, connGroupSelObj, logGroupSelObj,
  130.                 addPrependDeclFlag);
  131.         CfgProperties props = getConnPropsObj().getConfigProps();
  132.         props.get("serverHostAddress").setValue(serverHost);
  133.         props.get("serverPortNumber").setValue(serverPort);
  134.         props.get("maxServerEventAgeDays").setValue(maxServerEventAgeDays);

  136.         if (alternateServersList != null) {
  137.             props.get("alternateServersList").setValue(alternateServersList);
  138.             props.get("altServersEnabledFlag").setValue(true);
  139.             props.get("keepDefaultAltServersFlag").setValue(true);
  140.         } else {
  141.             props.get("alternateServersList").setValue("");
  142.             props.get("altServersEnabledFlag").setValue(false);
  143.             props.get("keepDefaultAltServersFlag").setValue(true);
  144.         }

  146.         props.get("trackingFileName").setValue(trackingFileName);
  147.         props.get("clientConsoleLevel").setValue(consoleLogLevel);

  149.         // disable separate log file
  150.         props.get("clientLogFileName").setValue("");
  151.         props.get("clientLogFileLevel").setValue("Debug");
  152.     }

  154.     /**
  155.      * Runs the client.
  156.      *
  157.      * Any listeners should be added before calling this method.
  158.      */
  159.     public void startup() {
  160.         if (isShutdown) {
  161.             throw new IllegalArgumentException(
  162.                     "Cannot restart a QWEmbeddedClient after it has shutdown.");
  163.         }
  164.         // initialize client
  165.         setupConfiguration(null, null);
  166.         // set information for this client
  167.         setupClientInfoProps(PROGRAM_NAME, PROGRAM_VERSION);
  168.         // must be called before runClient
  169.         processConfiguration(null, null, null, false, null, false, null);
  170.         runClient(processor);
  171.     }

  173.     /**
  174.      * Shuts down a running client.
  175.      *
  176.      * Does not call system.exit.
  177.      */
  178.     public void shutdown() {
  179.         // shutdown the client, but doesn't call System.exit()
  180.         stopClient();
  181.         isShutdown = true;

  183.         // this is supposedly called by stopClient, but adding in because memory
  184.         // not being freed as expected
  185.         try {
  186.             QWConnectionMgr manager = this.getConnManagerObj();
  187.             manager.closeConnection();
  188.             manager.getMsgHandlerObj().clearWaitingMsgsQueueTable();
  189.         } catch (Exception e) {
  190.             System.err.println("Exception shutting down QWEmbeddedClient");
  191.             e.printStackTrace();
  192.         }
  193.     }

  195.     /**
  196.      * Add a listener.
  197.      *
  198.      * @param listener
  199.      *            the listener to add.
  200.      */
  201.     public synchronized void addListener(final EIDSListener listener) {
  202.         this.listeners.add(listener);
  203.     }

  205.     /**
  206.      * Remove a listener.
  207.      *
  208.      * @param listener
  209.      *            the listener to remove.
  210.      */
  211.     public synchronized void removeListener(final EIDSListener listener) {
  212.         this.listeners.remove(listener);
  213.     }

  215.     public void onEIDSMessage(EIDSMessageEvent event) {
  216.         // iterate over a copy of the listeners list
  217.         Iterator<EIDSListener> iter = new LinkedList<EIDSListener>(listeners)
  218.                 .iterator();
  219.         while (iter.hasNext()) {
  220.             iter.next().onEIDSMessage(event);
  221.         }
  222.     }

  224.     /**
  225.      * @return the serverHost
  226.      */
  227.     public String getServerHost() {
  228.         return serverHost;
  229.     }

  231.     /**
  232.      * @param serverHost
  233.      *            the serverHost to set
  234.      */
  235.     public void setServerHost(String serverHost) {
  236.         this.serverHost = serverHost;
  237.     }

  239.     /**
  240.      * @return the serverPort
  241.      */
  242.     public Integer getServerPort() {
  243.         return serverPort;
  244.     }

  246.     /**
  247.      * @param serverPort
  248.      *            the serverPort to set
  249.      */
  250.     public void setServerPort(Integer serverPort) {
  251.         this.serverPort = serverPort;
  252.     }

  254.     /**
  255.      * @return the alternateServersList
  256.      */
  257.     public String getAlternateServersList() {
  258.         return alternateServersList;
  259.     }

  261.     /**
  262.      * @param alternateServersList
  263.      *            the alternateServersList to set
  264.      */
  265.     public void setAlternateServersList(String alternateServersList) {
  266.         this.alternateServersList = alternateServersList;
  267.     }

  269.     /**
  270.      * @return the maxServerEventAgeDays
  271.      */
  272.     public Double getMaxServerEventAgeDays() {
  273.         return maxServerEventAgeDays;
  274.     }

  276.     /**
  277.      * @param maxServerEventAgeDays
  278.      *            the maxServerEventAgeDays to set
  279.      */
  280.     public void setMaxServerEventAgeDays(Double maxServerEventAgeDays) {
  281.         this.maxServerEventAgeDays = maxServerEventAgeDays;
  282.     }

  284.     /**
  285.      * @return the trackingFileName
  286.      */
  287.     public String getTrackingFileName() {
  288.         return trackingFileName;
  289.     }

  291.     /**
  292.      * @param trackingFileName
  293.      *            the trackingFileName to set
  294.      */
  295.     public void setTrackingFileName(String trackingFileName) {
  296.         this.trackingFileName = trackingFileName;
  297.     }

  299.     /** @return console Log level */
  300.     public String getConsoleLogLevel() {
  301.         return consoleLogLevel;
  302.     }

  304.     /** @param consoleLogLevel to set */
  305.     public void setConsoleLogLevel(String consoleLogLevel) {
  306.         this.consoleLogLevel = consoleLogLevel;
  307.     }

  309.     /**
  310.      * A method to test the EIDSClient.
  311.      *
  312.      * @param args arguments
  313.      * @throws Exception if error occurs
  314.      */
  315.     public static void main(final String[] args) throws Exception {
  316.         EIDSListener listener = new EIDSListener() {
  317.             public void onEIDSMessage(EIDSMessageEvent event) {
  318.                 System.err.println(event.getServerHost() + " "
  319.                         + event.getServerSequence());
  320.                 System.err.println("\t" + event.getMessageSource() + " "
  321.                         + event.getMessageSequence());
  322.                 System.err.println("\t" + event.getRootNamespace() + ":"
  323.                         + event.getRootElement());
  324.             }
  325.         };

  327.         QWEmbeddedClient client = new QWEmbeddedClient("eids1.cr.usgs.gov",
  328.                 39977);
  329.         client.addListener(listener);

  331.         System.err.println("Starting client");
  332.         // run for 2 seconds
  333.         client.startup();
  334.         Thread.sleep(5000);

  336.         System.err.println("Stopping client");
  337.         // stop for 2 seconds
  338.         client.shutdown();

  340.         // start a new client
  341.         client = new QWEmbeddedClient("eids1.cr.usgs.gov", 39977);
  342.         client.addListener(listener);

  344.         System.err.println("Starting client");
  345.         // run for 2 seconds
  346.         client.startup();
  347.         Thread.sleep(5000);

  349.         System.err.println("Stopping client");
  350.         // stop for 2 seconds
  351.         client.shutdown();
  352.     }

  354. }
Created with JaCoCo 0.8.8.202204050719