com.isti.quakewatch.clientbase
Class QWTrackingClient

java.lang.Object
  extended by com.isti.util.ErrorMessageMgr
      extended by com.isti.util.ClientLogViaCfgProps
          extended by com.isti.quakewatch.clientbase.QWClientBase
              extended by com.isti.quakewatch.clientbase.QWTrackingClient
All Implemented Interfaces:
ErrorMsgMgrIntf

public class QWTrackingClient
extends QWClientBase

Class QWTrackingClient is an extension of 'QWClientBase' that adds the tracking of the current message number and time-generated value via a file.


Field Summary
 
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
QWTrackingClient()
           
 
Method Summary
 boolean runClient(MsgProcessorInterface clientMsgProcObj)
          Runs the client.
 void setupConfiguration(CfgProperties userPropsObj, java.lang.Object connGroupSelObj)
          Sets up the client configuration by adding items to the configuration- properties object.
 void setupConfiguration(CfgProperties userPropsObj, java.lang.Object connGroupSelObj, boolean addPrependDeclFlag)
          Sets up the client configuration by adding items to the configuration- properties object.
 void setupConfiguration(CfgProperties userPropsObj, java.lang.Object connGroupSelObj, java.lang.Object logGroupSelObj)
          Sets up the client configuration by adding items to the configuration- properties object.
 void setupConfiguration(CfgProperties userPropsObj, java.lang.Object connGroupSelObj, java.lang.Object logGroupSelObj, boolean addPrependDeclFlag)
          Sets up the client configuration by adding items to the configuration- properties object.
 
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
 

Constructor Detail

QWTrackingClient

public QWTrackingClient()
Method Detail

setupConfiguration

public void setupConfiguration(CfgProperties userPropsObj,
                               java.lang.Object connGroupSelObj,
                               java.lang.Object logGroupSelObj,
                               boolean addPrependDeclFlag)
Sets up the client configuration by adding items to the configuration- properties object. Other items may be added before and after calling this method.

Overrides:
setupConfiguration in class QWClientBase
Parameters:
userPropsObj - the configuration-properties object to add items to, or null to create a new configuration-properties object.
connGroupSelObj - the configuration-group-selection object to use for connection items, or null for none.
logGroupSelObj - the configuration-group-selection object to use for log-file items, or null for none.
addPrependDeclFlag - true to add "prependDeclaration..." items to configuration.

setupConfiguration

public void setupConfiguration(CfgProperties userPropsObj,
                               java.lang.Object connGroupSelObj,
                               java.lang.Object logGroupSelObj)
Sets up the client configuration by adding items to the configuration- properties object. Other items may be added before and after calling this method.

Overrides:
setupConfiguration in class QWClientBase
Parameters:
userPropsObj - the configuration-properties object to add items to, or null to create a new configuration-properties object.
connGroupSelObj - the configuration-group-selection object to use for connection items, or null for none.
logGroupSelObj - the configuration-group-selection object to use for log-file items, or null for none.

setupConfiguration

public void setupConfiguration(CfgProperties userPropsObj,
                               java.lang.Object connGroupSelObj,
                               boolean addPrependDeclFlag)
Sets up the client configuration by adding items to the configuration- properties object. Other items may be added before and after calling this method.

Overrides:
setupConfiguration in class QWClientBase
Parameters:
userPropsObj - the configuration-properties object to add items to, or null to create a new configuration-properties object.
connGroupSelObj - the configuration-group-selection object to use for connection items, or null for none.
addPrependDeclFlag - true to add "prependDeclaration..." items to configuration.

setupConfiguration

public void setupConfiguration(CfgProperties userPropsObj,
                               java.lang.Object connGroupSelObj)
Sets up the client configuration by adding items to the configuration- properties object. Other items may be added before and after calling this method.

Overrides:
setupConfiguration in class QWClientBase
Parameters:
userPropsObj - the configuration-properties object to add items to, or null to create a new configuration-properties object.
connGroupSelObj - the configuration-group-selection object to use for connection items, or null for none.

runClient

public boolean runClient(MsgProcessorInterface clientMsgProcObj)
Runs the client. The 'processConfiguration()' method must be executed before this method.

Parameters:
clientMsgProcObj - the client-message-processor object to use for processsing received messages.
Returns:
'true' if successful, false if an error occurred (in which case an error message will be sent to the console or to the log file).