oracle.ifs.core.tools.script

Class ScriptDriver

java.lang.Object

oracle.ifs.common.BaseMain

oracle.ifs.common.BaseApp

oracle.ifs.core.tools.script.ScriptDriver

All Implemented Interfaces:

Runnable, Logger

Direct Known Subclasses:

ScriptHandler.LocalScriptDriver, ScriptRunner

public class ScriptDriver
extends BaseApp

A ScriptDriver provides framework for testing the business logic of ECM using a canonical output and diff approach.

Version:

1.0

Author:

Dave Long

(Published)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ScriptDriver.MethodInfo MethodInfo holds information about a method (operation) specified.

Field Summary

Fields inherited from class oracle.ifs.common.BaseApp

m_currentuser, m_session

Fields inherited from class oracle.ifs.common.BaseMain

m_defaultWriter, m_logWriter, m_parametertable, m_timervalue

Constructor Summary

Constructors

Constructor and Description
ScriptDriver(String[] args) Constructs a ScriptDriver.

Method Summary

Modifier and Type	Method and Description
protected void	applyLogLevelOverride(String logEntry) Apply a log level overrides.
protected void	applyLogLevelOverrides(String[] logEntries) Apply a set of log level overrides.
protected boolean	businessObjectExists(String tag) Check whether a BusinessObject has been registered for the specified tag.
protected LibraryObjectDefinition	cloneDefinition(LibrarySession sess, String sourceDefTag, String cloneDefTag) Clone a LibraryObjectDefinition by the specified source tag.
ScriptDriver.MethodInfo	createMethodInfo(String token, ParameterTable ptArg) Construct and return a MethodInfo instance.
protected boolean	definitionExists(String tag) Check whether a definition has been registered for the specified tag.
protected void	deregisterBusinessObject(String tag) De-register a BusinessObject by name.
protected void	deregisterDefinition(String tag) De-register a LibraryObjectDefinition by name.
protected void	deregisterObject(String tag) De-register a LibraryObject by name.
protected void	deregisterSession(String tag, LibrarySession sess) De-register a session.
protected Transaction	deregisterTransaction(String trantag) De-register a transaction.
String	getArrayTokenDelimiter() Get the delimiter to use when parsing array tokens (defaults to ",").
AuditDriverHelper	getAuditDriverHelper() Return the AuditDriverHelper in use.
protected LibrarySession	getCurrentSession() Get the current session.
protected ScriptOperations	getDefaultScriptOperations(ScriptDriver driver) Return a newly constructed instance of the ScriptOperations instance to use by default.
protected PrintWriter	getLogWriter() Return the log writer in use.
protected boolean	getShowDates() Return indication as to whether dates should be shown in the output.
protected String[]	getStringsFromArrayToken(String token) Get String array from a value of the form "{value1, value2, value3}".
protected boolean	getStripNumbersFromAuditEventProperties() Return indication as to whether numbers should be replaced in audit event properties in ShowUtils.showAuditEvents.
String	getSubstitutionPrefix() Get the prefix indicating a substitution reference.
protected void	initializeLogging(ParameterTable params) Initialize logging context.
void	log(String msg) Log the specified message to the logger's log.
protected void	logToLogger(Level level, String msg) Log the specified message to the logger's log.
protected void	logToLogger(String msg) Log the specified message to the logger's log.
protected void	logToOutput(String msg) Log the specified message to the configured output log.
protected Object	lookupBusinessObject(LibrarySession session, String tag) Lookup a BusinessObject by the specified tag.
protected LibraryObjectDefinition	lookupDefinition(LibrarySession sess, String tag) Lookup a LibraryObjectDefinition by the specified tag.
protected LibraryObjectDefinition	lookupDefinition(LibrarySession sess, String tag, String className) Lookup a LibraryObjectDefinition by the specified tag and that is the appropriate instance for the specified classobject name.
protected LibraryObject	lookupObject(LibrarySession sess, String tag) Lookup a LibraryObject by the specified tag.
protected LibraryObject	lookupObject(LibrarySession sess, String tag, String className) Lookup a LibraryObject by the specified tag and that is an instance of the specified class.
AttributeValue	lookupObjectAttributeValue(String tag) Lookup an AttributeValue that identifies a LibraryObject, by the specified tag.
protected Long	lookupObjectId(LibrarySession sess, String tag) Lookup a LibraryObject's ID by the specified tag.
protected LibrarySession	lookupSessionByTag(String tag) Lookup a session by the session tag that was used to register it.
protected String	lookupTagBySessionId(Long sessid) Lookup a session tag by the session ID.
protected boolean	objectExists(String tag) Check whether an object has been registered for the specified tag.
protected void	registerBusinessObject(String tag, Object obj) Register a BusinessObject by name.
protected void	registerDefinition(String tag, LibraryObjectDefinition def) Register a LibraryObjectDefinition by name.
protected void	registerNewSession(String sesstag, LibrarySession sess) Register a session.
protected void	registerObject(String tag, LibraryObject obj) Register a LibraryObject by name.
protected void	registerTransaction(String trantag, Transaction tran) Register a transaction.
protected LibrarySession	replaceSession(String tag, LibrarySession newSess) Replace a previously registered session with a different session.
void	run() Run the driver.
protected boolean	sessionExists(String tag) Check whether a session has been registered for the specified tag.
void	setArrayTokenDelimiter(String delim) Set the delimiter to use when parsing array tokens.
protected void	setCurrentSession(LibrarySession session) Make the specified session the default.
void	setDefaultScriptOperations(ScriptOperations ops) Sets the instance to use as the default script operations class.
void	setDefaultScriptOperationsClass() Restores the script operations class to the initial default.
void	setDefaultScriptOperationsClass(String className) Sets the class name of the instance to use as the default script operations class.
void	setMainSession(LibrarySession session) Set the Main session, to avoid constructing a new one.
protected void	setMainSessionAsCurrentSession() Sets the main session as the current session.
void	setMethodList(String[] methods) Set the method list, instead of picking this up from the ParameterTable.
void	setSubstitutionPrefix(String prefix) Set the prefix indicating a substitution reference.
protected boolean	transactionExists(String tag) Check whether a Transaction has been registered for the specified tag.
protected void	verifyBusinessObjectTagNotExists(String defTag) Verify that the specified BusinessObject tag does not already exist.
protected void	verifyDefinitionTagNotExists(String defTag) Verify that the specified definition tag does not already exist.
protected void	verifyDefinitionWriteable(LibrarySession sess, String tag) Verify that a LibraryObjectDefinition identified by the specified tag is writeable.
protected void	verifyObjectTagNotExists(String objTag) Verify that the specified object tag does not already exist.

