Apache JMeter
2.1.1

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  
 

Class Summary
AbstractFunction  
BeanShell A function which understands BeanShell
CSVRead The function represented by this class allows data to be read from CSV files.
FileRowColContainer File data container for CSV (and similar delimited) files Data is accessible via row and column number
FileRowColContainer.Test  
FileWrapper This class wraps the FileRowColContainer for use across multiple threads.
IntSum Provides an intSum function that adds two or more integer values.
IterationCounter  
JavaScript  
LogFunction Function to log a message Parameters: - string - log level (optional; defaults to INFO; or DEBUG if unrecognised) - throwable message (optional) Returns: - the input string
LogFunction2 Function to log a message Parameters: - string - log level (optional; defaults to INFO; or DEBUG if unrecognised) - throwable message (optional) Returns: - Empty String (so can be used where return value would be a nuisance)
MachineName  
PackageTest  
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 define - the property name itself
Property2 Function to get a JMeter property, or a default.
Random Provides a Random function which returns a random integer between a min (first argument) and a max (seceond argument).
RegexFunction  
RegexFunction.Test  
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)} Returns: nothing
SplitFunction Function to log a message Parameters: - string - log level (optional; defaults to INFO; or DEBUG if unrecognised) - throwable message (optional) Returns: - the input string
StringFromFile StringFromFile Function to read a String from a text file.
ThreadNumber  
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
XPathFileContainer.Test  
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
2.1.1

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