Package gov.usgs.earthquake.eidsutil

Class EIDSClient

java.lang.Object
gov.usgs.earthquake.eidsutil.EIDSClient
All Implemented Interfaces:
EIDSListener
public class EIDSClient extends Object implements EIDSListener
An EIDS client that is a java event source.

  • Field Details

    • EIDS_SERVER_HOST_PROPERTY

      public static final String EIDS_SERVER_HOST_PROPERTY
      Property name for eids server host address.
      See Also:

    • EIDS_SERVER_PORT

      public static final String EIDS_SERVER_PORT
      Property name for eids server port.
      See Also:

    • EIDS_ALTERNATE_SERVERS

      public static final String EIDS_ALTERNATE_SERVERS
      Property name for eids server alternate servers list.
      See Also:

    • EIDS_LISTENERS

      public static final String EIDS_LISTENERS
      Property name for objects to load and add as EIDSListeners.
      See Also:

    • PROGRAM_VERSION

      public static final String PROGRAM_VERSION
      Version string for program.
      See Also:

    • PROGRAM_NAME

      public static final String PROGRAM_NAME
      Name string for program.
      See Also:

    • DEFAULT_SERVER_HOST

      public static final String DEFAULT_SERVER_HOST
      Default server host.
      See Also:

    • DEFAULT_SERVER_PORT

      public static final Integer DEFAULT_SERVER_PORT
      Default server port number.

    • DEFAULT_MAX_SERVER_EVENT_AGE_DAYS

      public static final Double DEFAULT_MAX_SERVER_EVENT_AGE_DAYS
      Default maxServerEventAgeDays parameter.

    • DEFAULT_TRACKING_FILE_NAME

      public static final String DEFAULT_TRACKING_FILE_NAME
      Default Tracking filename.
      See Also:

    • DEFAULT_CLIENT_RESTART_INTERVAL

      public static final Long DEFAULT_CLIENT_RESTART_INTERVAL
      Default client restart interval

  • Constructor Details

    • EIDSClient

      public EIDSClient()
      Constructor using default host and port

    • EIDSClient

      public EIDSClient(String serverHost, Integer serverPort)
      Construct an EIDSClient using only server host and port. Calls other constructor with null values for other parameters.
      Parameters:
      serverHost - Specific host
      serverPort - Specific port

    • EIDSClient

      public EIDSClient(String serverHost, Integer serverPort, String alternateServersList)
      Construct an EIDSClient using serverHost, serverPort, and alternateServersList.
      Parameters:
      serverHost - Host
      serverPort - Port
      alternateServersList - a comma delimited list of host:port that are used when unable to connect to the primary serverHost and serverPort.

    • EIDSClient

      public EIDSClient(String serverHost, Integer serverPort, String alternateServersList, Double maxServerEventAgeDays, String trackingFileName, Long clientRestartInterval)
      Constructor with all options.
      Parameters:
      serverHost - the eids server host or ip address.
      serverPort - the eids server port.
      alternateServersList - a comma delimited list of host:port that are used when unable to connect to the primary serverHost and serverPort.
      maxServerEventAgeDays - number of days worth of messages to retrieve on first connect.
      trackingFileName - location where tracking file is stored. This file is used to track which messages have been received.
      clientRestartInterval - How often to periodically restart the client, in milliseconds

  • Method Details

    • startup

      public void startup()
      Runs the client. Any listeners should be added before calling this method.

    • shutdown

      public void shutdown()
      Shuts down a running client. Does not call system.exit.

    • addListener

      public void addListener(EIDSListener listener)
      Add a listener.
      Parameters:
      listener - the listener to add.

    • removeListener

      public void removeListener(EIDSListener listener)
      Remove a listener.
      Parameters:
      listener - the listener to remove.

    • onEIDSMessage

      public void onEIDSMessage(EIDSMessageEvent event)
      Description copied from interface: EIDSListener
      Receive a message from an EIDSClient.
      Specified by:
      onEIDSMessage in interface EIDSListener
      Parameters:
      event - an event object representing the message that was received.

    • getServerHost

      public String getServerHost()
      Returns:
      the serverHost

    • setServerHost

      public void setServerHost(String serverHost)
      Parameters:
      serverHost - the serverHost to set

    • getServerPort

      public Integer getServerPort()
      Returns:
      the serverPort

    • setServerPort

      public void setServerPort(Integer serverPort)
      Parameters:
      serverPort - the serverPort to set

    • getAlternateServersList

      public String getAlternateServersList()
      Returns:
      the alternateServersList

    • setAlternateServersList

      public void setAlternateServersList(String alternateServersList)
      Parameters:
      alternateServersList - the alternateServersList to set

    • getMaxServerEventAgeDays

      public Double getMaxServerEventAgeDays()
      Returns:
      the maxServerEventAgeDays

    • setMaxServerEventAgeDays

      public void setMaxServerEventAgeDays(Double maxServerEventAgeDays)
      Parameters:
      maxServerEventAgeDays - the maxServerEventAgeDays to set

    • getTrackingFileName

      public String getTrackingFileName()
      Returns:
      the trackingFileName

    • setTrackingFileName

      public void setTrackingFileName(String trackingFileName)
      Parameters:
      trackingFileName - the trackingFileName to set

    • getClientRestartInterval

      public Long getClientRestartInterval()
      Returns:
      clientRestartInterval

    • setClientRestartInterval

      public void setClientRestartInterval(Long clientRestartInterval)
      Parameters:
      clientRestartInterval - the clientRestartInterval to set

    • setDebug

      public void setDebug(boolean debug)
      Parameters:
      debug - to set

    • isDebug

      public boolean isDebug()
      Returns:
      debug boolean

    • reinitConnection

      public boolean reinitConnection()
      Returns:
      result of reinitialzing the client connection

    • main

      public static void main(String[] args) throws Exception
      A method to test the EIDSClient.
      Parameters:
      args - arguments
      Throws:
      Exception - if error occurs