org.safs.xml
Class MultiLogResults

java.lang.Object
  org.safs.xml.MultiLogResults

public class MultiLogResults
extends java.lang.Object

Processes a user-specified directory for XML files. Creates a new single XML file consolidating the file hrefs for all XML files in the directory. Optionally, creates a summary XML file containing:

• For each XML file that proves to be a SAFS XML Log the class will:
  1. Record the log file href information uniquely identifying the log
  2. Record the date/time the log was opened
  3. Record the final status report information for that log
  4. Maintain an cumulative summary of all status report information for all files
  5. Record the date/time the log was closed

• Record the cumulative summary of all status report information from all files

JVM Arguments:

• -Dsafs.multilog.dir="<path/to/xmllogs/directory>"
  Full path to the directory containing the SAFS XML log(s) to consolidate and/or summarize.
  Ex: -Dsafs.multilog.dir="C:\SAFS\Project\Datapool\Logs"
  Same as command-line argument: -dir "C:\SAFS\Project\Datapool\Logs"

• -Dsafs.multilog.out="<path/to/output/directory>"
  Full path to the directory where any generated files will be written. By default all generated files will be written to the same directory where input files are found.
  Ex: -Dsafs.multilog.out="C:\SAFS\Project\Reports"
  Same as command-line argument: -out "C:\SAFS\Project\Reports"

• -Dsafs.multilog.log="<path/to/single/safsxmllog.xml>"
  Full or relative path to a single SAFS XML log to summarize.
  Ex: -Dsafs.multilog.log="C:\SAFS\Project\Datapool\Logs\TestComposerLog.xml"
  Ex: -Dsafs.multilog.log="TestComposerLog.xml"
  Same as command-line argument: -log "TestComposerLog.xml"

• -Dsafs.multilog.nosummary
  If present, only the initial XML list file containing the file hrefs for all SAFS XML log files will be created. All subsequent processing will be aborted.
  Same as command-line argument: -nosummary

• -Dsafs.multilog.summary="<path/to/xml/summary.xml>"
  Full or relative path to a summary XML file to process.
  Ex: -Dsafs.multilog.summary="C:\SAFS\Project\Reports\EMinerSummary.xml"
  Ex: -Dsafs.multilog.summary="EMinerSummary.xml"
  Same as command-line argument: -summary "EMinerSummary.xml"

• -Dsafs.multilog.noupdate
  If present, no attempt to update the data should occur. Same as command-line argument: -noupdate

• -Dsafs.multilog.dataid="<data_id>"
  The data id to be used in our connection queries and updates.
  Ex: -Dsafs.multilog.dataidt="mydata"
  Same as command-line argument: -dataid "mydata"

• -Dsafs.multilog.datapath="<data_path>"
  The data path to be associated with the data_id.
  Ex: -Dsafs.multilog.datapath="'/tst/tools/deploymentdetails/shrdata'"
  Same as command-line argument: -datapath "/tst/tools/deploymentdetails/shrdata"

• -Dsafs.multilog.where="<where_clause>"
  The where clause to filter the queries and updates.
  Ex: -Dsafs.multilog.where="ticketid = 123456"
  Same as command-line argument: -where "ticketid = 123456"

• -Dsafs.multilog.dataset="<dataset_id>"
  The dataset id to be updated in the reports database.
  Ex: -Dsafs.multilog.dataset="zdeployment"
  Same as command-line argument: -dataset "zdeployment"

• -Dsafs.multilog.field="<field_id>"
  The field id to be updated in the reports database.
  Ex: -Dsafs.multilog.field="entminer"
  Same as command-line argument: -field "entminer"

• -Dsafs.multilog.value="<value>"
  The value to be updated into the field in the reports database.
  Ex: -Dsafs.multilog.value="SUCCESS"
  Same as command-line argument: -value "SUCCESS"

