com.fgm.scriptEngine

Class ScriptFacades

java.lang.Object

com.fgm.scriptEngine.ScriptFacades

public class ScriptFacades
extends java.lang.Object

Class for letting jython have access to databases and rest services that we allow.

Author:

phil.feldman

Field Summary

Fields

Modifier and Type	Field and Description
private DbHelper	_dbHelper The _db helper.
private java.lang.String	_driverName The _driver name.
private java.lang.String	_hostName The _host name.
private org.apache.log4j.Logger	_logger The _logger.
private java.lang.String	_passwordString The _password string.
private java.util.Properties	_props The _props.
private PublishSupportObject	_pso The _pso.
private DbTable	_table The _table.
private java.lang.String	_tableList The _table list.
private java.lang.String	_userName The _user name.
private java.lang.String	_visibility_dev2 The _visibility_dev2.
private java.lang.String	_visibility_scripting The _visibility_scripting.
static java.lang.String	SQL_MACRO_WRAPPER The Constant SQL_MACRO_WRAPPER.

Constructor Summary

Constructors

Constructor and Description
ScriptFacades() Instantiates a new script facades.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlert(AlertInfoObject alertObj) Add the AlertInfoObject and return its ID.
private boolean	checkLegalDbNames(java.lang.String tableName) Check to see that this table is on the list of "approved" tables.
private void	connect(java.lang.String dbName) Methods for Database interaction.
java.lang.String	convertXml(java.lang.String dashXml, java.lang.String mappingXml) Does string substitution in the dashXml based on the mappingXml.
protected void	createDashTemplateTable() Creates Table_dash_templates if it doesn't exist already.
boolean	createVisTable(java.lang.String scriptName, int roleId, int userId, java.lang.String tableName, DbTable tableData) Creates a table in visibility_dev 2 and updates the appropriate tables so that the data visualizer can read and display it.
boolean	createVisTable2(int roleId, int userId, java.lang.String tableName, java.util.List<java.lang.Object[]> data) wrapper method to create a table in Visiblity.
DbTable	dbQuery(java.lang.String sqlString) Runs a free form SQL string against the visibility_dev2 database.
DbTable	dbQuery(java.lang.String dbName, java.lang.String sqlString) Runs a free form SQL string against a passed-in database.
DbTable	dbStoredProc(java.lang.String databaseName, java.lang.String procName) Db stored proc.
DbTable	dbStoredQuery(java.lang.String queryName) Runs a named stored query and return results in DbTable format.
java.lang.String	dbTableToSolrXML(DbTable table) Db table to solr xml.
java.util.List<AlertInfoObject>	getAlertList() Gets the alert list.
java.util.List<java.lang.String>	getColumn(DbTable table, java.lang.String columnName) Gets the column.
java.util.List<java.lang.String>	getColumn(java.lang.String columnName) Gets the column.
java.util.HashMap<java.lang.String,java.lang.String>	getDashTemplateXml(java.lang.String dashName) Get the dashboard template description xml.
java.lang.String	getDashXml(java.lang.String dashName) Get the dashboard description xml.
java.util.List<java.lang.String>	getHeaders() * Get the headers of the current table.
java.util.List<java.lang.String>	getHeaders(DbTable table) * Get a list of headers as Strings.
java.lang.String[]	getLegalDbNames() Gets the legal db names.
java.lang.String[]	getMethodList() Gets the method list.
int	getRoleId(java.lang.String roleName) Get the id number of the role from table_roless.
SQLResult	getSavedSQLs() * Returns a list of all the queries in the SQL table.
SQLResult	getStoredQueries() get an SQLResult containing all the queries stored in the table_queries in visibility_scripting.
java.util.List<java.util.List<java.lang.String>>	getTable() * Get the current table as a list of list.
java.util.List<java.util.List<java.lang.String>>	getTable(DbTable table) * Return the table as a list of list.
int	getUserId(java.lang.String userLogin) Get the id number of the user from table_users.
static java.lang.String	getVersion() Gets the version string (e.g.
static void	main(java.lang.String[] args) The main method.
private void	outputPrettyXml(org.dom4j.Document doc, java.io.Writer out) Output pretty xml.
java.util.ArrayList	parseResultSet(java.sql.ResultSet rs) Parse a result set into a list of lists, where the first list is the column headings and the subsequent lists contain the data.
void	publishXml(java.lang.String urlStr, java.lang.String xmlStr) Create an entry in visibility_scripting.table_publish.
java.lang.String	readXml(java.lang.String urlStr) Return the content of an url as a String.
boolean	runPrecompiledInsert(java.lang.String schemaName, java.lang.String tableName, java.util.HashMap<java.lang.String,java.lang.String> valueMap) set up and run a precompiled insert for a table.
java.lang.Boolean	runPythonScript(java.lang.String scriptName) Run python script.
SQLResult	runSQLStrings(java.lang.String databaseName, java.lang.String sqlList, java.lang.String macrosXML) run list of SQLs on MySQL database, return results accordingly.
java.lang.Boolean	saveMacros(java.lang.String queryName, java.util.HashMap<java.lang.String,java.lang.String> valueMap) Store macros for the named query.
java.lang.Boolean	saveMacrosXML(java.lang.String queryName, java.lang.String xml) Saves XML that contains variable names and values.
java.lang.Boolean	saveSQLs(java.lang.String queryName, java.lang.String databaseName, java.lang.String SQLs, java.lang.String xml) Add or update a query in table_queries.
boolean	setDashTemplateXml(java.lang.String dashName, java.lang.String xmlTemplate, java.lang.String xmlVariables) Place template and variables xml into a line in the table_dash_templates table.
void	setDebugDatabases() Sets the debug databases.
void	setReleaseDatabases() Sets the release databases.
private void	setup() Setup.
void	unPublishXml(java.lang.String urlStr) Turn off the publishing, above.

Methods inherited from class java.lang.Object

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

Field Detail

_hostName

private java.lang.String _hostName

The _host name.

_driverName

private java.lang.String _driverName

The _driver name.

_userName

private java.lang.String _userName

The _user name.

_passwordString

private java.lang.String _passwordString

The _password string.

_tableList

private java.lang.String _tableList

The _table list.

_visibility_dev2

private java.lang.String _visibility_dev2

The _visibility_dev2.

_visibility_scripting

private java.lang.String _visibility_scripting

The _visibility_scripting.

_table

private DbTable _table

The _table.

_logger

private org.apache.log4j.Logger _logger

The _logger.

_props

private java.util.Properties _props

The _props.

_dbHelper

private DbHelper _dbHelper

The _db helper.

_pso

private PublishSupportObject _pso

The _pso.

SQL_MACRO_WRAPPER

public static final java.lang.String SQL_MACRO_WRAPPER

The Constant SQL_MACRO_WRAPPER.

See Also:

Constant Field Values

Constructor Detail

ScriptFacades

public ScriptFacades()

Instantiates a new script facades.

Method Detail

setDebugDatabases

public void setDebugDatabases()

Sets the debug databases.

setReleaseDatabases

public void setReleaseDatabases()

Sets the release databases.

setup

private void setup()

Setup.

getMethodList

public java.lang.String[] getMethodList()

Gets the method list.

Returns:

the method list

readXml

public java.lang.String readXml(java.lang.String urlStr)

Return the content of an url as a String. A better name for this class would be "readXmlFromUrl", since what it's actually doing is getting the xml contents of an entry in the DB that is RESTfully accessible

Parameters:

urlStr - the url str

Returns:

the string

publishXml

public void publishXml(java.lang.String urlStr,
              java.lang.String xmlStr)

Create an entry in visibility_scripting.table_publish. This causes the servlet to publish whatever is in the xmlStr at .../VisibilityScriptingServer/Publisher/urlStr. If there is no leading "/" the method will add one.

Parameters:

urlStr - the url str

xmlStr - the xml str

addAlert

public void addAlert(AlertInfoObject alertObj)

Add the AlertInfoObject and return its ID.

Parameters:

alertObj - the alert obj

getAlertList

public java.util.List<AlertInfoObject> getAlertList()

Gets the alert list.

Returns:

the alert list

unPublishXml

public void unPublishXml(java.lang.String urlStr)

Turn off the publishing, above.

Parameters:

urlStr - the url str

checkLegalDbNames

private boolean checkLegalDbNames(java.lang.String tableName)

Check to see that this table is on the list of "approved" tables.

Parameters:

tableName - the table name

Returns:

true, if successful

getLegalDbNames

public java.lang.String[] getLegalDbNames()

Gets the legal db names.

Returns:

the legal db names

connect

private void connect(java.lang.String dbName)

Methods for Database interaction.

Parameters:

dbName - the db name

runPrecompiledInsert

public boolean runPrecompiledInsert(java.lang.String schemaName,
                           java.lang.String tableName,
                           java.util.HashMap<java.lang.String,java.lang.String> valueMap)

set up and run a precompiled insert for a table. The valueMap contains key/value pairs that should match the columns in the table. The table is interrogated to find the format that the value should be stored in, and a conversion from the string is made at that time.

Parameters:

schemaName - - the name of the database. Must be a 'legally accessible' db from VSS

tableName - - the name of the table. Can be anything in the db, so be careful!

valueMap - - contains key/value pairs that should match the columns in the table

Returns:

true if the insert succeeded

dbStoredProc

public DbTable dbStoredProc(java.lang.String databaseName,
                   java.lang.String procName)

Db stored proc.

Parameters:

databaseName - the database name

procName - the proc name

Returns:

the db table

dbStoredQuery

public DbTable dbStoredQuery(java.lang.String queryName)

Runs a named stored query and return results in DbTable format.

Parameters:

queryName - the query name

Returns:

the db table

dbQuery

public DbTable dbQuery(java.lang.String sqlString)

Runs a free form SQL string against the visibility_dev2 database.

Parameters:

sqlString - - the SQL query

Returns:

DbTable with result

dbQuery

public DbTable dbQuery(java.lang.String dbName,
              java.lang.String sqlString)

Runs a free form SQL string against a passed-in database.

Parameters:

dbName - - the database name

sqlString - - the SQL query

Returns:

DbTable with result

getHeaders

public java.util.List<java.lang.String> getHeaders()

* Get the headers of the current table.

Returns:

the headers

getHeaders

public java.util.List<java.lang.String> getHeaders(DbTable table)

* Get a list of headers as Strings.

Parameters:

table - - the table that we want the headers too

Returns:

the headers

getTable

public java.util.List<java.util.List<java.lang.String>> getTable()

* Get the current table as a list of list.

Returns:

List>

getTable

public java.util.List<java.util.List<java.lang.String>> getTable(DbTable table)

* Return the table as a list of list.

Parameters:

table - the table

Returns:

List>

getColumn

public java.util.List<java.lang.String> getColumn(java.lang.String columnName)

Gets the column.

Parameters:

columnName - the column name we're trying to find

Returns:

List

getColumn

public java.util.List<java.lang.String> getColumn(DbTable table,
                                         java.lang.String columnName)

Gets the column.

Parameters:

table - the table the column is in

columnName - the column name we're trying to find

Returns:

List

outputPrettyXml

private void outputPrettyXml(org.dom4j.Document doc,
                   java.io.Writer out)

Output pretty xml.

Parameters:

doc - the doc

out - the output Writer

dbTableToSolrXML

public java.lang.String dbTableToSolrXML(DbTable table)

Db table to solr xml.

Parameters:

table - the DbTable to convert

Returns:

the string in SOLR format

runSQLStrings

public SQLResult runSQLStrings(java.lang.String databaseName,
                      java.lang.String sqlList,
                      java.lang.String macrosXML)

run list of SQLs on MySQL database, return results accordingly.

Parameters:

databaseName - the database name

sqlList - a set of SQL commands: "select * from #table1# left join #table2#"

macrosXML - the macros xml: "

Returns:

SQLResult (resultset)

getStoredQueries

public SQLResult getStoredQueries()

get an SQLResult containing all the queries stored in the table_queries in visibility_scripting.

Returns:

the stored queries

parseResultSet

public java.util.ArrayList parseResultSet(java.sql.ResultSet rs)
                                   throws java.sql.SQLException

Parse a result set into a list of lists, where the first list is the column headings and the subsequent lists contain the data.

Parameters:

rs - the ResultSet to Parse

Returns:

the ArrayList

Throws:

java.sql.SQLException - the SQL exception

saveSQLs

public java.lang.Boolean saveSQLs(java.lang.String queryName,
                         java.lang.String databaseName,
                         java.lang.String SQLs,
                         java.lang.String xml)

Add or update a query in table_queries.

Parameters:

queryName - the query name

databaseName - the database name

SQLs - the SQL query

xml - macro xml

Returns:

true if successful, false otherwise

saveMacros

public java.lang.Boolean saveMacros(java.lang.String queryName,
                           java.util.HashMap<java.lang.String,java.lang.String> valueMap)

Store macros for the named query.

Parameters:

queryName - the query that uses this macro

valueMap - the value map that contains the macro NAME and VALUE

Returns:

true if successful

saveMacrosXML

public java.lang.Boolean saveMacrosXML(java.lang.String queryName,
                              java.lang.String xml)

Saves XML that contains variable names and values. All values are strings Example XML: macros for the named query

Parameters:

queryName - - the name that's stored in the query db

xml - - the xml shown above

Returns:

- true if success

getSavedSQLs

public SQLResult getSavedSQLs()

* Returns a list of all the queries in the SQL table.

Returns:

SQLResult containing data and status

createVisTable2

public boolean createVisTable2(int roleId,
                      int userId,
                      java.lang.String tableName,
                      java.util.List<java.lang.Object[]> data)

wrapper method to create a table in Visiblity.

Parameters:

roleId - - the role guid of the user as returned by getRoleId()

userId - - the guid of the user as returned by getUserId()

tableName - - the name of the table to be created

data - - a list containing the data to be written to the DB. All values are strings. first row contains the header, rests are data

Returns:

true if successful, false otherwise.

createVisTable

public boolean createVisTable(java.lang.String scriptName,
                     int roleId,
                     int userId,
                     java.lang.String tableName,
                     DbTable tableData)

Creates a table in visibility_dev 2 and updates the appropriate tables so that the data visualizer can read and display it. If a table with the same name exists, that table is deleted and the new table takes its place (with a new guid).

Parameters:

scriptName - the script name (unused)

roleId - - the role guid of the user as returned by getRoleId()

userId - - the guid of the user as returned by getUserId()

tableName - - the name of the table to be created

tableData - - a DbTable containing the data to be written to the DB. All values are strings.

Returns:

true if successful, false otherwise.

createDashTemplateTable

protected void createDashTemplateTable()
                                throws java.lang.Exception

Creates Table_dash_templates if it doesn't exist already.

Throws:

java.lang.Exception - the exception

getDashXml

public java.lang.String getDashXml(java.lang.String dashName)

Get the dashboard description xml. This is generally used indirectly to produce a template

Parameters:

dashName - - the name of the dashboard in table_dashboards

Returns:

the dash xml

getDashTemplateXml

public java.util.HashMap<java.lang.String,java.lang.String> getDashTemplateXml(java.lang.String dashName)

Get the dashboard template description xml. This is generally used to programatically change values in a dashboard

Parameters:

dashName - the name of the dashboard in table_dash_templates

Returns:

- a HashMap containing the dash xml and the variables xml. The hashmap is accessed with the keys "layout" and "variables".

convertXml

public java.lang.String convertXml(java.lang.String dashXml,
                          java.lang.String mappingXml)

Does string substitution in the dashXml based on the mappingXml. This can convert a file to or from a template file

Parameters:

dashXml - - the xml to be converted

mappingXml - - the xml cotaining the mappings described above

Returns:

- the converted dash xml

setDashTemplateXml

public boolean setDashTemplateXml(java.lang.String dashName,
                         java.lang.String xmlTemplate,
                         java.lang.String xmlVariables)

Place template and variables xml into a line in the table_dash_templates table. Format for The template is the same as the dash. The xml needs to contain a list of the variables that are to be used in substitution. Format follows:

Parameters:

dashName - the dash name

xmlTemplate - - the dashboard xml that contains the variables to be replaced

xmlVariables - - the xml that contains the variables as described above

Returns:

true if the table was created, false otherwise

getRoleId

public int getRoleId(java.lang.String roleName)

Get the id number of the role from table_roless. If there is no match, return a -1

Parameters:

roleName - the role name

Returns:

- the uid number from table_roles

getUserId

public int getUserId(java.lang.String userLogin)

Get the id number of the user from table_users. If there is no match, return a -1

Parameters:

userLogin - the user login

Returns:

- the uid number from table_users

getVersion

public static java.lang.String getVersion()

Gets the version string (e.g. "Version 4.9.2014 - pgfeldman")

Returns:

the version

runPythonScript

public java.lang.Boolean runPythonScript(java.lang.String scriptName)

Run python script.

Parameters:

scriptName - the name of the script in the script table

Returns:

true if successful

main

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

The main method. For debugging only

Parameters:

args - the arguments

Throws:

java.lang.Exception - the exception