com.ibm.tivoli.maximo.script

Interface ScriptDriver

All Known Implementing Classes:

AbstractScriptDriver, JSR223ScriptDriver, MBRScriptDriver

public interface ScriptDriver

Base interface for all script drivers.

Author:

Anamitra

Method Summary

Modifier and Type	Method and Description
boolean	allowImplicitParams()
boolean	canRun(java.lang.String scriptLang) Verify if the driver can support script language scriptLang
void	compileScript(java.lang.String scriptName, java.lang.String scriptSource, java.lang.String scriptLanguage)
java.util.Map<java.lang.String,ScriptEngineInfo>	getSupportedEngines()
boolean	isBinaryScript()
boolean	isVarNameMatchesKeyWord(java.lang.String varName)
java.util.List<ScriptParamInfo>	parseScriptForParams(byte[] scriptBytes)
boolean	preCompileScript(ScriptInfo scriptInfo) Precompiles the script
void	releaseResources() Call back method to release driver resources before the driver gets gced.
void	releaseResources(java.lang.String scriptName) Call back method to release driver resources before the driver gets gced.
void	runScript(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> context) Executes the script identified by name
boolean	supportsPublishedParams()

Method Detail

runScript

void runScript(java.lang.String name,
               java.util.Map<java.lang.String,java.lang.Object> context)
        throws MXException,
               java.rmi.RemoteException

Executes the script identified by name

Parameters:

name - - the name of the script to execute

context - - the execution context for the script runtime

Throws:

MXException

java.rmi.RemoteException

canRun

boolean canRun(java.lang.String scriptLang)

Verify if the driver can support script language scriptLang

Parameters:

scriptLang - the script language

Returns:

true if it can run and false otherwise

releaseResources

void releaseResources()

Call back method to release driver resources before the driver gets gced. This should be used by implementations to clean up driver level cache.

releaseResources

void releaseResources(java.lang.String scriptName)

Call back method to release driver resources before the driver gets gced. This should be used by implementations to clean up driver level cache.

preCompileScript

boolean preCompileScript(ScriptInfo scriptInfo)
                  throws MXException

Precompiles the script

Parameters:

scriptInfo - - the ScriptInfo object for the script

Throws:

MXException

java.rmi.RemoteException

compileScript

void compileScript(java.lang.String scriptName,
                   java.lang.String scriptSource,
                   java.lang.String scriptLanguage)
            throws MXException

Throws:

MXException

getSupportedEngines

java.util.Map<java.lang.String,ScriptEngineInfo> getSupportedEngines()

Returns:

list of supported engines

isBinaryScript

boolean isBinaryScript()

parseScriptForParams

java.util.List<ScriptParamInfo> parseScriptForParams(byte[] scriptBytes)
                                              throws MXException

Returns:

parse script to return the published script params

Throws:

MXException

isVarNameMatchesKeyWord

boolean isVarNameMatchesKeyWord(java.lang.String varName)

supportsPublishedParams

boolean supportsPublishedParams()

allowImplicitParams

boolean allowImplicitParams()