Package step.plugins.java
Class GeneralScriptFunction
- java.lang.Object
-
- step.core.accessors.AbstractIdentifiableObject
-
- step.core.accessors.AbstractOrganizableObject
-
- step.functions.Function
-
- step.plugins.java.GeneralScriptFunction
-
- All Implemented Interfaces:
EnricheableObject
public class GeneralScriptFunction extends Function
This class encapsulates the configuration parameters of functions (aka Keywords) of type "Script"
-
-
Field Summary
-
Fields inherited from class step.functions.Function
APPLICATION, callTimeout, description, executeLocally, htmlTemplate, managed, schema, tokenSelectionCriteria, useCustomTemplate
-
-
Constructor Summary
Constructors Constructor Description GeneralScriptFunction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DynamicValue<String>
getErrorHandlerFile()
DynamicValue<String>
getLibrariesFile()
DynamicValue<String>
getScriptFile()
DynamicValue<String>
getScriptLanguage()
void
setErrorHandlerFile(DynamicValue<String> errorHandlerFile)
void
setLibrariesFile(DynamicValue<String> librariesFile)
void
setScriptFile(DynamicValue<String> scriptFile)
void
setScriptLanguage(DynamicValue<String> scriptLanguage)
-
Methods inherited from class step.functions.Function
getCallTimeout, getDescription, getHtmlTemplate, getSchema, getTokenSelectionCriteria, isExecuteLocally, isManaged, isUseCustomTemplate, requiresLocalExecution, setCallTimeout, setDescription, setExecuteLocally, setHtmlTemplate, setManaged, setSchema, setTokenSelectionCriteria, setUseCustomTemplate
-
Methods inherited from class step.core.accessors.AbstractOrganizableObject
addAttribute, getAttribute, getAttributes, hasAttribute, setAttributes
-
Methods inherited from class step.core.accessors.AbstractIdentifiableObject
addCustomField, computeCustomFieldIfAbsent, equals, getCustomField, getCustomField, getCustomFields, getId, hashCode, setCustomFields, setId
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface step.core.objectenricher.EnricheableObject
addAttribute, getAttribute, getAttributes, setAttributes
-
-
-
-
Method Detail
-
getScriptFile
public DynamicValue<String> getScriptFile()
-
setScriptFile
public void setScriptFile(DynamicValue<String> scriptFile)
- Parameters:
scriptFile
- the path to the script file (.js, .groovy, .jar, depending on the script language)
-
getScriptLanguage
public DynamicValue<String> getScriptLanguage()
-
setScriptLanguage
public void setScriptLanguage(DynamicValue<String> scriptLanguage)
- Parameters:
scriptLanguage
- the script language of this function. Per default the following language are supported: javascript, groovy, java
-
getLibrariesFile
public DynamicValue<String> getLibrariesFile()
-
setLibrariesFile
public void setLibrariesFile(DynamicValue<String> librariesFile)
- Parameters:
librariesFile
- the path to the libraries to be used for the function. This can be a single jar or a folder containing a list of jars
-
getErrorHandlerFile
public DynamicValue<String> getErrorHandlerFile()
-
setErrorHandlerFile
public void setErrorHandlerFile(DynamicValue<String> errorHandlerFile)
- Parameters:
errorHandlerFile
- the path to the script to be executed when the function returns an error
-
-