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

[sebb]

Author: sebb
Date: Sat Nov 14 17:21:34 2009
New Revision: 836220

URL: http://svn.apache.org/viewvc?rev=836220&view=rev
Log:
Add BSF Timer and JSR223 test elements

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

Modified: jakarta/jmeter/trunk/xdocs/usermanual/component_reference.xml
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/xdocs/usermanual/component_reference.xml?rev=836220&r1=836219&r2=836220&view=diff
==============================================================================
--- jakarta/jmeter/trunk/xdocs/usermanual/component_reference.xml (original)
+++ jakarta/jmeter/trunk/xdocs/usermanual/component_reference.xml Sat Nov 14 
17:21:34 2009
@@ -1019,6 +1019,15 @@
 </p>
 </component>
 
+<component name="JSR223 Sampler" index="&sect-num;.1.11.1">
+<description>
+<p>
+The JSR223 Sampler allows JSR223 script code to be used to perform a sample.
+For details, see <complink name="BSF Sampler"/>.
+</p>
+</description>
+</component>
+
 <component name="TCP Sampler" index="&sect-num;.1.12"  width="477" 
height="343" screenshot="tcpsampler.png">
        <description>
                <p>
@@ -3404,7 +3413,16 @@
 <p>For futher details of all the methods available on each of the above 
variables, please check the Javadoc</p>
 </component>
 
-<component name="Compare Assertion" index="&sect-num;.5.11"  width="292" 
height="296" screenshot="assertion/compare.png">
+<component name="JSR223 Assertion" index="&sect-num;.5.11">
+<description>
+<p>
+The JSR223 Assertion allows JSR223 script code to be used to check the status 
of the previous sample.
+For details, see <complink name="BSF Assertion"/>.
+</p>
+</description>
+</component>
+
+<component name="Compare Assertion" index="&sect-num;.5.12"  width="292" 
height="296" screenshot="assertion/compare.png">
 <description>
 The Compare Assertion can be used to compare sample results within its scope.
 Either the contents or the elapsed time can be compared, and the contents can 
be filtered before comparison.
@@ -3590,6 +3608,56 @@
 </component>
 
 
+<component name="BSF Timer" index="&sect-num;.6.7"  width="548" height="350" 
screenshot="timers/bsf_timer.png">
+<description>
+<p>
+The BSF Timer can be used to generate a delay using a BSF scripting language.
+</p>
+</description>
+<properties>
+    <property name="Name" required="No">Descriptive name for this element that 
is shown in the tree.</property>
+    <property name="ScriptLanguage" required="Yes">
+        The scripting language to be used.
+    </property>
+    <property name="Parameters" required="No">Parameters to pass to the script.
+    The parameters are stored in the following variables:
+    <ul>
+        <li>Parameters - string containing the parameters as a single 
variable</li>
+        <li>args - String array containing parameters, split on 
white-space</li>
+    </ul>
+    </property>
+    <property name="Script file" required="No">
+    A file containing the script to run.
+     The return value is converted to a long integer and used as the number of 
milliseconds to wait.
+     </property>
+    <property name="Script" required="Yes (unless script file is provided)">
+        The script. The return value is used as the number of milliseconds to 
wait.
+    </property>
+</properties>
+<p>Before invoking the script, some variables are set up in the script 
interpreter:</p>
+<ul>
+<li>log - (Logger) - can be used to write to the log file</li>
+<li>ctx - (JMeterContext) - gives access to the context</li>
+<li>vars - (JMeterVariables) - gives read/write access to variables: 
vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object());</li>
+<li>props - JMeter Properties - e.g. props.get("START.HMS"); 
props.put("PROP1","1234");</li>
+<li>prev - the previous SampleResult (if any)</li>
+<li>sampler - the current Sampler</li>
+<li>Label - the name of the Timer</li>
+<li>Filename - the file name (if any)</li>
+<li>OUT - System.out</li>
+</ul>
+<p>For details of all the methods available on each of the above variables, 
please check the Javadoc</p>
+</component>
+
+<component name="JSR223 Timer" index="&sect-num;.6.8">
+<description>
+<p>
+The JSR223 Timer can be used to generate a delay using a JSR223 scripting 
language,
+For details, see <complink name="BSF Timer"/>.
+</p>
+</description>
+</component>
+
 <a href="#">^</a>
 
 </section>
@@ -3832,6 +3900,15 @@
 <p>For details of all the methods available on each of the above variables, 
please check the Javadoc</p>
 </component>
 
+<component name="JSR223 PreProcessor" index="&sect-num;.7.8">
+<description>
+<p>
+The JSR223 PreProcessor allows JSR223 script code to be applied before taking 
a sample.
+For details, see <complink name="BSF PreProcessor"/>.
+</p>
+</description>
+</component>
+
 <a href="#">^</a>
 
 </section>
@@ -4113,6 +4190,15 @@
 <p>For details of all the methods available on each of the above variables, 
please check the Javadoc</p>
 </component>
 
+<component name="JSR223 PostProcessor" index="&sect-num;.8.6">
+<description>
+<p>
+The JSR223 PostProcessor allows JSR223 script code to be applied after taking 
a sample.
+For details, see the <complink name="BSF PostProcessor"/>.
+</p>
+</description>
+</component>
+
 <a href="#">^</a>
 
 </section>



---------------------------------------------------------------------
To unsubscribe, e-mail: jmeter-dev-unsubscr...@jakarta.apache.org
For additional commands, e-mail: jmeter-dev-h...@jakarta.apache.org