org.cristalise.restapi

Class ScriptUtils

java.lang.Object

org.cristalise.restapi.RestHandler

org.cristalise.restapi.ItemUtils

org.cristalise.restapi.ScriptUtils

public class ScriptUtils
extends ItemUtils

Nested Class Summary

Nested classes/interfaces inherited from class org.cristalise.restapi.RestHandler

RestHandler.AuthData

Field Summary

Fields inherited from class org.cristalise.restapi.ItemUtils

PREDEFINED_PATH

Fields inherited from class org.cristalise.restapi.RestHandler

COOKIENAME, PASSWORD, USERNAME

Constructor Summary

Constructors

Constructor and Description
ScriptUtils()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response.ResponseBuilder	executeScript(javax.ws.rs.core.HttpHeaders headers, ItemProxy item, String scriptName, Integer scriptVersion, String actPath, String inputJson, Map<String,Object> additionalInputs)
protected Object	executeScript(ItemProxy item, Script script, CastorHashMap inputs)
javax.ws.rs.core.Response.ResponseBuilder	returnScriptResult(String scriptName, ItemProxy item, Schema schema, Script script, CastorHashMap inputs, boolean jsonFlag)
protected javax.ws.rs.core.Response.ResponseBuilder	runScript(String scriptName, ItemProxy item, Schema schema, Script script, CastorHashMap inputs, boolean jsonFlag)

Methods inherited from class org.cristalise.restapi.ItemUtils

enumerate, enumerate, executeJob, executePredefinedStep, getAllViewpoints, getItemName, getItemNames, getItemURI, getItemURI, getItemURI, getItemURI, getJobActivityData, getJobItemData, getJobOutcomeData, getJobTransitionData, getOutcome, getOutcomeResponse, getOutcomeResponse, getOutcomeResponse, getPropertySummary, getProxy, getViewpointOutcome, makeCollectionData, makeEventData, makeJobData, produceJSON

Methods inherited from class org.cristalise.restapi.RestHandler

checkAndCreateNewCookie, checkAndCreateNewCookie, checkAuthCookie, createNewCookie, createNewCookie, decryptAuthData, encryptAuthData, getAgent, getAgent, getAgentPath, getPagedResult, getPropertiesFromQParams, makeItemDomainPathsData, toJSON

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptUtils

public ScriptUtils()

Method Detail

executeScript

protected Object executeScript(ItemProxy item,
                               Script script,
                               CastorHashMap inputs)
                        throws ScriptingEngineException,
                               org.cristalise.kernel.common.InvalidDataException

Parameters:

item -

script -

Returns:

Throws:

ScriptingEngineException

org.cristalise.kernel.common.InvalidDataException

executeScript

public javax.ws.rs.core.Response.ResponseBuilder executeScript(javax.ws.rs.core.HttpHeaders headers,
                                                               ItemProxy item,
                                                               String scriptName,
                                                               Integer scriptVersion,
                                                               String actPath,
                                                               String inputJson,
                                                               Map<String,Object> additionalInputs)
                                                        throws org.cristalise.kernel.common.ObjectNotFoundException,
                                                               UnsupportedOperationException

Throws:

org.cristalise.kernel.common.ObjectNotFoundException

UnsupportedOperationException

returnScriptResult

public javax.ws.rs.core.Response.ResponseBuilder returnScriptResult(String scriptName,
                                                                    ItemProxy item,
                                                                    Schema schema,
                                                                    Script script,
                                                                    CastorHashMap inputs,
                                                                    boolean jsonFlag)
                                                             throws ScriptingEngineException,
                                                                    org.cristalise.kernel.common.InvalidDataException

Throws:

ScriptingEngineException

org.cristalise.kernel.common.InvalidDataException

runScript

protected javax.ws.rs.core.Response.ResponseBuilder runScript(String scriptName,
                                                              ItemProxy item,
                                                              Schema schema,
                                                              Script script,
                                                              CastorHashMap inputs,
                                                              boolean jsonFlag)
                                                       throws ScriptingEngineException,
                                                              org.cristalise.kernel.common.InvalidDataException,
                                                              org.cristalise.kernel.common.ObjectNotFoundException

Parameters:

scriptName -

item -

schema -

script -

jsonFlag - whether the response is a JSON or XML

Returns:

Throws:

org.cristalise.kernel.common.ObjectNotFoundException

ScriptingEngineException

org.cristalise.kernel.common.InvalidDataException