org.apache.jmeter.protocol.java.sampler

Class JavaSampler

Implemented Interfaces:
Cloneable, Sampler, Serializable, TestElement, TestListener

public class JavaSampler
extends AbstractSampler
implements TestListener

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.

Field Summary

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

JavaSampler()
Create a JavaSampler.

Method Summary

Arguments
getArguments()
Get the arguments (parameters) for the JavaSamplerClient to be executed with.
String
getClassname()
Gets the Classname attribute of the JavaConfig object
SampleResult
sample(Entry entry)
Performs a test sample.
void
setArguments(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
testIterationStart(LoopIterationEvent event)
void
testStarted()
void
testStarted(String host)

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

addProperty, addTestElement, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty

Field Details

ARGUMENTS

public static final String ARGUMENTS
Property key representing the arguments for the JavaSamplerClient.

CLASSNAME

public static final String CLASSNAME
Property key representing the classname of the JavaSamplerClient to user.

Constructor Details

JavaSampler

public JavaSampler()
Create a JavaSampler.

Method Details

getArguments

public Arguments getArguments()
Get the arguments (parameters) for the JavaSamplerClient to be executed with.
Returns:
the arguments

getClassname

public String getClassname()
Gets the Classname attribute of the JavaConfig object
Returns:
the Classname value

sample

public SampleResult sample(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 Sampler
Parameters:
entry - the Entry for this sample
Returns:
test SampleResult

setArguments

public void setArguments(Arguments args)
Set the arguments (parameters) for the JavaSamplerClient to be executed with.
Parameters:
args - the new arguments. These replace any existing arguments.

setClassname

public void setClassname(String classname)
Sets the Classname attribute of the JavaConfig object
Parameters:
classname - the new Classname value

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 TestListener

testEnded

public void testEnded(String host)
Specified by:
testEnded in interface TestListener

testIterationStart

public void testIterationStart(LoopIterationEvent event)
Specified by:
testIterationStart in interface TestListener

testStarted

public void testStarted()
Specified by:
testStarted in interface TestListener

testStarted

public void testStarted(String host)
Specified by:
testStarted in interface TestListener

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