Methods inherited from class oracle.ifs.common.BaseApp

connect, Connect, connect, Connect, Connect, Connect, connect, Connect, connect, Connect, Disconnect, getCachePerformanceString, getCleartextCredential, getCleartextCredential, getConnectionPoolPerformanceString, getConnectOptions, getConnectOptions, getConnectOptions, getLocale, showCachePerformance, showConnectionPoolPerformance

Methods inherited from class oracle.ifs.common.BaseMain

getElapsedTime, getParameterTable, initTrace, log, logCurrentTimestamp, printStackTrace, setTimer, showElapsedTime

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptDriver

public ScriptDriver(String[] args)

Constructs a ScriptDriver.

Parameters:

args - commandline arguments

(Published)

Method Detail

setMainSession

public void setMainSession(LibrarySession session)

Set the Main session, to avoid constructing a new one.

This session will NOT get automatically disconnected as part on run.

Parameters:

session - the main session

(Published)

setMethodList

public void setMethodList(String[] methods)

Set the method list, instead of picking this up from the ParameterTable.

Parameters:

methods - the method list

(Published)

run

public void run()

Run the driver.

This consumes any exception after reporting it in the log.

(Published)

createMethodInfo

public ScriptDriver.MethodInfo createMethodInfo(String token,
                                                ParameterTable ptArg)

Construct and return a MethodInfo instance.

Parameters:

token - the token to parse

Returns:

a MethodInfo instance

(Published)

getStringsFromArrayToken

protected String[] getStringsFromArrayToken(String token)
                                     throws IfsException

Get String array from a value of the form "{value1, value2, value3}".

Parameters:

token - the string token

Returns:

the corresponding array

Throws:

IfsException - if the operation fails

(Published)

getCurrentSession

protected LibrarySession getCurrentSession()
                                    throws IfsException

Get the current session.

The current session starts out as a session tagged as "Main", and can be switched to any other connected session. I new session gets connected via the createSession() operation. The current session is the session specified in the last switchSession() or createSession() statement. If the current session is removed, the current session becomes "Main".

