com.ibm.tivoli.maximo.script

Class AbstractScriptDriver

java.lang.Object

com.ibm.tivoli.maximo.script.AbstractScriptDriver

All Implemented Interfaces:

ScriptDriver

Direct Known Subclasses:

JSR223ScriptDriver, MBRScriptDriver

public abstract class AbstractScriptDriver
extends java.lang.Object
implements ScriptDriver

Base abstract driver for scripts

Constructor Summary

Constructors

Constructor and Description
AbstractScriptDriver()

Method Summary

Modifier and Type	Method and Description
boolean	allowImplicitParams()
protected void	checkForScriptError(java.util.Map context) Verifies if the script has set the error flag - indicating an MXException has to be generated.
protected void	evalINParams(ScriptInfo scriptInfo, java.util.Map context, java.util.Map calculatedParamValues)
protected void	evalOUTParams(ScriptInfo scriptInfo, java.util.Map context, java.util.Map clonedContext, java.util.Map calculatedParamValues) Evaluate OUT/INOUT parameters.
protected abstract void	evalScript(ScriptInfo scriptInfo, java.util.Map context)
protected MXLogger	getLogger(java.lang.String name)
protected boolean	hasValueChanged(java.lang.String contextVar, java.util.Map context, java.util.Map clonedContext) Verifies if the parameter value has been modified by the script.
protected boolean	isChildAttribute(java.lang.String attrBindingValue)
protected boolean	isNull(java.lang.String s)
boolean	isParamErrorGroup(java.lang.String contextParam)
boolean	isParamErrorKey(java.lang.String contextParam)
boolean	isVarNameMatchesKeyWord(java.lang.String varName)
protected void	printMap(java.util.Set entries, java.lang.String text)
void	runScript(java.lang.String name, java.util.Map context) Executes the script identified by name
protected void	setValue(MboRemote mbo, java.lang.String attributeName, java.lang.Object value, long flag) Set value to mbo attribute.
boolean	supportsPublishedParams()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.tivoli.maximo.script.ScriptDriver

canRun, compileScript, getSupportedEngines, isBinaryScript, parseScriptForParams, preCompileScript, releaseResources, releaseResources

Constructor Detail

AbstractScriptDriver

public AbstractScriptDriver()

Method Detail

isVarNameMatchesKeyWord

public boolean isVarNameMatchesKeyWord(java.lang.String varName)

Specified by:

isVarNameMatchesKeyWord in interface ScriptDriver

runScript

public final void runScript(java.lang.String name,
                            java.util.Map context)
                     throws MXException,
                            java.rmi.RemoteException

Description copied from interface: ScriptDriver

Executes the script identified by name

Specified by:

runScript in interface ScriptDriver

Parameters:

name - - the name of the script to execute

context - - the execution context for the script runtime

Throws:

MXException

java.rmi.RemoteException

isParamErrorKey

public boolean isParamErrorKey(java.lang.String contextParam)

Parameters:

contextParam -

Returns:

boolean

isParamErrorGroup

public boolean isParamErrorGroup(java.lang.String contextParam)

Parameters:

contextParam -

Returns:

boolean

evalScript

protected abstract void evalScript(ScriptInfo scriptInfo,
                                   java.util.Map context)
                            throws MXException,
                                   java.rmi.RemoteException

Parameters:

scriptInfo -

context -

Throws:

MXException

java.rmi.RemoteException

evalINParams

protected void evalINParams(ScriptInfo scriptInfo,
                            java.util.Map context,
                            java.util.Map calculatedParamValues)
                     throws MXException,
                            java.rmi.RemoteException

Parameters:

scriptInfo -

context -

Throws:

MXException

java.rmi.RemoteException

isChildAttribute

protected boolean isChildAttribute(java.lang.String attrBindingValue)

isNull

protected boolean isNull(java.lang.String s)

Parameters:

s -

Returns:

boolean

printMap

protected void printMap(java.util.Set entries,
                        java.lang.String text)

evalOUTParams

protected void evalOUTParams(ScriptInfo scriptInfo,
                             java.util.Map context,
                             java.util.Map clonedContext,
                             java.util.Map calculatedParamValues)
                      throws MXException,
                             java.rmi.RemoteException

Evaluate OUT/INOUT parameters.

Parameters:

scriptInfo - the ScriptInfo object

context - the context map passed to the script

clonedContext - the cloned version of the context map

Throws:

MXException

java.rmi.RemoteException

checkForScriptError

protected void checkForScriptError(java.util.Map context)
                            throws MXException

Verifies if the script has set the error flag - indicating an MXException has to be generated.

Parameters:

context - the variable context passed to the script engine.

Throws:

MXException

setValue

protected void setValue(MboRemote mbo,
                        java.lang.String attributeName,
                        java.lang.Object value,
                        long flag)
                 throws MXException,
                        java.rmi.RemoteException

Set value to mbo attribute.

Parameters:

mbo - the mbo

attributeName - the attribute

value - the value to set

flag - the field flag

Throws:

MXException

java.rmi.RemoteException

getLogger

protected MXLogger getLogger(java.lang.String name)

Returns:

the logger instance

hasValueChanged

protected boolean hasValueChanged(java.lang.String contextVar,
                                  java.util.Map context,
                                  java.util.Map clonedContext)

Verifies if the parameter value has been modified by the script.

Parameters:

contextVar - the context param name

context - the context that is passed to the s script execution engine

clonedContext - the cloned version of the context

Returns:

true if value has been modified by the script and false if not

supportsPublishedParams

public boolean supportsPublishedParams()

Specified by:

supportsPublishedParams in interface ScriptDriver

allowImplicitParams

public boolean allowImplicitParams()

Specified by:

allowImplicitParams in interface ScriptDriver