Class SleepTest
- java.lang.Object
-
- org.apache.jmeter.protocol.java.sampler.AbstractJavaSamplerClient
-
- org.apache.jmeter.protocol.java.test.SleepTest
-
- All Implemented Interfaces:
Serializable
,JavaSamplerClient
public class SleepTest extends AbstractJavaSamplerClient implements Serializable
TheSleepTest
class is a simple example class for a JMeter Java protocol client. The class implements theJavaSamplerClient
interface.During each sample, this client will sleep for some amount of time. The amount of time to sleep is determined from the two parameters SleepTime and SleepMask using the formula:
totalSleepTime = SleepTime + (System.currentTimeMillis() % SleepMask)
Thus, the SleepMask provides a way to add a random component to the sleep time.- Version:
- $Revision: 1516231 $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static long
DEFAULT_SLEEP_MASK
The default value of the SleepMask parameter.static long
DEFAULT_SLEEP_TIME
The default value of the SleepTime parameter, in milliseconds.
-
Constructor Summary
Constructors Constructor Description SleepTest()
Default constructor forSleepTest
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Arguments
getDefaultParameters()
Provide a list of parameters which this test supports.SampleResult
runTest(JavaSamplerContext context)
Perform a single sample.void
setupTest(JavaSamplerContext context)
Do any initialization required by this client.-
Methods inherited from class org.apache.jmeter.protocol.java.sampler.AbstractJavaSamplerClient
getLogger, teardownTest
-
-
-
-
Field Detail
-
DEFAULT_SLEEP_TIME
public static final long DEFAULT_SLEEP_TIME
The default value of the SleepTime parameter, in milliseconds.- See Also:
- Constant Field Values
-
DEFAULT_SLEEP_MASK
public static final long DEFAULT_SLEEP_MASK
The default value of the SleepMask parameter.- See Also:
- Constant Field Values
-
-
Method Detail
-
setupTest
public void setupTest(JavaSamplerContext context)
Do any initialization required by this client. In this case, initialization consists of getting the values of the SleepTime and SleepMask parameters. It is generally recommended to do any initialization such as getting parameter values in the setupTest method rather than the runTest method in order to add as little overhead as possible to the test.- Specified by:
setupTest
in interfaceJavaSamplerClient
- Overrides:
setupTest
in classAbstractJavaSamplerClient
- Parameters:
context
- the context to run with. This provides access to initialization parameters.
-
runTest
public SampleResult runTest(JavaSamplerContext context)
Perform a single sample. In this case, this method will simply sleep for some amount of time. Perform a single sample for each iteration. This method returns aSampleResult
object.SampleResult
has many fields which can be used. At a minimum, the test should useSampleResult.sampleStart
andSampleResult.sampleEnd
to set the time that the test required to execute. It is also a good idea to set the sampleLabel and the successful flag.- Specified by:
runTest
in interfaceJavaSamplerClient
- Parameters:
context
- the context to run with. This provides access to initialization parameters.- Returns:
- a SampleResult giving the results of this sample.
- See Also:
SampleResult.sampleStart()
,SampleResult.sampleEnd()
,SampleResult.setSuccessful(boolean)
,SampleResult.setSampleLabel(String)
-
getDefaultParameters
public Arguments getDefaultParameters()
Provide a list of parameters which this test supports. Any parameter names and associated values returned by this method will appear in the GUI by default so the user doesn't have to remember the exact names. The user can add other parameters which are not listed here. If this method returns null then no parameters will be listed. If the value for some parameter is null then that parameter will be listed in the GUI with an empty value.- Specified by:
getDefaultParameters
in interfaceJavaSamplerClient
- Overrides:
getDefaultParameters
in classAbstractJavaSamplerClient
- Returns:
- a specification of the parameters used by this test which should be listed in the GUI, or null if no parameters should be listed.
-
-