Returns:

the session

Throws:

IfsException - if the operation fails

(Published)

setCurrentSession

protected void setCurrentSession(LibrarySession session)
                          throws IfsException

Make the specified session the default.

Parameters:

session - the session

Throws:

IfsException - if the operation fails

(Published)

setMainSessionAsCurrentSession

protected void setMainSessionAsCurrentSession()
                                       throws IfsException

Sets the main session as the current session.

Throws:

IfsException - if the operation fails

(Published)

registerNewSession

protected void registerNewSession(String sesstag,
                                  LibrarySession sess)
                           throws IfsException

Register a session.

This registers a two-way lookup, enabling finding the session by the specified session tag, and the ability to determine the session tag from the LibrarySession.

Parameters:

sesstag - the session tag

sess - the session

Throws:

IfsException - if the operation fails

(Published)

deregisterSession

protected void deregisterSession(String tag,
                                 LibrarySession sess)
                          throws IfsException

De-register a session.

This is called automatically as part of removeSession(). If the specified tag does not identify a currently registered session, the operation is a no-op (no exception is thrown).

Parameters:

tag - the session tag

sess - the session context

Throws:

IfsException - if the operation fails

(Published)

replaceSession

protected LibrarySession replaceSession(String tag,
                                        LibrarySession newSess)
                                 throws IfsException

Replace a previously registered session with a different session.

Disconnects the previous session (if any).

Parameters:

tag - the session tag

newSess - the new session context

Returns:

the old session

Throws:

IfsException - if the operation fails

(Published)

lookupSessionByTag

protected LibrarySession lookupSessionByTag(String tag)

Lookup a session by the session tag that was used to register it.

A RuntimeException is thrown if there is no session registered with the specified tag.

Parameters:

tag - the session tag

Returns:

the session

(Published)

sessionExists

protected boolean sessionExists(String tag)

Check whether a session has been registered for the specified tag.

Parameters:

tag - the session tag

Returns:

true if a session has been registered with the specified tag; false otherwise

(Published)

lookupTagBySessionId

protected String lookupTagBySessionId(Long sessid)

Lookup a session tag by the session ID.

A RuntimeException is thrown if there is no session registered with the specified ID.

Parameters:

sessid - the session ID

Returns:

the session

(Published)

registerTransaction

protected void registerTransaction(String trantag,
                                   Transaction tran)

Register a transaction.

Parameters:

trantag - the Transaction tag

tran - the Transaction

(Published)

deregisterTransaction

protected Transaction deregisterTransaction(String trantag)

De-register a transaction.

Parameters:

trantag - the Transaction tag

Returns:

the Transaction that was removed, or null if no no Transaction was registered with that tag

(Published)

transactionExists

protected boolean transactionExists(String tag)

Check whether a Transaction has been registered for the specified tag.

Parameters:

tag - the Transaction tag

Returns:

true if a Transaction has been registered with the specified tag; false otherwise

(Published)

lookupObjectAttributeValue

public AttributeValue lookupObjectAttributeValue(String tag)
                                          throws IfsException

Lookup an AttributeValue that identifies a LibraryObject, by the specified tag.

Parameters:

tag - the tag

Returns:

the AttributeValue, or null if the tag does not identify an object AttributeValue

Throws:

IfsException - if the operation fails.

lookupObject

protected LibraryObject lookupObject(LibrarySession sess,
                                     String tag)
                              throws IfsException

Lookup a LibraryObject by the specified tag.

A RuntimeException is thrown if there is no object registered with the specified tag, or if the object previously registered with that tag no longer exists.

Parameters:

sess - the session

tag - the object tag

Returns:

the object

Throws:

IfsException - if the operation fails

(Published)

lookupObjectId

protected Long lookupObjectId(LibrarySession sess,
                              String tag)
                       throws IfsException

Lookup a LibraryObject's ID by the specified tag.

A RuntimeException is thrown if there is no object registered with the specified tag.

Parameters:

sess - the session

tag - the object tag

Returns:

the object ID

Throws:

IfsException - if the operation fails

(Published)

lookupObject

protected LibraryObject lookupObject(LibrarySession sess,
                                     String tag,
                                     String className)
                              throws IfsException

Lookup a LibraryObject by the specified tag and that is an instance of the specified class.

A RuntimeException is thrown if there is no object registered with the specified tag, or if the registered object is not an instance of the specified class.

Parameters:

