# Package org.apache.jmeter.functions

Functions

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  Function | Methods that a function must implement

- Class Summary
  Class | Description
  --- | ---
  AbstractFunction | Provides common methods for all functions
  BeanShell | A function which understands BeanShell
  ChangeCase | Change Case Function Support String manipulations of: upper case lower case capitalize
  CharFunction | Function to generate chars from a list of decimal or hex values
  CSVRead | The function represented by this class allows data to be read from CSV files.
  DateTimeConvertFunction | DateConvert function to change date format Can optionally store it in a variable.
  DigestEncodeFunction | Digest Encode Function that provides computing of different SHA-XXX, can uppercase the result and store it in a variable.
  EscapeHtml | Function which escapes the characters in a `String` using HTML entities.
  EscapeOroRegexpChars | Escape ORO meta characters
  EscapeXml | Function which escapes the characters in a `String` using XML 1.0 entities.
  EvalFunction | Function to evaluate a string which may contain variable or function references.
  EvalVarFunction | Function to evaluate a string which may contain variable or function references.
  FileRowColContainer | File data container for CSV (and similar delimited) files Data is accessible via row and column number
  FileToString | FileToString Function to read a complete file into a String.
  FileWrapper | This class wraps the FileRowColContainer for use across multiple threads.
  Groovy | __groovy function Provides a Groovy interpreter
  IntSum | Provides an intSum function that adds two or more integer values.
  IsPropDefined | Test if a JMeter property is defined
  IsVarDefined | Test if a JMeter variable is defined
  IterationCounter | Counter that can be referenced anywhere in the Thread Group.
  JavaScript | javaScript function implementation that executes a piece of JavaScript (not Java!) code and returns its value
  Jexl2Function | A function which understands Commons JEXL2
  Jexl3Function | A function which understands Commons JEXL3
  LogFunction | Function to log a message.
  LogFunction2 | Function to log a message.
  LongSum | Provides a longSum function that adds two or more long values.
  MachineIP | Return Machine IP
  MachineName | Return Machine Host
  Property | Function to get a JMeter property, and optionally store it Parameters: - property name - variable name (optional) - default value (optional) Returns: - the property value, but if not found: - the default value, but if not defined: - the property name itself
  Property2 | Function to get a JMeter property, or a default.
  Random | Provides a Random function which returns a random long integer between a min (first argument) and a max (second argument).
  RandomDate | RandomDate Function generates a date in a specific range Parameters: Time format @see DateTimeFormatter (optional - defaults to yyyy-MM-dd) Start date formated as first param (optional - defaults to now) End date Locale for the format (optional) variable name (optional) Returns a formatted date with the specified number of (days, month, year) Value is also saved in the variable for later re-use.
  RandomFromMultipleVars | Provides a RandomFromMultipleVars function which returns a random element from a multi valued extracted variable.
  RandomString | Provides a RandomString function which returns a random String of length (first argument) using characters (second argument)
  RegexFunction | Implements regular expression parsing of sample results and variables
  SamplerName | Function to return the name of the current sampler.
  SetProperty | Function to set a JMeter property Parameters: - property name - value Usage: Set the property value in the appropriate GUI by using the string: ${__setProperty(propname,propvalue[,returnvalue?])} Returns: nothing or original value if the 3rd parameter is true
  SplitFunction | Function to split a string into variables
  StringFromFile | StringFromFile Function to read a String from a text file.
  StringToFile | StringToFile Function to write a String to a file Parameters: file name content append (true/false)(optional) file encoding (optional) Returns: `true` if OK, `false` if an error occurred
  TestPlanName | Returns Test Plan name
  ThreadGroupName | Returns Thread Group Name
  ThreadNumber | Function to return the current thread number.
  TimeFunction | __time() function - returns the current time in milliseconds
  TimeShift | timeShifting Function permit to shift a date Parameters: - format date @see https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html (optional - defaults to epoch time in millisecond) - date to shift formatted as first param (optional - defaults now) - amount of (seconds, minutes, hours, days ) to add (optional - default nothing is add ) - a string of the locale for the format ( optional ) - variable name ( optional ) Returns: a formatted date with the specified number of (seconds, minutes, hours, days or months ) added.
  UnEscape | Function to unescape any Java literals found in the String.
  UnEscapeHtml | Function to unescape a string containing entity escapes to a string containing the actual Unicode characters corresponding to the escapes.
  UrlDecode | Function to decode a application/x-www-form-urlencoded string.
  UrlEncode | Function to encode a string to a application/x-www-form-urlencoded string.
  Uuid | Function to create a UUID Parameters: - None Returns: - A pseudo random UUID 4
  Variable | Function to get a JMeter Variable Parameters: - variable name - default value Returns: - the variable value, but if not found - the default value if set, and if not the variable name itself
  XPath | The function represented by this class allows data to be read from XML files.
  XPathFileContainer | File data container for XML files Data is accessible via XPath

- Enum Summary
  Enum | Description
  --- | ---
  ChangeCase.ChangeCaseMode | ChangeCase Modes Modes for different cases

- Exception Summary
  Exception | Description
  --- | ---
  InvalidVariableException |

## Package org.apache.jmeter.functions Description

## Functions

### Methods to be implemented

setParameters(Collection)
execute(prevResult,currentSampler) Note that either or both of the parameters may be null.

### Calling sequence

When the test plan is prepared for running, one instance of the class is created for each occurrence of a function call. The setParameters() method is then called on each instance. Once the test is running, the execute method can be called by any thread, and is therefore synchronized. This is unlike most of (all?) the JMeter test elements, which are created for each thread. Any context that needs to be maintained for a thread must be done using ThreadLocal or similar.

Copyright © 1998-2019 Apache Software Foundation. All Rights Reserved.