Apache JMeter

org.apache.jmeter.functions
Class Property2

java.lang.Object
  extended by org.apache.jmeter.functions.AbstractFunction
      extended by org.apache.jmeter.functions.Property2
All Implemented Interfaces:
Function

public class Property2
extends AbstractFunction

Function to get a JMeter property, or a default. Does not offer the option to store the value, as it is just as easy to refetch it. This is a specialisation of the __property() function to make it simpler to use for ThreadGroup GUI etc. The name is also shorter. Parameters: - property name - default value (optional; defaults to "1") Usage: Define the property in jmeter.properties, or on the command-line: java ... -Jpropname=value Retrieve the value in the appropriate GUI by using the string: ${__P(propname)} $(__P(propname,default)} Returns: - the property value, but if not found - the default value, but if not present - "1" (suitable for use in ThreadGroup GUI)

Since:
2.0

Constructor Summary
Property2()
           
 
Method Summary
 String execute(SampleResult previousResult, Sampler currentSampler)
           N.B. execute() should be synchronized if function is operating with non-thread-safe objects (e.g. operates with files).
 List<String> getArgumentDesc()
          Return a list of strings briefly describing each parameter your function takes.
 String getReferenceKey()
          Return the name of your function.
 void setParameters(Collection<CompoundVariable> parameters)
          Note: This is always called even if no parameters are provided (versions of JMeter after 2.3.1)
 
Methods inherited from class org.apache.jmeter.functions.AbstractFunction
checkMinParameterCount, checkParameterCount, checkParameterCount, execute, getVariables
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Property2

public Property2()
Method Detail

execute

public String execute(SampleResult previousResult,
                      Sampler currentSampler)
               throws InvalidVariableException

N.B. execute() should be synchronized if function is operating with non-thread-safe objects (e.g. operates with files).

JMeter ensures setParameters() happens-before execute(): setParameters is executed in main thread, and worker threads are started after that.

Specified by:
execute in interface Function
Specified by:
execute in class AbstractFunction
Parameters:
previousResult - The previous SampleResult
currentSampler - The current Sampler
Returns:
The replacement value, which was generated by the function
Throws:
InvalidVariableException - - when the variables for the function call can't be evaluated
See Also:
Function.execute(SampleResult, Sampler)

setParameters

public void setParameters(Collection<CompoundVariable> parameters)
                   throws InvalidVariableException
Note: This is always called even if no parameters are provided (versions of JMeter after 2.3.1)

Specified by:
setParameters in interface Function
Specified by:
setParameters in class AbstractFunction
Parameters:
parameters - The parameters for the function call
Throws:
InvalidVariableException - - when the variables for the function call can't be evaluated
See Also:
Function.setParameters(Collection)

getReferenceKey

public String getReferenceKey()
Return the name of your function. Convention is to prepend "__" to the name (ie "__regexFunction")

Specified by:
getReferenceKey in interface Function
Specified by:
getReferenceKey in class AbstractFunction
Returns:
The name of the funtion
See Also:
Function.getReferenceKey()

getArgumentDesc

public List<String> getArgumentDesc()
Return a list of strings briefly describing each parameter your function takes. Please use JMeterUtils.getResString(resource_name) to grab a resource string. Otherwise, your help text will be difficult to internationalize. This list is not optional. If you don't wish to write help, you must at least return a List containing the correct number of blank strings, one for each argument.

Returns:
List with brief descriptions for each parameter the function takes

Apache JMeter

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