org.safs.tools.data

Class GenericJDBC

java.lang.Object

org.safs.tools.data.GenericJDBC

public class GenericJDBC
extends java.lang.Object

This class is intended to be a lightweight class with few additional SAFS dependencies.

The purpose is to provide a command-line driven ability to access and update JDBC databases.

JVM Arguments:

• -noupdate
  If present, no attempt to update the data should occur.
  Generally, this is useful for debugging connection attempts/failures.
  Same as JVM Option: -Dsafs.jdbc.noupdate

• -dataid "mydata"
  The data id to be used in our connection queries and updates.
  Same as JVM Option: -Dsafs.jdbc.dataid="<data_id>"

• -datapath "/tst/tools/deploymentdetails/dev/shrdata"
  The data path to be associated with the data_id.
  Same as JVM Option: -Dsafs.jdbc.datapath="'<data_path>'"

• -where "ticketid = 1846"
  The where clause to filter the queries and updates.
  Same as JVM Option: -Dsafs.jdbc.where="<where_clause>"
  Ex: -Dsafs.jdbc.where="ticketid = 1846"

• -dataset "zdeployment"
  The dataset to be updated in the database.
  Same as JVM Option: -Dsafs.jdbc.dataset="<dataset_id>"
  Ex: -Dsafs.jdbc.dataset="zdeployment"

• -field "entminer"
  The field/column to be updated in the dataset.
  Same as JVM Option: -Dsafs.jdbc.field="<field_id>"
  Ex: -Dsafs.jdbc.field="entminer"

• -value "SUCCESS"
  The value to be updated into the field in the dataset.
  Same as JVM Option: -Dsafs.jdbc.value="<value>"
  Ex: -Dsafs.jdbc.value="SUCCESS"

• -connection "protocol://database-server-hostname:port"
  The value to be used for the JDBC database connection.
  Same as JVM Option: -Dsafs.jdbc.connection="<connection_uri>"
  Ex: -Dsafs.jdbc.connection="protocol://database-server-hostname:port"

• -props "librefs=mydata '/tst/tools/deploymentdetails/dev/shrdata';undoPolicyNone=True"
  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.
  Same as JVM Option: -Dsafs.jdbc.connection.props="<name=value;name=value>"
  Ex: -Dsafs.jdbc.connection.props="librefs=mydata '/tst/tools/deploymentdetails/dev/shrdata';undoPolicyNone=True"

• -opsource "Support:Carl Nagle:org.safs.tools.data.GenericJDBC.java"
  Text to be remotely logged identifying the source of this update request.
  Same as JVM Option: -Dsafs.jdbc.opsource="<text identifying update source>"
  Ex: -Dsafs.jdbc.opsource="Support:Carl Nagle:org.safs.tools.data.GenericJDBC.java"

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

This class requires the JDBC Drivers be in the CLASSPATH already.
For example: For SAS/Share, 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

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_connection defaults to "protocol://database-server-hostname:port"
protected java.lang.String	_datapath defaults to "\'/tst/tools/deploymentdetails/shrdata\'"
protected java.lang.String	_dataset defaults to null.
protected boolean	_doUpdate default: true.
protected java.lang.String	_drivers defaults to "com.sas.net.sharenet.ShareNetDriver"
protected java.lang.String	_field defaults to null.
protected java.lang.String	_opsource defaults to null.
protected java.util.Properties	_props defaults to null.
protected java.lang.String	_shrdataid defaults to "mydata"
protected java.lang.String	_value defaults to null.
protected java.lang.String	_where defaults to null.
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_DRIVERS
static java.lang.String	ARG_FIELD
static java.lang.String	ARG_NOUPDATE
static java.lang.String	ARG_OPSOURCE
static java.lang.String	ARG_PROPS
static java.lang.String	ARG_VALUE
static java.lang.String	ARG_WHERE
static java.lang.String	DEFAULT_CONNECTION Deprecated. NO default connection will be provided. Please provide when running test. parameter -connection "protocol://database-server-hostname:port" OR JVM Option: -Dsafs.jdbc.connection="<connection_uri>" Ex: -Dsafs.jdbc.connection="protocol://database-server-hostname:port"
static java.lang.String	DEFAULT_DEV_DATA "'/tst/tools/deploymentdetails/dev/shrdata'"
static java.lang.String	DEFAULT_DRIVERS "com.sas.net.sharenet.ShareNetDriver"
static java.lang.String	DEFAULT_PROD_DATA "'/tst/tools/deploymentdetails/shrdata'"
static java.lang.String	DEFAULT_SHRDATA_ID "mydata"
static java.lang.String	PROP_KEY_JDBC_DRIVERS
static java.lang.String	PROP_KEY_LIBREFS
static java.lang.String	PROP_KEY_SAFS_JDBC_CONNECTION
static java.lang.String	PROP_KEY_SAFS_JDBC_DATAID
static java.lang.String	PROP_KEY_SAFS_JDBC_DATAPATH
static java.lang.String	PROP_KEY_SAFS_JDBC_DATASET
static java.lang.String	PROP_KEY_SAFS_JDBC_DRIVERS
static java.lang.String	PROP_KEY_SAFS_JDBC_FIELD
static java.lang.String	PROP_KEY_SAFS_JDBC_NOUPDATE
static java.lang.String	PROP_KEY_SAFS_JDBC_OPSOURCE
static java.lang.String	PROP_KEY_SAFS_JDBC_PROPS
static java.lang.String	PROP_KEY_SAFS_JDBC_VALUE
static java.lang.String	PROP_KEY_SAFS_JDBC_WHERE
static java.lang.String	PROP_KEY_UNDOPOLICYNONE

