Author: sebb
Date: Mon Mar 19 16:26:15 2012
New Revision: 1302528
URL: http://svn.apache.org/viewvc?rev=1302528&view=rev
Log:
Add docs for JMeterVariables and JMeterProperties
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=1302528&r1=1302527&r2=1302528&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/component_reference.xml (original)
+++ jmeter/trunk/xdocs/usermanual/component_reference.xml Mon Mar 19 16:26:15
2012
@@ -1035,8 +1035,8 @@ If a script file is supplied, that will
<li>ResponseMessage = "OK"</li>
<li>IsSuccess = true</li>
<li>ctx - JMeterContext</li>
- <li>vars - JMeterVariables - e.g. vars.get("VAR1");
vars.put("VAR2","value"); vars.remove("VAR3"); vars.putObject("OBJ1",new
Object());</li>
- <li>props - JMeterProperties - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+ <li>vars - <a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>
- e.g. vars.get("VAR1"); vars.put("VAR2","value"); vars.remove("VAR3");
vars.putObject("OBJ1",new Object());</li>
+ <li>props - JMeterProperties (class java.util.Properties)- e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
</ul>
<p>When the script completes, control is returned to the
Sampler, and it copies the contents
of the following script variables into the
corresponding variables in the SampleResult:</p>
@@ -1120,8 +1120,8 @@ Note that these are BSF variables - i.e.
<li>SampleResult - pointer to the current SampleResult</li>
<li>sampler - pointer to current Sampler</li>
<li>ctx - JMeterContext</li>
-<li>vars - JMeterVariables - e.g. vars.get("VAR1"); vars.put("VAR2","value");
vars.remove("VAR3"); vars.putObject("OBJ1",new Object());</li>
-<li>props - JMeterProperties - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - <a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>
- e.g. vars.get("VAR1"); vars.put("VAR2","value"); vars.remove("VAR3");
vars.putObject("OBJ1",new Object());</li>
+<li>props - JMeterProperties (class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
</ul>
<p>
@@ -2722,8 +2722,8 @@ See the file BeanShellListeners.bshrc fo
<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 - (JMeterProperties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - (<a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val);
vars.putObject("OBJ1",new Object());</li>
+<li>props - (JMeterProperties - class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>sampleResult, prev - (SampleResult) - gives access to the previous
SampleResult</li>
<li>sampleEvent (SampleEvent) gives access to the current sample event</li>
</ul>
@@ -2848,8 +2848,8 @@ Note that these are BSF variables - i.e.
<li>Parameters - the parameters (as a String)</li>
<li>args[] - the parameters as a String array (split on whitespace)</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());
vars.getObject("OBJ2");</li>
-<li>props - (JMeterProperties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - (<a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val);
vars.putObject("OBJ1",new Object()); vars.getObject("OBJ2");</li>
+<li>props - (JMeterProperties - class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>sampleResult, prev - (SampleResult) - gives access to the SampleResult</li>
<li>sampleEvent - (SampleEvent) - gives access to the SampleEvent</li>
<li>sampler - (Sampler)- gives access to the last sampler</li>
@@ -3858,8 +3858,8 @@ These are strings unless otherwise noted
<li>SampleLabel</li>
<li>SamplerData - data that was sent to the server</li>
<li>ctx - JMeterContext</li>
- <li>vars - JMeterVariables - e.g. vars.get("VAR1");
vars.put("VAR2","value"); vars.putObject("OBJ1",new Object());</li>
- <li>props - JMeterProperties - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+ <li>vars - <a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>
- e.g. vars.get("VAR1"); vars.put("VAR2","value"); vars.putObject("OBJ1",new
Object());</li>
+ <li>props - JMeterProperties (class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
</ul>
</p>
<p>The following methods of the Response object may be useful:
@@ -3974,8 +3974,8 @@ The script (or file) is processed using
<li>Parameters - the parameters (as a String)</li>
<li>args[] - the parameters as a String array (split on whitespace)</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());
vars.getObject("OBJ2");</li>
-<li>props - (JMeterProperties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - (<a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val);
vars.putObject("OBJ1",new Object()); vars.getObject("OBJ2");</li>
+<li>props - (JMeterProperties - class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>SampleResult, prev - (SampleResult) - gives access to the previous
SampleResult (if any)</li>
<li>sampler - (Sampler)- gives access to the current sampler</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
@@ -4206,8 +4206,8 @@ See the file BeanShellListeners.bshrc fo
<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 - (JMeterProperties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - (<a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val);
vars.putObject("OBJ1",new Object());</li>
+<li>props - (JMeterProperties - class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>prev - (SampleResult) - gives access to the previous SampleResult (if
any)</li>
</ul>
<p>For details of all the methods available on each of the above variables,
please check the Javadoc</p>
@@ -4245,8 +4245,8 @@ The BSF Timer can be used to generate a
<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 - (JMeterProperties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - (<a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val);
vars.putObject("OBJ1",new Object());</li>
+<li>props - (JMeterProperties - class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>sampler - the current Sampler</li>
<li>Label - the name of the Timer</li>
<li>Filename - the file name (if any)</li>
@@ -4459,8 +4459,8 @@ See the file BeanShellListeners.bshrc fo
<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 - (JMeterProperties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - (<a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val);
vars.putObject("OBJ1",new Object());</li>
+<li>props - (JMeterProperties - class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>prev - (SampleResult) - gives access to the previous SampleResult (if
any)</li>
<li>sampler - (Sampler)- gives access to the current sampler</li>
</ul>
@@ -4497,8 +4497,8 @@ The script (or file) is processed using
<li>Parameters - the parameters (as a String)</li>
<li>args[] - the parameters as a String array (split on whitespace)</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());
vars.getObject("OBJ2");</li>
-<li>props - (JMeterProperties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - (<a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val);
vars.putObject("OBJ1",new Object()); vars.getObject("OBJ2");</li>
+<li>props - (JMeterProperties - class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>sampler - (Sampler)- gives access to the current sampler</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
</ul>
@@ -4803,8 +4803,8 @@ See the file BeanShellListeners.bshrc fo
<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 - (JMeterProperties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - (<a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val);
vars.putObject("OBJ1",new Object());</li>
+<li>props - (JMeterProperties - class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>prev - (SampleResult) - gives access to the previous SampleResult</li>
<li>data - (byte [])- gives access to the current sample data</li>
</ul>
@@ -4844,8 +4844,8 @@ Note that these are BSF variables - i.e.
<li>Parameters - the parameters (as a String)</li>
<li>args[] - the parameters as a String array (split on whitespace)</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());
vars.getObject("OBJ2");</li>
-<li>props - (JMeterProperties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
+<li>vars - (<a
href="../../docs/api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val);
vars.putObject("OBJ1",new Object()); vars.getObject("OBJ2");</li>
+<li>props - (JMeterProperties - class java.util.Properties) - e.g.
props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>prev - (SampleResult) - gives access to the previous SampleResult (if
any)</li>
<li>sampler - (Sampler)- gives access to the current sampler</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