• -Dsafs.multilog.connection="<connection_uri>"
  The value to be used for the JDBC database connection.
  Ex: -Dsafs.multilog.connection="sharenet://qashr05.unx.sas.com:5011"
  Same as command-line argument: -connection "sharenet://qashr05.unx.sas.com:5011"

• -Dsafs.multilog.connection.props="<name=value;name=value>"
  Zero or more name=value pairs (separated by semi-colons) to be used during the connection request.
  This argument can appear more than once, if needed.
  Ex: -Dsafs.multilog.connection.props="undoPolicyNone=True"
  Same as command-line argument: -props "undoPolicyNone=True"

• -Dsafs.multilog.opsource="<text identifying update source>"
  Text to be remotely logged identifying the source of this update request.
  Ex: -Dsafs.multilog.opsource="Support:canagl:org.safs.xml.MultiLogResults.java"
  Same as command-line argument: -opsource "Support:canagl:org.safs.xml.MultiLogResults.java"

• -Dsafs.multilog.drivers="<driverclass1;driverclass2>"
  Zero or more jdbc driver class names to append to the jdbc.drivers System property, separated by semi-colons.
  Ex: -Dsafs.multilog.drivers="com.sas.net.sharenet.ShareNetDriver"
  Same as command-line argument: -drivers "com.sas.net.sharenet.ShareNetDriver"

This class requires the JDBC Drivers for SAS/Share be in the CLASSPATH already. This generally means that both associated JAR files be in the System CLASSPATH ( or passed in the command-line):

• sas.core.jar
• sas.intrnet.javatools.jar

Field Summary

static java.lang.String	ARG_CONNECTION
static java.lang.String	ARG_DATAID
static java.lang.String	ARG_DATAPATH
static java.lang.String	ARG_DATASET
static java.lang.String	ARG_DIR
static java.lang.String	ARG_DRIVERS
static java.lang.String	ARG_FIELD
static java.lang.String	ARG_LOG
static java.lang.String	ARG_NOSUMMARY
static java.lang.String	ARG_NOUPDATE
static java.lang.String	ARG_OPSOURCE
static java.lang.String	ARG_OUT
static java.lang.String	ARG_PROPS
static java.lang.String	ARG_SUMMARY
static java.lang.String	ARG_VALUE
static java.lang.String	ARG_WHERE
java.lang.String	DEFAULT_CONNECTION default:"sharenet://qashr05.unx.sas.com:5011"
java.lang.String	DEFAULT_DATA_ID default:"mydata"
java.lang.String	DEFAULT_DATASET
java.lang.String	DEFAULT_DEV_DATA default:"'/tst/tools/deploymentdetails/dev/shrdata'"
boolean	DEFAULT_DO_SUMMARY
boolean	DEFAULT_DO_UPDATE set to false and any call to updateData will be ignored.
java.lang.String	DEFAULT_DRIVERS
java.lang.String	DEFAULT_FIELD
java.lang.String	DEFAULT_LOG_FILE
java.lang.String	DEFAULT_LOGS_DIR
java.lang.String	DEFAULT_OPSOURCE
java.lang.String	DEFAULT_OUTPUT_DIR
java.lang.String	DEFAULT_PROD_DATA default:"'/tst/tools/deploymentdetails/shrdata'"
java.util.Properties	DEFAULT_PROPS
java.lang.String	DEFAULT_SUMMARY_FILE
java.lang.String	DEFAULT_VALUE
java.lang.String	DEFAULT_WHERE
static java.lang.String	PROP_KEY_JDBC_DRIVERS
static java.lang.String	PROP_KEY_LIBREFS
static java.lang.String	PROP_KEY_SAFS_MULTILOG_CONNECTION
static java.lang.String	PROP_KEY_SAFS_MULTILOG_DATAID
static java.lang.String	PROP_KEY_SAFS_MULTILOG_DATAPATH
static java.lang.String	PROP_KEY_SAFS_MULTILOG_DATASET
static java.lang.String	PROP_KEY_SAFS_MULTILOG_DIR
static java.lang.String	PROP_KEY_SAFS_MULTILOG_DRIVERS
static java.lang.String	PROP_KEY_SAFS_MULTILOG_FIELD
static java.lang.String	PROP_KEY_SAFS_MULTILOG_LOG
static java.lang.String	PROP_KEY_SAFS_MULTILOG_NOSUMMARY
static java.lang.String	PROP_KEY_SAFS_MULTILOG_NOUPDATE
static java.lang.String	PROP_KEY_SAFS_MULTILOG_OPSOURCE
static java.lang.String	PROP_KEY_SAFS_MULTILOG_OUT
static java.lang.String	PROP_KEY_SAFS_MULTILOG_PROPS
static java.lang.String	PROP_KEY_SAFS_MULTILOG_SUMMARY
static java.lang.String	PROP_KEY_SAFS_MULTILOG_VALUE
static java.lang.String	PROP_KEY_SAFS_MULTILOG_WHERE
static java.lang.String	PROP_KEY_UNDOPOLICYNONE

