__BeanShell

Also documented in context in the full Functions and Variables reference.

The BeanShell function evaluates the script passed to it, and returns the result.

Note

For performance it is better to use __groovy function

For full details on using BeanShell, please see the BeanShell web-site at http://www.beanshell.org/

Note

Note that a different Interpreter is used for each independent occurrence of the function in a test script, but the same Interpreter is used for subsequent invocations. This means that variables persist across calls to the function.

A single instance of a function may be called from multiple threads. However the function execute() method is synchronised.

If the property “beanshell.function.init” is defined, it is passed to the Interpreter as the name of a sourced file. This can be used to define common methods and variables. There is a sample init file in the bin directory: BeanShellFunction.bshrc.

The following variables are set before the script is executed:

• log - the Logger for the BeanShell function (*)
• ctx - JMeterContext object
• vars - JMeterVariables object
• props - JMeterProperties (class java.util.Properties) object
• threadName - the threadName (String)
• Sampler - the current Sampler, if any
• SampleResult - the current SampleResult, if any

(*) means that this is set before the init file, if any, is processed. Other variables vary from invocation to invocation.

Name	Required	Description
BeanShell script	Yes	A beanshell script (not a file name)
Name of variable	No	A reference name for reusing the value computed by this function.

Example:

\$\{__BeanShell(123*456)\} : returns 56088

\$\{__BeanShell(source("function.bsh"))\} : processes the script in function.bsh

Note

Remember to include any necessary quotes for text strings and JMeter variables that represent text strings.

Related

• Functions and Variables Guide
• Regex Extractor Builder
• Full Functions Reference
• Component Reference