QuakeWatch Cube Output Client



     The QuakeWatch Cube Output Client
("QWCubeOutClient") connects to a QWServer, receives messages, converts them to CUBE format and outputs them to individual files (one file per message).  This client may be used as a functional equivalent to the QDDS program (operating as a "leaf").
     The "conf/QWCubeOutClientConfig.xml" file contains the configuration parameters for the program, including the parameters described below and the connection parameters for the client.  See
the "QWConnParams.html" file for a description of the QuakeWatch Connection Parameters.  The QuakeWatch Cube Output Client distribution contains the following files:

QWCubeOutClient.jar - Program "jar" file for the client.
startClient - Unix script for starting the client.
stopClient - Unix script for stopping the client.
startStopClient - Unix script for starting/stopping the client.
run - Unix script for running the client interactively.
run.bat - Windows batch file for running the client.
runCubeOutFromXML - Unix script for launching the CubeOutFromXML test utility.
runCubeOutFromXML.bat
- Windows batch file for launching the CubeOutFromXML test utility.
conf/QWCubeOutClientConfig.xml
- Sample configuration file for the client.
doc/QWCubeOutClient.html - This documentation file.
doc/QWConnParams.html - Documentation for the "QuakeWatch Connection Parameters".
test/TestLoginInfoFile.txt - Test file for client-server login authorization.
QWCubeOutClientSrc.zip - Source code for the client.

     The program jar file "QWCubeOutClient.jar" contains all the resources needed to operate (except for the
"conf/QWCubeOutClientConfig.xml" file).

     The CUBE format is used by the QDDS program, for which the following documentation is available:

USGS NEIC Documentation for QDDS:  http://neic.usgs.gov/neis/qdds/
Distribution Site for QDDS (FTP):  ftp://ehzftp.wr.usgs.gov/QDDS
CUBE Format Documentation:  CUBE.html



Cube Output Client Parameters

     The following parameters are specified in the "<Settings>" element of the "conf/QWCubeOutClientConfig.xml" configuration file for the QuakeWatch Cube Output Client (in addition to the QuakeWatch Connection Parameters).

outputMsgFilesDir = "dirname"

     The output directory for message files.  The filenames will be in the form "out.#", where "#" is the message number for the message.  Additional characters may be added to the filename to make it unique.  When a message is received, it contents are written to a file in the "processMsgFilesDir" directory, and then the file is moved to the "outputMsgFilesDir" directory.
  If this parameter is not specified then the value will default to "msgOutput".

processMsgFilesDir = "dirname"
     The process directory for message files.  When a message is received, it contents are written to a file in the "processMsgFilesDir" directory, and then the file is moved to the "outputMsgFilesDir" directory.
  If this parameter is not specified then the value will default to "msgProcess".

acceptXmlMsgsFlag = true/false
     If 'true' then when non-standard/invalid XML messages are received then they will be written to output-message files (as XML-format text).  If false then the messages will be discarded.  An XML message is considered non-standard/invalid if it does not conform to one of the expect message formats (QuakeML format, ANSS-EQ-XML format or QuakeWatch "QWmessage" format). 
If this parameter is not specified then the value will default to 'true'.

acceptNonActualFlag = true/false
     If 'false' then QuakeML and ANSS-EQ-XML-format messages will be ignored if they contain an 'Event' | 'Usage' element set to a value other than "Actual".  If 'true' then all messages will be accepted.  Messages that do not contain an
'Event' | 'Usage' element will always be accepted.  If this parameter is not specified then the value will default to 'false'.

lastMessageFileName = "fileName"
     Specifies the name of the file used to store a copy of the last message received by the client.  When the client starts up, it uses the message data from the file (if found) to request messages from the server that the client has missed.  If this parameter is not specified then the value will default to "qwLastMessage.dat"
.

prependDeclarationFlag = true/false
     This parameter only applies to non-standard/invalid XML messages that may be outputted when the 'acceptXmlMsgFlag' parameter is set to 'true':  When this parameter is set to 'true', the content of outputted XML-format messages will be preceded by the value of the 'prependDeclarationText' parameter.  If this parameter is not specified then the value will default to 'false' (no prepended text).

prependDeclarationText = "text"
     This parameter only applies to non-standard/invalid XML messages that may be outputted when the 'acceptXmlMsgFlag' parameter is set to 'true':  When the 'prependDeclarationFlag' parameter is set to 'true', the content of
XML-format outputted messages will be preceded by the value of the this parameter.  If this parameter is not specified then the value will default to "<?xml version=\"1.0\"?>\n" (the standard XML declaration).  Note that to specify this text in the configuration file, the open and close bracket characters must be substituted with "escaped" codes, as follows:  "&lt;?xml version=\"1.0\"?&gt;\n"


Note:  For this client, the 'maxServerEventAgeDays' parameter defaults to 0.000001.  This value effectively disables the fetching (at startup) of old server messages if none were previously received, while still enabling the fetching of messages sent since the last previously-received message.


4/23/2010 - Eric Thomas, Instrumental Software Technologies, Inc. - info@isti.com