Constructor Summary

MultiLogResults()

Method Summary

protected java.lang.String	getSystemProperty(java.lang.String pname)
static void	log(java.lang.String message) Currently logs to System.out.
static void	main(java.lang.String[] args) primarily a testing entry point.
void	processArgs(java.lang.String[] args) String[] args will override any processJVMOptions previously set-- assuming JVM Options are processed BEFORE these args.
protected void	processDriversArg(java.lang.String driversarg)
void	processJVMOptions() (Re)Set any arguments passed in as JVM -D Options.
protected void	processPropsArg(java.lang.String propsarg)
void	updateData() Invokes updateData with all DEFAULT arguments previously stored or set.
void	updateData(java.lang.String _connectURI, java.util.Properties prop, java.lang.String _dataid, java.lang.String _datapath, java.lang.String _dataset, java.lang.String _field, java.lang.String _value, java.lang.String _where, java.lang.String _opsource) The primary routine used to update the database.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATA_ID

public java.lang.String DEFAULT_DATA_ID

default:"mydata"

DEFAULT_PROD_DATA

public java.lang.String DEFAULT_PROD_DATA

default:"'/tst/tools/deploymentdetails/shrdata'"

DEFAULT_DEV_DATA

public java.lang.String DEFAULT_DEV_DATA

default:"'/tst/tools/deploymentdetails/dev/shrdata'"

DEFAULT_DRIVERS

public java.lang.String DEFAULT_DRIVERS

DEFAULT_CONNECTION

public java.lang.String DEFAULT_CONNECTION

default:"sharenet://qashr05.unx.sas.com:5011"

DEFAULT_LOGS_DIR

public java.lang.String DEFAULT_LOGS_DIR

DEFAULT_OUTPUT_DIR

public java.lang.String DEFAULT_OUTPUT_DIR

DEFAULT_LOG_FILE

public java.lang.String DEFAULT_LOG_FILE

DEFAULT_DO_SUMMARY

public boolean DEFAULT_DO_SUMMARY

DEFAULT_SUMMARY_FILE

public java.lang.String DEFAULT_SUMMARY_FILE

DEFAULT_DATASET

public java.lang.String DEFAULT_DATASET

DEFAULT_FIELD

public java.lang.String DEFAULT_FIELD

DEFAULT_VALUE

public java.lang.String DEFAULT_VALUE

DEFAULT_OPSOURCE

public java.lang.String DEFAULT_OPSOURCE

DEFAULT_WHERE

public java.lang.String DEFAULT_WHERE

DEFAULT_PROPS

public java.util.Properties DEFAULT_PROPS

DEFAULT_DO_UPDATE

public boolean DEFAULT_DO_UPDATE

set to false and any call to updateData will be ignored.

PROP_KEY_LIBREFS

public static final java.lang.String PROP_KEY_LIBREFS

See Also:

Constant Field Values

PROP_KEY_UNDOPOLICYNONE

public static final java.lang.String PROP_KEY_UNDOPOLICYNONE

See Also:

Constant Field Values

