Apache JMeter

## Package org.apache.jmeter.functions

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

See:
Description

Interface Summary
Function: Methods that a function must implement

Class Summary
AbstractFunction: Provides common methods for all functions
BeanShell: A function which understands BeanShell
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.
EscapeHtml: Function which escapes the characters in a `String` using HTML 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.
IntSum: Provides an intSum function that adds two or more integer values.
IterationCounter: Counter that can be referenced anywhere in the Thread Group.
JavaScript: javaScript function implementation that executes a piece of JavaScript (not Java!)
Jexl2Function: A function which understands Commons JEXL2
JexlFunction: A function which understands Commons JEXL
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).
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?])}
SplitFunction: Function to split a string into variables Parameters: String to split Variable name prefix String to split on (optional, default is comma) Returns: the input string Also sets the variables: VARNAME - the input string VARNAME_n - number of fields found VARNAME_1..n - fields
StringFromFile: StringFromFile Function to read a String from a text file.
TestPlanName: Returns Test Plan name
ThreadNumber: Function to return the current thread number.
TimeFunction: __time() function - returns the current time in milliseconds
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.
Variable: Function to get a JMeter Variable Parameters: - variable name Returns: - the variable value, but if not found - 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
XPathWrapper: This class wraps the XPathFileContainer for use across multiple threads.

Exception Summary
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.

Apache JMeter

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