Package step.functions

Class Function

java.lang.Object

step.core.accessors.AbstractIdentifiableObject

step.core.accessors.AbstractOrganizableObject

step.functions.Function

All Implemented Interfaces:

EnricheableObject

Direct Known Subclasses:

CompositeFunction, GeneralScriptFunction, JMeterFunction, LocalFunctionPlugin.LocalFunction, NodeFunction

public class Function
extends step.core.accessors.AbstractOrganizableObject
implements EnricheableObject

This class encapsulates all the configuration parameters of functions (aka Keywords) which can also be defined on the configuration dialog of Keywords in the UI

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	APPLICATION
protected DynamicValue<java.lang.Integer>	callTimeout
protected java.lang.String	description
protected boolean	executeLocally
protected java.lang.String	htmlTemplate
protected boolean	managed
protected javax.json.JsonObject	schema
protected java.util.Map<java.lang.String,java.lang.String>	tokenSelectionCriteria
protected boolean	useCustomTemplate

Fields inherited from class step.core.accessors.AbstractOrganizableObject

attributes, NAME, VERSION

Fields inherited from class step.core.accessors.AbstractIdentifiableObject

customFields, ID

Constructor Summary

Constructors

Constructor	Description
Function()

Method Summary

Modifier and Type	Method	Description
DynamicValue<java.lang.Integer>	getCallTimeout()
java.lang.String	getDescription()
java.lang.String	getHtmlTemplate()
javax.json.JsonObject	getSchema()
java.util.Map<java.lang.String,java.lang.String>	getTokenSelectionCriteria()
boolean	isExecuteLocally()
boolean	isManaged()
boolean	isUseCustomTemplate()
boolean	requiresLocalExecution()
void	setCallTimeout(DynamicValue<java.lang.Integer> callTimeout)
void	setDescription(java.lang.String description)
void	setExecuteLocally(boolean executeLocally)	Defines if the function has to be executed on a local token
void	setHtmlTemplate(java.lang.String customTemplateContent)	Sets the HTML code to be used as template when editing the function in the plan editor
void	setManaged(boolean managed)
void	setSchema(javax.json.JsonObject schema)	Sets the JSON schema to be used to validate the function's input at execution time
void	setTokenSelectionCriteria(java.util.Map<java.lang.String,java.lang.String> tokenSelectionCriteria)	Defines additional selection criteria of agent token on which the function should be executed
void	setUseCustomTemplate(boolean customTemplate)

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

Field Detail

callTimeout

protected DynamicValue<java.lang.Integer> callTimeout

schema

protected javax.json.JsonObject schema

executeLocally

protected boolean executeLocally

tokenSelectionCriteria

protected java.util.Map<java.lang.String,java.lang.String> tokenSelectionCriteria

managed

protected boolean managed

useCustomTemplate

protected boolean useCustomTemplate

htmlTemplate

protected java.lang.String htmlTemplate

description

protected java.lang.String description

APPLICATION

public static final java.lang.String APPLICATION

See Also:

Constant Field Values

Constructor Detail

Function

public Function()

Method Detail

getTokenSelectionCriteria

public java.util.Map<java.lang.String,java.lang.String> getTokenSelectionCriteria()

setTokenSelectionCriteria

public void setTokenSelectionCriteria(java.util.Map<java.lang.String,java.lang.String> tokenSelectionCriteria)

Defines additional selection criteria of agent token on which the function should be executed

Parameters:

tokenSelectionCriteria - a map containing the additional selection criteria as key-value pairs

isExecuteLocally

public boolean isExecuteLocally()

Returns:

if the function has to be executed on a local token

setExecuteLocally

public void setExecuteLocally(boolean executeLocally)

Defines if the function has to be executed on a local token

Parameters:

executeLocally - true if the function has to be executed on a local token

getCallTimeout

public DynamicValue<java.lang.Integer> getCallTimeout()

setCallTimeout

public void setCallTimeout(DynamicValue<java.lang.Integer> callTimeout)

Parameters:

callTimeout - the call timeout of the function in ms

getSchema

public javax.json.JsonObject getSchema()

setSchema

public void setSchema(javax.json.JsonObject schema)

Sets the JSON schema to be used to validate the function's input at execution time

Parameters:

schema - the JSON schema of the function. See https://json-schema.org/ for more details concerning JSON schema.

requiresLocalExecution

public boolean requiresLocalExecution()

isManaged

public boolean isManaged()

setManaged

public void setManaged(boolean managed)

isUseCustomTemplate

public boolean isUseCustomTemplate()

setUseCustomTemplate

public void setUseCustomTemplate(boolean customTemplate)

getHtmlTemplate

public java.lang.String getHtmlTemplate()

setHtmlTemplate

public void setHtmlTemplate(java.lang.String customTemplateContent)

Sets the HTML code to be used as template when editing the function in the plan editor

Parameters:

customTemplateContent - the HTML template

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)