You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by se...@apache.org on 2012/09/03 12:47:50 UTC

svn commit: r1380195 - /jmeter/trunk/xdocs/usermanual/component_reference.xml

Author: sebb
Date: Mon Sep  3 10:47:50 2012
New Revision: 1380195

URL: http://svn.apache.org/viewvc?rev=1380195&view=rev
Log:
Add more Java sampler docs

Modified:
    jmeter/trunk/xdocs/usermanual/component_reference.xml

Modified: jmeter/trunk/xdocs/usermanual/component_reference.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/usermanual/component_reference.xml?rev=1380195&r1=1380194&r2=1380195&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/component_reference.xml (original)
+++ jmeter/trunk/xdocs/usermanual/component_reference.xml Mon Sep  3 10:47:50 2012
@@ -566,28 +566,44 @@ The fields allow variables to be used, s
 </p>
 </description>
 
-<note>Since JMeter 2.8, if method teardownTest is not overriden by subclasses of AbstractJavaSamplerClient, then the method will not be called to optimise JMeter memory behaviour.
+<note>Since JMeter 2.8, if the method teardownTest is not overriden by a subclass of AbstractJavaSamplerClient, its teardownTest method will not be called.
+This reduces JMeter memory requirements.
 This will not have any impact on existing Test plans.
 </note>
 <note>The Add/Delete buttons don't serve any purpose at present.</note>
 
-<properties>
+    <properties>
         <property name="Name" required="No">Descriptive name for this sampler
          that is shown in the tree.</property>
         <property name="Classname" required="Yes">The specific implementation of
         the JavaSamplerClient interface to be sampled.</property>
         <property name="Send Parameters with Request" required="No">A list of
         arguments that will be passed to the sampled class.  All arguments
-        are sent as Strings.</property>
-        </properties>
+        are sent as Strings. See below for specific settings.</property>
+    </properties>
+
+    <p>The following parameters apply to the <b>SleepTest</b> and <b>JavaTest</b> implementations:</p>
+
+    <properties>
+        <property name="Sleep_time" required="Yes">How long to sleep for (ms)</property>
+        <property name="Sleep_mask" required="Yes">How much "randomness" to add:<br></br>
+            The sleep time is calculated as follows:<br></br>
+            totalSleepTime = SleepTime + (System.currentTimeMillis() % SleepMask)
+        </property>
+    </properties>
+
+    <p>The following parameters apply additionaly to the <b>JavaTest</b> implementation:</p>
+
+    <properties>
+        <property name="Label" required="No">The label to use. If provided, overrides Name</property>
+        <property name="ResponseCode" required="No">If provided, sets the SampleResult ResponseCode.</property>
+        <property name="ResponseMessage" required="No">If provided, sets the SampleResult ResponseMessage.</property>
+        <property name="Status" required="No">If provided, sets the SampleResult Status. If this equals "OK" (ignoring case) then the status is set to success, otherwise the sample is marked as failed.</property>
+        <property name="SamplerData" required="No">If provided, sets the SampleResult SamplerData.</property>
+        <property name="ResultData" required="No">If provided, sets the SampleResult ResultData.</property>
+    </properties>
 </component>
 
-<p>The sleep time is calculated as follows:</p>
-<pre>
-SleepTime is in milliseconds
-SleepMask is used to add a "random" element to the time:
-totalSleepTime = SleepTime + (System.currentTimeMillis() % SleepMask)
-</pre>
 <component name="SOAP/XML-RPC Request" index="&sect-num;.1.5"  width="426" height="276" screenshot="soap_sampler.png">
 
 <description><p>This sampler lets you send a SOAP request to a webservice.  It can also be