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 Details

    • callTimeout

      protected DynamicValue<Integer> callTimeout

    • schema

      protected jakarta.json.JsonObject schema

    • executeLocally

      protected boolean executeLocally

    • tokenSelectionCriteria

      protected Map<String,String> tokenSelectionCriteria

    • managed

      protected boolean managed

    • useCustomTemplate

      protected boolean useCustomTemplate

    • htmlTemplate

      protected String htmlTemplate

    • description

      protected String description

    • APPLICATION

      public static final String APPLICATION
      See Also:

  • Constructor Details

    • Function

      public Function()

  • Method Details

    • getTokenSelectionCriteria

      public Map<String,String> getTokenSelectionCriteria()

    • setTokenSelectionCriteria

      public void setTokenSelectionCriteria(Map<String,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<Integer> getCallTimeout()

    • setCallTimeout

      public void setCallTimeout(DynamicValue<Integer> callTimeout)
      Parameters:
      callTimeout - the call timeout of the function in ms

    • getSchema

      public jakarta.json.JsonObject getSchema()

    • setSchema

      public void setSchema(jakarta.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 String getHtmlTemplate()

    • setHtmlTemplate

      public void setHtmlTemplate(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 String getDescription()

    • setDescription

      public void setDescription(String description)