Constructor Summary

Constructors

Constructor and Description
GenericJDBC()

Method Summary

Modifier and Type	Method and Description
void	enableUpdate(boolean enabled)
java.lang.String	getConnection()
java.lang.String	getDatapath()
java.lang.String	getDataset()
java.lang.String	getDrivers()
java.lang.String	getFieldName()
java.lang.String	getFieldValue()
java.lang.String	getOpsource()
java.util.Properties	getProps()
java.lang.String	getShrdataid()
protected java.lang.String	getSystemProperty(java.lang.String pname) Used internally to return a valid System Property value, or null.
java.lang.String	getWhere()
boolean	isUpdateEnabled()
static void	log(java.lang.String message) Currently logs to System.out.
static void	main(java.lang.String[] args) primarily a testing/debug 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) Create/Append a new JDBC Drivers value to any existing JDBC Drivers value stored in System Properties.
void	processJVMOptions() (Re)Set any arguments passed in as JVM -D Options.
void	processPropsArg(java.lang.String propsarg)
void	setConnection(java.lang.String _connection)
void	setDatapath(java.lang.String _datapath)
void	setDataset(java.lang.String _dataset)
void	setDrivers(java.lang.String _drivers)
void	setFieldName(java.lang.String _field)
void	setFieldValue(java.lang.String _value)
void	setOpsource(java.lang.String _opsource)
void	setProps(java.util.Properties _props)
void	setShrdataid(java.lang.String _shrdataid)
void	setWhere(java.lang.String _where)
void	updateData() Invokes updateData(String, Properties, String, String, String, String, String, String, String) with all internal settings previously set or defaulted.
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_SHRDATA_ID

public static final java.lang.String DEFAULT_SHRDATA_ID

"mydata"

See Also:

Constant Field Values

DEFAULT_PROD_DATA

public static final java.lang.String DEFAULT_PROD_DATA

"'/tst/tools/deploymentdetails/shrdata'"

See Also:

Constant Field Values

DEFAULT_DEV_DATA

public static final java.lang.String DEFAULT_DEV_DATA

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

See Also:

Constant Field Values

DEFAULT_DRIVERS

public static final java.lang.String DEFAULT_DRIVERS

"com.sas.net.sharenet.ShareNetDriver"

See Also:

Constant Field Values

DEFAULT_CONNECTION

@Deprecated
public static final java.lang.String DEFAULT_CONNECTION

Deprecated. NO default connection will be provided. Please provide when running test.

parameter -connection "protocol://database-server-hostname:port"
OR
JVM Option: -Dsafs.jdbc.connection="<connection_uri>"
Ex: -Dsafs.jdbc.connection="protocol://database-server-hostname:port"

See Also:

Constant Field Values

_connection

protected java.lang.String _connection

defaults to "protocol://database-server-hostname:port"

_drivers

protected java.lang.String _drivers

defaults to "com.sas.net.sharenet.ShareNetDriver"

_shrdataid

protected java.lang.String _shrdataid

defaults to "mydata"

_datapath

protected java.lang.String _datapath

defaults to "\'/tst/tools/deploymentdetails/shrdata\'"

_dataset

protected java.lang.String _dataset

defaults to null. Must be set by command-line arguments or API calls before a call to updateData().

_field

protected java.lang.String _field

defaults to null. Must be set by command-line arguments or API calls before a call to updateData().

_value

protected java.lang.String _value

defaults to null. Must be set by command-line arguments or API calls before a call to updateData().

_opsource

protected java.lang.String _opsource

defaults to null. Should be set by command-line arguments or API calls before a call to updateData(). A generic value may be used internally if none is provided beforehand.

_where

protected java.lang.String _where

defaults to null. Must be set by command-line arguments or API calls before a call to updateData().

_props

protected java.util.Properties _props

defaults to null. Should be set by command-line arguments or API calls before a call to updateData(), if needed.

_doUpdate

protected boolean _doUpdate

default: true. 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_JDBC_DRIVERS

public static final java.lang.String PROP_KEY_SAFS_JDBC_DRIVERS

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_NOUPDATE

public static final java.lang.String PROP_KEY_SAFS_JDBC_NOUPDATE

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_DATAID

public static final java.lang.String PROP_KEY_SAFS_JDBC_DATAID

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_DATAPATH

public static final java.lang.String PROP_KEY_SAFS_JDBC_DATAPATH

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_WHERE

public static final java.lang.String PROP_KEY_SAFS_JDBC_WHERE

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_DATASET

public static final java.lang.String PROP_KEY_SAFS_JDBC_DATASET

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_FIELD

