Class JavaSampler
- All Implemented Interfaces:
Serializable,Cloneable,ConfigMergabilityIndicator,Searchable,Interruptible,Sampler,org.apache.jmeter.testelement.TestElement,TestStateListener
JavaSamplerClient and AbstractJavaSamplerClient for
information on writing Java code to be executed by this sampler.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.jmeter.testelement.TestElement
org.apache.jmeter.testelement.TestElement.Companion -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringProperty key representing the arguments for the JavaSamplerClient.static final StringProperty key representing the classname of the JavaSamplerClient to user.Fields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanapplies(ConfigTestElement configElement) Does configElement apply to Samplerclone()Get the arguments (parameters) for the JavaSamplerClient to be executed with.Gets the Classname attribute of the JavaConfig objectbooleanInterrupt the current operation if possible.Performs a test sample.voidsetArguments(Arguments args) Set the arguments (parameters) for the JavaSamplerClient to be executed with.voidsetClassname(String classname) Sets the Classname attribute of the JavaConfig objectvoidMethod called at the end of the test.voidCalled once for all threads after the end of a test.voidCalled just before the start of the test from the main engine thread.voidtestStarted(String host) Called just before the start of the test from the main engine thread.Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traversePropertyMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.jmeter.testelement.TestElement
addTestElement, canRemove, clear, clearTestElementChildren, get, get, get, get, get, get, get, get, get, getComment, getName, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, getPropertyOrNull, getProps, getSchema, getString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removed, removeProperty, removeProperty, set, set, set, set, set, set, set, set, set, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse
-
Field Details
-
CLASSNAME
Property key representing the classname of the JavaSamplerClient to user.- See Also:
-
ARGUMENTS
Property key representing the arguments for the JavaSamplerClient.- See Also:
-
-
Constructor Details
-
JavaSampler
public JavaSampler()Create a JavaSampler.
-
-
Method Details
-
clone
- Specified by:
clonein interfaceorg.apache.jmeter.testelement.TestElement- Overrides:
clonein classAbstractTestElement
-
setArguments
Set the arguments (parameters) for the JavaSamplerClient to be executed with.- Parameters:
args- the new arguments. These replace any existing arguments.
-
getArguments
Get the arguments (parameters) for the JavaSamplerClient to be executed with.- Returns:
- the arguments
-
setClassname
Sets the Classname attribute of the JavaConfig object- Parameters:
classname- the new Classname value
-
getClassname
Gets the Classname attribute of the JavaConfig object- Returns:
- the Classname value
-
sample
Performs a test sample. Thesample()method retrieves the reference to the Java client and calls itsrunTest()method. -
testStarted
public void testStarted()Description copied from interface:TestStateListenerCalled just before the start of the test from the main engine thread. This is before the test elements are cloned. Note that not all the test variables will have been set up at this point.
N.B. testStarted() and testEnded() are called from different threads.
- Specified by:
testStartedin interfaceTestStateListener- See Also:
-
testStarted
Description copied from interface:TestStateListenerCalled just before the start of the test from the main engine thread. This is before the test elements are cloned. Note that not all the test variables will have been set up at this point.
N.B. testStarted() and testEnded() are called from different threads.
- Specified by:
testStartedin interfaceTestStateListener- Parameters:
host- name of host- See Also:
-
testEnded
public void testEnded()Method called at the end of the test. This is called only on one instance of JavaSampler. This method will loop through all of the other JavaSamplers which have been registered (automatically in the constructor) and notify them that the test has ended, allowing the JavaSamplerClients to cleanup.- Specified by:
testEndedin interfaceTestStateListener- See Also:
-
testEnded
Description copied from interface:TestStateListenerCalled once for all threads after the end of a test. This will use the same element instances as at the start of the test.
N.B. testStarted() and testEnded() are called from different threads.
- Specified by:
testEndedin interfaceTestStateListener- Parameters:
host- name of host- See Also:
-
applies
Description copied from class:AbstractSamplerDoes configElement apply to Sampler- Specified by:
appliesin interfaceConfigMergabilityIndicator- Overrides:
appliesin classAbstractSampler- Parameters:
configElement-ConfigTestElement- Returns:
- boolean
- See Also:
-
interrupt
public boolean interrupt()Description copied from interface:InterruptibleInterrupt the current operation if possible.- Specified by:
interruptin interfaceInterruptible- Returns:
trueif there was an operation to interrupt.
-