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.
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.-
Interface Summary Interface Description Function Methods that a function must implement -
Class Summary Class Description AbstractFunction Provides common methods for all functionsBeanShell A function which understands BeanShellCharFunction Function to generate chars from a list of decimal or hex valuesCSVRead The function represented by this class allows data to be read from CSV files.EscapeHtml Function which escapes the characters in aString
using HTML entities.EscapeOroRegexpChars Escape ORO meta charactersEvalFunction 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 numberFileToString 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 JEXL2JexlFunction A function which understands Commons JEXLLogFunction 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 IPMachineName Return Machine HostProperty 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 itselfProperty2 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 variablesSamplerName 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 variablesStringFromFile StringFromFile Function to read a String from a text file.TestPlanName Returns Test Plan nameThreadNumber Function to return the current thread number.TimeFunction __time() function - returns the current time in millisecondsUnEscape 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 4Variable Function to get a JMeter Variable Parameters: - variable name Returns: - the variable value, but if not found - the variable name itselfXPath 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 -
Exception Summary Exception Description InvalidVariableException