public static final java.lang.String PROP_KEY_SAFS_JDBC_FIELD

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_VALUE

public static final java.lang.String PROP_KEY_SAFS_JDBC_VALUE

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_CONNECTION

public static final java.lang.String PROP_KEY_SAFS_JDBC_CONNECTION

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_PROPS

public static final java.lang.String PROP_KEY_SAFS_JDBC_PROPS

See Also:

Constant Field Values

PROP_KEY_SAFS_JDBC_OPSOURCE

public static final java.lang.String PROP_KEY_SAFS_JDBC_OPSOURCE

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

GenericJDBC

public GenericJDBC()

Method Detail

log

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

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

enableUpdate

public void enableUpdate(boolean enabled)

Parameters:

enabled - -- Set true (default) to enable database updates. False to disable/bypass database updates.

isUpdateEnabled

public boolean isUpdateEnabled()

Returns:

true if database updates are enabled. false otherwise.

getConnection

public java.lang.String getConnection()

Returns:

the current value of the JDBC connection string.

setConnection

public void setConnection(java.lang.String _connection)

Parameters:

_connection - -- Set/Change the value of the JDBC connection string.

getDrivers

public java.lang.String getDrivers()

Returns:

the current value of the JDBC drivers string.

setDrivers

public void setDrivers(java.lang.String _drivers)

Parameters:

_drivers - -- Set/Change the value of the JDBC drivers string.

getShrdataid

public java.lang.String getShrdataid()

Returns:

the current value of the Share data id to be used with JDBC. This might only apply to SAS Connect JDBC data connections.

setShrdataid

public void setShrdataid(java.lang.String _shrdataid)

Parameters:

_shrdataid - -- Set/Change the Share data id to be used with JDBC. This might only apply to SAS Connect JDBC data connections.

getDatapath

public java.lang.String getDatapath()

Returns:

the current value of the database path to be used with JDBC.

setDatapath

public void setDatapath(java.lang.String _datapath)

Parameters:

_datapath - -- Set/Change the database path to be used with JDBC.

getDataset

public java.lang.String getDataset()

Returns:

the current value of the dataset in the JDBC database to use.

setDataset

public void setDataset(java.lang.String _dataset)

Parameters:

_dataset - -- Set/Change the dataset in the database to be used with JDBC.

getFieldName

public java.lang.String getFieldName()

Returns:

the current field/column name that will be used in the JDBC dataset.

setFieldName

public void setFieldName(java.lang.String _field)

Parameters:

_field - -- Set/Change the field/column name that will be used in the JDBC dataset.

getFieldValue

public java.lang.String getFieldValue()

Returns:

the current field value set to be used on the field in the JDBC dataset.

setFieldValue

public void setFieldValue(java.lang.String _value)

Parameters:

_value - -- Set/Change the field value to be used on the field in the JDBC dataset.

getOpsource

public java.lang.String getOpsource()

Returns:

the current opSource (comment) setting that will be sent to the JDBC database.

setOpsource

public void setOpsource(java.lang.String _opsource)

Parameters:

_opsource - -- Set/Change the opSource (comment) that will be sent to the JDBC database.

getWhere

public java.lang.String getWhere()

Returns:

the current where clause setting that will be used on the JDBC database. This does NOT normally include the "where " prefix.

setWhere

public void setWhere(java.lang.String _where)

Parameters:

_where - -- Set/Change the where clause that will be used on the JDBC database. This setting should NOT include the "where " prefix.

getProps

public java.util.Properties getProps()

Returns:

the current Properties used for JDBC database connection, if any. May return null.

setProps

public void setProps(java.util.Properties _props)

Parameters:

_props - -- Set/Change the Properties used for JDBC database connection, if any. May be null.

updateData

public void updateData()

Invokes updateData(String, Properties, String, String, String, String, String, String, String) with all internal settings previously set or defaulted.

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.

The typical update:

             String update = "update "+ dataid +"."+ dataset
                          + " set "+ field +" = '"+ value +"'"    / * <-- single quotes critical * /
                          + " where "+ where
                          + " / * "+ opsource +" * /";

           

Then verification:

             String query = "select * from "+ dataid +"."+ dataset
                              +" where "+ where
                              + "  / * "+ opsource +"  * /";
 

Parameters:

connectURI - _connection

prop - _props

dataid - _shrdataid

datapath - _datapath

dataset - _dataset

field - _field

value - _value

where - _where

opsource - _opsource

getSystemProperty

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

Used internally to return a valid System Property value, or null.

processPropsArg

public void processPropsArg(java.lang.String propsarg)

Parameters:

propsarg - -- command-line -props value or JVM Option to be parsed and placed into _props.

processDriversArg

protected void processDriversArg(java.lang.String driversarg)

Create/Append a new JDBC Drivers value to any existing JDBC Drivers value stored in System Properties.

Parameters:

driversarg - -- one or more JDBC Driver class names separated by semi-colons as usually retrieved from the command-line arguments.

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/debug entry point.

command-line execution performs:

                GenericJDBC process = new GenericJDBC();
                process.processJVMOptions();
                process.processArgs(args);
                process.updateData();
 

Parameters:

args -