PROP_KEY_JDBC_DRIVERS

public static final java.lang.String PROP_KEY_JDBC_DRIVERS

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_DIR

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_DIR

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_OUT

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_OUT

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_LOG

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_LOG

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_NOSUMMARY

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_NOSUMMARY

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_SUMMARY

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_SUMMARY

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_DRIVERS

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_DRIVERS

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_NOUPDATE

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_NOUPDATE

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_DATAID

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_DATAID

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_DATAPATH

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_DATAPATH

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_WHERE

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_WHERE

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_DATASET

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_DATASET

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_FIELD

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_FIELD

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_VALUE

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_VALUE

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_CONNECTION

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_CONNECTION

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_PROPS

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_PROPS

See Also:

Constant Field Values

PROP_KEY_SAFS_MULTILOG_OPSOURCE

public static final java.lang.String PROP_KEY_SAFS_MULTILOG_OPSOURCE

See Also:

Constant Field Values

ARG_DIR

public static final java.lang.String ARG_DIR

See Also:

Constant Field Values

ARG_OUT

public static final java.lang.String ARG_OUT

See Also:

Constant Field Values

ARG_LOG

public static final java.lang.String ARG_LOG

See Also:

Constant Field Values

ARG_NOSUMMARY

public static final java.lang.String ARG_NOSUMMARY

See Also:

Constant Field Values

ARG_SUMMARY

public static final java.lang.String ARG_SUMMARY

See Also:

Constant Field Values

ARG_NOUPDATE

public static final java.lang.String ARG_NOUPDATE

See Also:

Constant Field Values

ARG_DRIVERS

public static final java.lang.String ARG_DRIVERS

See Also:

Constant Field Values

ARG_DATAID

public static final java.lang.String ARG_DATAID

See Also:

Constant Field Values

ARG_DATAPATH

public static final java.lang.String ARG_DATAPATH

See Also:

Constant Field Values

ARG_WHERE

public static final java.lang.String ARG_WHERE

See Also:

Constant Field Values

ARG_DATASET

public static final java.lang.String ARG_DATASET

See Also:

Constant Field Values

ARG_FIELD

public static final java.lang.String ARG_FIELD

See Also:

Constant Field Values

ARG_VALUE

public static final java.lang.String ARG_VALUE

See Also:

Constant Field Values

ARG_CONNECTION

public static final java.lang.String ARG_CONNECTION

See Also:

Constant Field Values

ARG_PROPS

public static final java.lang.String ARG_PROPS

See Also:

Constant Field Values

ARG_OPSOURCE

public static final java.lang.String ARG_OPSOURCE

See Also:

Constant Field Values

Constructor Detail

MultiLogResults

public MultiLogResults()

Method Detail

log

public static void log(java.lang.String message)

Currently logs to System.out. Other options may be supported in the future.

updateData

public void updateData()

Invokes updateData with all DEFAULT arguments previously stored or set.

updateData

public void updateData(java.lang.String _connectURI,
                       java.util.Properties prop,
                       java.lang.String _dataid,
                       java.lang.String _datapath,
                       java.lang.String _dataset,
                       java.lang.String _field,
                       java.lang.String _value,
                       java.lang.String _where,
                       java.lang.String _opsource)

The primary routine used to update the database.

Parameters:

_connectURI -

prop -

_dataid -

_datapath -

_dataset -

_field -

_value -

_where -

_opsource -

getSystemProperty

protected java.lang.String getSystemProperty(java.lang.String pname)

processPropsArg

protected void processPropsArg(java.lang.String propsarg)

processDriversArg

protected void processDriversArg(java.lang.String driversarg)

processJVMOptions

public void processJVMOptions()

(Re)Set any arguments passed in as JVM -D Options.

processArgs

public void processArgs(java.lang.String[] args)

String[] args will override any processJVMOptions previously set-- assuming JVM Options are processed BEFORE these args.

main

public static void main(java.lang.String[] args)

primarily a testing entry point.

Parameters:

args -