Package gov.usgs.earthquake.eidsutil

Class QWEmbeddedClient

java.lang.Object
com.isti.util.ErrorMessageMgr
com.isti.util.ClientLogViaCfgProps
com.isti.quakewatch.clientbase.QWClientBase
com.isti.quakewatch.clientbase.QWTrackingClient
gov.usgs.earthquake.eidsutil.QWEmbeddedClient
All Implemented Interfaces:
com.isti.util.ErrorMsgMgrIntf, EIDSListener
public class QWEmbeddedClient extends com.isti.quakewatch.clientbase.QWTrackingClient implements EIDSListener
An EIDS client that is a java event source.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Double
    DEFAULT_MAX_SERVER_EVENT_AGE_DAYS
    Default maxServerEventAgeDays parameter.
    static final String
    DEFAULT_SERVER_HOST
    Default server host.
    static final Integer
    DEFAULT_SERVER_PORT
    Default server port number.
    static final String
    DEFAULT_TRACKING_FILE_NAME
    Default Tracking filename.
    static final String
    PROGRAM_NAME
    Name string for program.
    static final String
    PROGRAM_VERSION
    Version string for program.

    Fields inherited from class com.isti.quakewatch.clientbase.QWClientBase

    CFG_PARAM_SPEC, clientNameString, clientVerString, connectionManagerObj, initReqMsgsCallBackObj, initReqMsgsCancelString, initReqMsgsDialogObj, initReqMsgsProgIndObj, prependDeclarationFlagProp, prependDeclarationString, prependDeclarationTextProp, saveToConfigFileCallBackObj, serverLoginPropEditorObj, startupTimeString, xmlConfigLoaderObj

    Fields inherited from class com.isti.util.ClientLogViaCfgProps

    baseWriteDirStr, clientConsoleLevelProp, clientLogFileLevelProp, clientLogFileNameProp, consoleFilesMaxAgeInDays, consoleFilesSwitchIntvlDays, consoleRedirectFileNameProp, consoleRedirectStream, logFileProps, logFilesMaxAgeInDaysProp, logObj

  • Constructor Summary

    Constructors
    Constructor
    Description
    QWEmbeddedClient()
    Constructor using the default host and port
    QWEmbeddedClient(String serverHost, Integer serverPort)
    Construct an EIDSClient using only server host and port.
    QWEmbeddedClient(String serverHost, Integer serverPort, String alternateServersList)
    Construct an EIDSClient using serverHost, serverPort, and alternateServersList.
    QWEmbeddedClient(String serverHost, Integer serverPort, String alternateServersList, Double maxServerEventAgeDays, String trackingFileName)
    Constructor with all options.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addListener(EIDSListener listener)
    Add a listener.
    String
    getAlternateServersList()
     
    String
    getConsoleLogLevel()
     
    Double
    getMaxServerEventAgeDays()
     
    String
    getServerHost()
     
    Integer
    getServerPort()
     
    String
    getTrackingFileName()
     
    static void
    main(String[] args)
    A method to test the EIDSClient.
    void
    onEIDSMessage(EIDSMessageEvent event)
    Receive a message from an EIDSClient.
    void
    removeListener(EIDSListener listener)
    Remove a listener.
    void
    setAlternateServersList(String alternateServersList)
     
    void
    setConsoleLogLevel(String consoleLogLevel)
     
    void
    setMaxServerEventAgeDays(Double maxServerEventAgeDays)
     
    void
    setServerHost(String serverHost)
     
    void
    setServerPort(Integer serverPort)
     
    void
    setTrackingFileName(String trackingFileName)
     
    void
    setupConfiguration(com.isti.util.CfgProperties userPropsObj, Object connGroupSelObj, Object logGroupSelObj, boolean addPrependDeclFlag)
     
    void
    shutdown()
    Shuts down a running client.
    void
    startup()
    Runs the client.

    Methods inherited from class com.isti.quakewatch.clientbase.QWTrackingClient

    runClient, setupConfiguration, setupConfiguration, setupConfiguration

    Methods inherited from class com.isti.quakewatch.clientbase.QWClientBase

    addShutdownHookCleanupThreadObj, clientSleepDelay, getCertificateFileDataArr, getClientRunningStartTime, getClientRunningTime, getConnManagerObj, getConnPropsObj, getLogFileObj, getMaxServerEventAgeDaysProp, getOpenOrbVersionStr, getPrependDeclarationString, getXmlConfigLoader, interruptClientSleepDelay, isClientRunning, isClientTerminated, isConnectionValidated, isEventChannelConnected, isReqServerMsgsAvailable, localExitCleanup, localExitCleanup, localExitCleanup, localExitCleanup, performExitCleanup, processConfiguration, processConfiguration, processConfiguration, processConfiguration, reinitConnection, removeShutdownHookCleanupThreadObj, runClient, runClient, runClient, runClient, runClient, runClient, runClient, setSaveToConfigFileCallBackObj, setServerLoginPropertyEditor, setupClientInfoProps, setupClientInfoProps, setupConfiguration, setupInitReqMsgsObjs, stopClient, terminateProgram

    Methods inherited from class com.isti.util.ClientLogViaCfgProps

    addLogFilePropItems, addLogFilePropItems, closeConsoleRedirectStream, closeLogFile, createLogFile, fromBaseDir, fromBaseDir, getBaseWriteDirStr, getConsoleRedirectStreamObj, setBaseWriteDirStr, setGroupSelObj

    Methods inherited from class com.isti.util.ErrorMessageMgr

    clearErrorMessageString, clearFetchedErrorMessage, enterErrorMessageString, getErrorMessageFlag, getErrorMessageString, getUnfetchedMessageFlag, setErrorMessageString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • 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:

  • Constructor Details

    • QWEmbeddedClient

      public QWEmbeddedClient()
      Constructor using the default host and port

    • QWEmbeddedClient

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

    • QWEmbeddedClient

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

    • QWEmbeddedClient

      public QWEmbeddedClient(String serverHost, Integer serverPort, String alternateServersList, Double maxServerEventAgeDays, String trackingFileName)
      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.

  • Method Details

    • setupConfiguration

      public void setupConfiguration(com.isti.util.CfgProperties userPropsObj, Object connGroupSelObj, Object logGroupSelObj, boolean addPrependDeclFlag)
      Overrides:
      setupConfiguration in class com.isti.quakewatch.clientbase.QWTrackingClient

    • 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

    • getConsoleLogLevel

      public String getConsoleLogLevel()
      Returns:
      console Log level

    • setConsoleLogLevel

      public void setConsoleLogLevel(String consoleLogLevel)
      Parameters:
      consoleLogLevel - to set

    • main

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