sess - the session

tag - the object tag

className - the desired class

Returns:

the object

Throws:

IfsException - if the operation fails

(Published)

objectExists

protected boolean objectExists(String tag)

Check whether an object has been registered for the specified tag.

Parameters:

tag - the object tag

Returns:

true if an object has been registered with the specified tag; false otherwise

(Published)

verifyObjectTagNotExists

protected void verifyObjectTagNotExists(String objTag)

Verify that the specified object tag does not already exist. Throws a RuntimeException otherwise

Parameters:

objTag - the object tag

(Published)

registerObject

protected void registerObject(String tag,
                              LibraryObject obj)
                       throws IfsException

Register a LibraryObject by name.

Parameters:

tag - the object tag

obj - the object

Throws:

IfsException - if the operation fails

(Published)

deregisterObject

protected void deregisterObject(String tag)
                         throws IfsException

De-register a LibraryObject by name.

Parameters:

tag - the object tag

Throws:

IfsException - if the operation fails

(Published)

lookupDefinition

protected LibraryObjectDefinition lookupDefinition(LibrarySession sess,
                                                   String tag)
                                            throws IfsException

Lookup a LibraryObjectDefinition by the specified tag.

A RuntimeException is thrown if there is no definition registered with the specified tag.

Parameters:

sess - the session

tag - the definition tag

Returns:

the definition

Throws:

IfsException - if the operation fails

(Published)

verifyDefinitionWriteable

protected void verifyDefinitionWriteable(LibrarySession sess,
                                         String tag)
                                  throws IfsException

Verify that a LibraryObjectDefinition identified by the specified tag is writeable.

A RuntimeException is thrown if there is no definition registered with the specified tag, or if it is not writeable.

Parameters:

sess - the session

tag - the definition tag

Throws:

IfsException - if the operation fails

(Published)

lookupDefinition

protected LibraryObjectDefinition lookupDefinition(LibrarySession sess,
                                                   String tag,
                                                   String className)
                                            throws IfsException

Lookup a LibraryObjectDefinition by the specified tag and that is the appropriate instance for the specified classobject name.

A RuntimeException is thrown if there is no definition registered with the specified tag, or if the registered definition is not compatible with the specified class.

Parameters:

sess - the session

tag - the definition tag

className - the desired class

Returns:

the definition

Throws:

IfsException - if the operation fails

(Published)

cloneDefinition

protected LibraryObjectDefinition cloneDefinition(LibrarySession sess,
                                                  String sourceDefTag,
                                                  String cloneDefTag)
                                           throws IfsException

Clone a LibraryObjectDefinition by the specified source tag.

A RuntimeException is thrown if there is no definition registered with the specified source tag.

Parameters:

sess - the session

sourceDefTag - the source definition tag

cloneDefTag - the tag for the cloned definition

Returns:

the cloned definition

Throws:

IfsException - if the operation fails

(Published)

definitionExists

protected boolean definitionExists(String tag)

Check whether a definition has been registered for the specified tag.

Parameters:

tag - the definition tag

Returns:

true if a definition has been registered with the specified tag; false otherwise

(Published)

verifyDefinitionTagNotExists

protected void verifyDefinitionTagNotExists(String defTag)

Verify that the specified definition tag does not already exist. Throws a RuntimeException otherwise

Parameters:

defTag - the definition tag

(Published)

registerDefinition

protected void registerDefinition(String tag,
                                  LibraryObjectDefinition def)
                           throws IfsException

Register a LibraryObjectDefinition by name.

Parameters:

tag - the definition tag

def - the definition

Throws:

IfsException - if the operation fails

(Published)

deregisterDefinition

protected void deregisterDefinition(String tag)
                             throws IfsException

De-register a LibraryObjectDefinition by name.

Parameters:

tag - the definition tag

Throws:

IfsException - if the operation fails

(Published)

lookupBusinessObject

protected Object lookupBusinessObject(LibrarySession session,
                                      String tag)
                               throws IfsException

Lookup a BusinessObject by the specified tag.

A RuntimeException is thrown if there is no BusinessObject registered with the specified tag.

Parameters:

session - the LibrarySession

tag - the BusinessObject tag

Returns:

the BusinessObject

Throws:

IfsException - if the operation fails

(Published)

businessObjectExists

protected boolean businessObjectExists(String tag)

Check whether a BusinessObject has been registered for the specified tag.

Parameters:

