org.apache.jmeter.protocol.java.sampler

Class JavaSampler

java.lang.Object

org.apache.jmeter.testelement.AbstractTestElement

org.apache.jmeter.samplers.AbstractSampler

org.apache.jmeter.protocol.java.sampler.JavaSampler

All Implemented Interfaces:

Serializable, Cloneable, org.apache.jmeter.engine.util.ConfigMergabilityIndicator, org.apache.jmeter.gui.Searchable, org.apache.jmeter.samplers.Interruptible, org.apache.jmeter.samplers.Sampler, org.apache.jmeter.testelement.TestElement, org.apache.jmeter.testelement.TestStateListener

public class JavaSampler
extends org.apache.jmeter.samplers.AbstractSampler
implements org.apache.jmeter.testelement.TestStateListener, org.apache.jmeter.samplers.Interruptible

A sampler for executing custom Java code in each sample. See JavaSamplerClient and AbstractJavaSamplerClient for information on writing Java code to be executed by this sampler.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARGUMENTS Property key representing the arguments for the JavaSamplerClient.
static String	CLASSNAME Property key representing the classname of the JavaSamplerClient to user.

Fields inherited from interface org.apache.jmeter.testelement.TestElement

COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS

Constructor Summary

Constructors

Constructor and Description
JavaSampler() Create a JavaSampler.

Method Summary

Modifier and Type	Method and Description
boolean	applies(org.apache.jmeter.config.ConfigTestElement configElement)
Object	clone()
org.apache.jmeter.config.Arguments	getArguments() Get the arguments (parameters) for the JavaSamplerClient to be executed with.
String	getClassname() Gets the Classname attribute of the JavaConfig object
boolean	interrupt()
org.apache.jmeter.samplers.SampleResult	sample(org.apache.jmeter.samplers.Entry entry) Performs a test sample.
void	setArguments(org.apache.jmeter.config.Arguments args) Set the arguments (parameters) for the JavaSamplerClient to be executed with.
void	setClassname(String classname) Sets the Classname attribute of the JavaConfig object
void	testEnded() Method called at the end of the test.
void	testEnded(String host)
void	testStarted()
void	testStarted(String host)

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, 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, traverseProperty

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jmeter.testelement.TestElement

addTestElement, canRemove, clear, clearTestElementChildren, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removed, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse

Field Detail

CLASSNAME

public static final String CLASSNAME

Property key representing the classname of the JavaSamplerClient to user.

See Also:

Constant Field Values

ARGUMENTS

public static final String ARGUMENTS

Property key representing the arguments for the JavaSamplerClient.

See Also:

Constant Field Values

Constructor Detail

JavaSampler

public JavaSampler()

Create a JavaSampler.

Method Detail

clone

public Object clone()

Specified by:

clone in interface org.apache.jmeter.testelement.TestElement

Overrides:

clone in class org.apache.jmeter.testelement.AbstractTestElement

setArguments

public void setArguments(org.apache.jmeter.config.Arguments args)

Set the arguments (parameters) for the JavaSamplerClient to be executed with.

Parameters:

args - the new arguments. These replace any existing arguments.

getArguments

public org.apache.jmeter.config.Arguments getArguments()

Get the arguments (parameters) for the JavaSamplerClient to be executed with.

Returns:

the arguments

setClassname

public void setClassname(String classname)

Sets the Classname attribute of the JavaConfig object

Parameters:

classname - the new Classname value

getClassname

public String getClassname()

Gets the Classname attribute of the JavaConfig object

Returns:

the Classname value

sample

public org.apache.jmeter.samplers.SampleResult sample(org.apache.jmeter.samplers.Entry entry)

Performs a test sample. The sample() method retrieves the reference to the Java client and calls its runTest() method.

Specified by:

sample in interface org.apache.jmeter.samplers.Sampler

Parameters:

entry - the Entry for this sample

Returns:

test SampleResult

See Also:

JavaSamplerClient.runTest(JavaSamplerContext)

testStarted

public void testStarted()

Specified by:

testStarted in interface org.apache.jmeter.testelement.TestStateListener

testStarted

public void testStarted(String host)

Specified by:

testStarted in interface org.apache.jmeter.testelement.TestStateListener

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:

testEnded in interface org.apache.jmeter.testelement.TestStateListener

testEnded

public void testEnded(String host)

Specified by:

testEnded in interface org.apache.jmeter.testelement.TestStateListener

applies

public boolean applies(org.apache.jmeter.config.ConfigTestElement configElement)

Specified by:

applies in interface org.apache.jmeter.engine.util.ConfigMergabilityIndicator

Overrides:

applies in class org.apache.jmeter.samplers.AbstractSampler

See Also:

AbstractSampler.applies(org.apache.jmeter.config.ConfigTestElement)

interrupt

public boolean interrupt()

Specified by:

interrupt in interface org.apache.jmeter.samplers.Interruptible