com.fgm.visibilityScriptingServer.RemoteObjects

Class ScriptObject

java.lang.Object

com.fgm.visibilityScriptingServer.RemoteObjects.ScriptObject

public class ScriptObject
extends java.lang.Object

Class for transferring scripts and script results Flex and Java. Each script is in its own 'execution space', in that the ScriptEntity that contains the scriptRunner and the ScriptResultObject are stored in a hash map

Author:

phil.feldman

Field Summary

Fields

Modifier and Type	Field and Description
private DbHelper	_dbHelper The _db helper.
private java.lang.String	_dbName The _db name.
private java.lang.String	_driverName The _driver name.
private java.lang.String	_hostName The _host name.
protected static 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.
protected static java.util.HashMap<java.lang.String,ScriptEntity>	_scriptEntityMap The _script entity map.
protected static ScriptFacades	_scriptFacades The _script facades.
private java.lang.String	_userName The _user name.

Constructor Summary

Constructors

Constructor and Description
ScriptObject() Instantiates a new script object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlert(java.lang.String source, java.lang.String target, java.lang.String description) manually add an alert.
void	deletePublishedPage(java.lang.String fullName) Delete published page.
java.util.List<AlertInfoObject>	getAlertList() Gets the alert list.
java.lang.String[]	getFacadeMethodList() Gets the facade method list.
java.util.List<java.lang.String>	getFullNameList() Gets the list of fullNames
java.lang.String	getInfo() Get info about this class.
java.lang.String[]	getLegalDbNames() Get a list of all the databases that we can access.
PublishDataObject	getPublishedPage(java.lang.String fullName) Gets the published page.
java.lang.String	getPublishedPageInfo() Gets the published page info.
java.util.List<PublishDataObject>	getPublishedPageList() Gets the published page list.
SQLResult	getSavedSQLs() Returns a list of all the queries in the SQL table.
protected static ScriptEntity	getScriptEntity(java.lang.String name) Find the ScriptEntity by name.
ScriptResultObject	getScriptResultObject(java.lang.String name) Get the output of the script without running it.
java.lang.String	getScriptSchedule(java.lang.String name) Gets the script schedule.
java.lang.String[]	getStoredScripts() Get a list of all the scripts in the table_scripts
static void	main(java.lang.String[] args) The main method.
void	removeScript(java.lang.String name) Removes the script.
java.util.List<ScriptResultObject>	runPeriodicScripts() Run all the scripts that need to be run since the last time we called.
SQLResult	runSQLStrings(java.lang.String databaseName, java.lang.String sqlStrings, java.lang.String variablesXML) Run sql strings.
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.
ScriptResultObject	scriptRunner(java.lang.String name, java.lang.String desc, java.lang.String script) Run the provided script in the given namespace.
void	setScriptSchedule(java.lang.String name, java.lang.String startDateTime, int period) Sets the script schedule.
private void	setup() Setup the database access.
void	storeScript(java.lang.String name, java.lang.String description, byte[] bytes) Store script.

Methods inherited from class java.lang.Object

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

Field Detail

_props

private java.util.Properties _props

The _props.

_dbHelper

private DbHelper _dbHelper

The _db helper.

_hostName

private java.lang.String _hostName

The _host name.

_dbName

private java.lang.String _dbName

The _db 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.

_pso

private PublishSupportObject _pso

The _pso.

_logger

protected static org.apache.log4j.Logger _logger

The _logger.

_scriptEntityMap

protected static java.util.HashMap<java.lang.String,ScriptEntity> _scriptEntityMap

The _script entity map.

_scriptFacades

protected static ScriptFacades _scriptFacades

The _script facades.

Constructor Detail

ScriptObject

public ScriptObject()

Instantiates a new script object.

Method Detail

setup

private void setup()

Setup the database access. Create tables if they don't exist.

getScriptEntity

protected static ScriptEntity getScriptEntity(java.lang.String name)

Find the ScriptEntity by name. If there is no script with that name, then create one.

Parameters:

name - the name

Returns:

the script entity

getInfo

public java.lang.String getInfo()

Get info about this class.

Returns:

the info

addAlert

public void addAlert(java.lang.String source,
            java.lang.String target,
            java.lang.String description)

manually add an alert.

Parameters:

source - of the alert

target(s) - the alert

description - the description of the alert

getAlertList

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

Gets the alert list.

Returns:

List

getLegalDbNames

public java.lang.String[] getLegalDbNames()

Get a list of all the databases that we can access.

Returns:

String[]

getFacadeMethodList

public java.lang.String[] getFacadeMethodList()

Gets the facade method list.

Returns:

String[]

getPublishedPageInfo

public java.lang.String getPublishedPageInfo()

Gets the published page info.

Returns:

String

getPublishedPageList

public java.util.List<PublishDataObject> getPublishedPageList()

Gets the published page list.

Returns:

List

getPublishedPage

public PublishDataObject getPublishedPage(java.lang.String fullName)

Gets the published page.

Parameters:

fullName - the full name we're matching

Returns:

the PublishDataObject of success, null otherwise

getFullNameList

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

Gets the list of fullNames

Returns:

List

deletePublishedPage

public void deletePublishedPage(java.lang.String fullName)

Delete published page.

Parameters:

fullName - the fullName we're matching on

getStoredScripts

public java.lang.String[] getStoredScripts()

Get a list of all the scripts in the table_scripts

Returns:

String[]

scriptRunner

public ScriptResultObject scriptRunner(java.lang.String name,
                              java.lang.String desc,
                              java.lang.String script)

Run the provided script in the given namespace.

Parameters:

name - the name of the script (generally the search key in the db)

desc - - description

script - - jython script

Returns:

ScriptResultObject

getScriptResultObject

public ScriptResultObject getScriptResultObject(java.lang.String name)

Get the output of the script without running it.

Parameters:

name - the name of the script (generally the search key in the db)

Returns:

ScriptResultObject

getScriptSchedule

public java.lang.String getScriptSchedule(java.lang.String name)

Gets the script schedule.

Parameters:

name - ScriptResultObject

Returns:

String containing when the script period and when it was last run

setScriptSchedule

public void setScriptSchedule(java.lang.String name,
                     java.lang.String startDateTime,
                     int period)

Sets the script schedule.

Parameters:

name - the name of the script (generally the search key in the db)

startDateTime - the start dateTime

period - the period (in minutes)

runPeriodicScripts

public java.util.List<ScriptResultObject> runPeriodicScripts()

Run all the scripts that need to be run since the last time we called. Called by the servlet on a 15-minute period (setup in web.xml) this.

Returns:

List

storeScript

public void storeScript(java.lang.String name,
               java.lang.String description,
               byte[] bytes)

Store script.

Parameters:

name - the name to call the script

description - the description of what the script does

bytes - the script as a binary object

removeScript

public void removeScript(java.lang.String name)

Removes the script.

Parameters:

name - the name of the script to remove

runSQLStrings

public SQLResult runSQLStrings(java.lang.String databaseName,
                      java.lang.String sqlStrings,
                      java.lang.String variablesXML)

Run sql strings.

Parameters:

databaseName - the database name

sqlStrings - the sql commands/queries to run

variablesXML - the variables to embed in the sql

Returns:

SQLResult

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

getSavedSQLs

public SQLResult getSavedSQLs()

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

Returns:

SQLResult containing data and status

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

main

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

The main method. For debugging only

Parameters:

args - the arguments