tag - the BusinessObject tag

Returns:

true if a BusinessObject has been registered with the specified tag; false otherwise

(Published)

verifyBusinessObjectTagNotExists

protected void verifyBusinessObjectTagNotExists(String defTag)

Verify that the specified BusinessObject tag does not already exist. Throws a RuntimeException otherwise

Parameters:

defTag - the BusinessObject tag

(Published)

registerBusinessObject

protected void registerBusinessObject(String tag,
                                      Object obj)
                               throws IfsException

Register a BusinessObject by name.

Parameters:

tag - the BusinessObject tag

obj - the BusinessObject

Throws:

IfsException - if the operation fails

(Published)

deregisterBusinessObject

protected void deregisterBusinessObject(String tag)
                                 throws IfsException

De-register a BusinessObject by name.

Parameters:

tag - the BusinessObject tag

Throws:

IfsException - if the operation fails

(Published)

initializeLogging

protected void initializeLogging(ParameterTable params)
                          throws IfsException

Initialize logging context.

Parameters:

params - ParameterTable containing the parameters (LogLevel and LogFileName parameters used here).

Throws:

IfsException - if the operation fails

(Published)

applyLogLevelOverrides

protected void applyLogLevelOverrides(String[] logEntries)

Apply a set of log level overrides.

Parameters:

logEntries - the log override entries

(Published)

applyLogLevelOverride

protected void applyLogLevelOverride(String logEntry)

Apply a log level overrides.

Parameters:

logEntry - the log override entry

(Published)

getLogWriter

protected PrintWriter getLogWriter()

Return the log writer in use.

Returns:

the writer used for logging the output

(Published)

getShowDates

protected boolean getShowDates()

Return indication as to whether dates should be shown in the output.

Returns:

true if date values should be shown in the output; false otherwise

(Published)

getStripNumbersFromAuditEventProperties

protected boolean getStripNumbersFromAuditEventProperties()

Return indication as to whether numbers should be replaced in audit event properties in ShowUtils.showAuditEvents.

Returns:

true if numbers should be replaced in the output; false otherwise

(Published)

getAuditDriverHelper

public AuditDriverHelper getAuditDriverHelper()

Return the AuditDriverHelper in use.

Returns:

the AuditDriverHelper used for auditing management

(Published)

getArrayTokenDelimiter

public String getArrayTokenDelimiter()

Get the delimiter to use when parsing array tokens (defaults to ",").

Returns:

the delimiter to use when parsing array tokens

(Published)

setArrayTokenDelimiter

public void setArrayTokenDelimiter(String delim)

Set the delimiter to use when parsing array tokens.

Parameters:

delim - the delimiter to use when parsing array tokens

(Published)

getSubstitutionPrefix

public String getSubstitutionPrefix()

Get the prefix indicating a substitution reference.

Defaults to "$$".

Returns:

the prefix indicating a substitution reference

(Published)

setSubstitutionPrefix

public void setSubstitutionPrefix(String prefix)

Set the prefix indicating a substitution reference.

(Published)

log

public void log(String msg)

Log the specified message to the logger's log.

Specified by:

log in interface Logger

Overrides:

log in class BaseMain

Parameters:

msg - The log message

(Published)

logToLogger

protected void logToLogger(String msg)

Log the specified message to the logger's log.

Parameters:

msg - The log message

(Published)

logToLogger

protected void logToLogger(Level level,
                           String msg)

Log the specified message to the logger's log.

Parameters:

level - The log level

msg - The log message

(Published)

logToOutput

protected void logToOutput(String msg)

Log the specified message to the configured output log.

Parameters:

msg - The log message

(Published)

getDefaultScriptOperations

protected ScriptOperations getDefaultScriptOperations(ScriptDriver driver)

Return a newly constructed instance of the ScriptOperations instance to use by default.

Parameters:

driver - ScriptDriver context

(Published)

setDefaultScriptOperationsClass

public void setDefaultScriptOperationsClass()

Restores the script operations class to the initial default.

(Published)

setDefaultScriptOperationsClass

public void setDefaultScriptOperationsClass(String className)

Sets the class name of the instance to use as the default script operations class.

Parameters:

className - the name of the default ops class to use

(Published)

setDefaultScriptOperations

public void setDefaultScriptOperations(ScriptOperations ops)

Sets the instance to use as the default script operations class.

Parameters:

ops - the default ops class to use

(Published)