JMS Read response field is badly named and documented

Also clarified iterations field
Bugzilla Id: 58475


git-svn-id: https://svn.apache.org/repos/asf/jmeter/trunk@1706050 13f79535-47bb-0310-9956-ffa450edef68

src/core/org/apache/jmeter/resources/messages.properties

@@ -480,7 +480,6 @@ jms_queue=Queue
 jms_queue_connection_factory=QueueConnection Factory
 jms_queueing=JMS Resources
 jms_random_file=Random folder containing files ending with .dat for bytes messages, .txt or .obj for text and Object messages
-jms_read_response=Read Response
 jms_receive_queue=JNDI name Receive queue
 jms_request=Request Only
 jms_requestreply=Request Response
@@ -489,6 +488,7 @@ jms_selector=JMS Selector
 jms_send_queue=JNDI name Request queue
 jms_separator=Separator
 jms_stop_between_samples=Stop between samples?
+jms_store_response=Store Response
 jms_subscriber_on_message=Use MessageListener.onMessage()
 jms_subscriber_receive=Use MessageConsumer.receive()
 jms_subscriber_title=JMS Subscriber

src/core/org/apache/jmeter/resources/messages_es.properties

@@ -345,13 +345,13 @@ jms_queue=Cola
 jms_queue_connection_factory=Factor\u00EDa de QueueConnection
 jms_queueing=Recursos JMS
 jms_random_file=Archivo Aleatorio
-jms_read_response=Respuesta Le\u00EDda
 jms_receive_queue=Nombre JNDI cola Recepci\u00F3n
 jms_request=S\u00F3lo Petici\u00F3n
 jms_requestreply=Respuesta a Petici\u00F3n
 jms_sample_title=Petici\u00F3n JMS por defecto
 jms_send_queue=Nombre JNDI Cola Petici\u00F3n
 jms_stop_between_samples=\u00BFParar entre muestras?
+jms_store_response=Guarde la respuesta
 jms_subscriber_on_message=Utilizar MessageListener.onMessage()
 jms_subscriber_receive=Utilizar TopicSubscriber.receive()
 jms_subscriber_title=Suscriptor JMS

src/core/org/apache/jmeter/resources/messages_fr.properties

@@ -473,7 +473,7 @@ jms_queue=File
 jms_queue_connection_factory=Fabrique QueueConnection
 jms_queueing=Ressources JMS
 jms_random_file=Dossier contenant les fichiers al\u00E9atoires
-jms_read_response=Lire la r\u00E9ponse
+jms_store_response=Stocker la r\u00E9ponse
 jms_receive_queue=Nom JNDI de la file d'attente Receive 
 jms_request=Requ\u00EAte seule
 jms_requestreply=Requ\u00EAte R\u00E9ponse

src/core/org/apache/jmeter/resources/messages_pt_BR.properties

@@ -329,12 +329,12 @@ jms_queue=Fila
 jms_queue_connection_factory=F\u00E1brica de Conex\u00F5es em Fila
 jms_queueing=Recursos JMS
 jms_random_file=Arquivo Aleat\u00F3rio
-jms_read_response=Resposta Lida
 jms_receive_queue=Nome da Fila de Recebimento JNDI
 jms_request=Somente Requisitar
 jms_requestreply=Requisitar e Responder
 jms_sample_title=Padr\u00F5es de Requisi\u00E7\u00E3o JMS
 jms_send_queue=Fila de Requisi\u00E7\u00E3o de nomes JNDI
+jms_store_response=Armazenar a resposta
 jms_subscriber_on_message=Utilizar MessageListener.onMessage()
 jms_subscriber_receive=Usar TopicSubscriber.receive()
 jms_subscriber_title=Assinante JMS

src/core/org/apache/jmeter/resources/messages_tr.properties

@@ -313,7 +313,6 @@ jms_queue=S\u0131ra
 jms_queue_connection_factory=QueueConnection Fabrikas\u0131
 jms_queueing=JMS Kaynaklar\u0131
 jms_random_file=Rastgele Dosyas\u0131
-jms_read_response=Cevab\u0131 Oku
 jms_receive_queue=S\u0131ray\u0131 alan JNDI ismi 
 jms_request=Sadece \u0130stek
 jms_requestreply=\u0130stek Cevap

src/core/org/apache/jmeter/resources/messages_zh_TW.properties

@@ -262,7 +262,6 @@ jms_queue=\u4F47\u5217
 jms_queue_connection_factory=\u4F47\u5217\u9023\u7DDA\u5DE5\u5EE0
 jms_queueing=JMS \u8CC7\u6E90
 jms_random_file=\u96A8\u6A5F\u6A94\u6848
-jms_read_response=\u8B80\u53D6\u56DE\u8986
 jms_receive_queue=\u63A5\u6536\u4F47\u5217
 jms_request=\u55AE\u5411\u8981\u6C42
 jms_requestreply=\u8981\u6C42\u4E14\u56DE\u8986

src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSSubscriberGui.java

@@ -75,14 +75,14 @@ public class JMSSubscriberGui extends AbstractSamplerGui implements ChangeListen
     private final JLabeledTextField jmsPwd =
         new JLabeledPasswordField(JMeterUtils.getResString("jms_pwd")); // $NON-NLS-1$
 
-    private final JLabeledTextField iterations =
+    private final JLabeledTextField samplesToAggregate =
         new JLabeledTextField(JMeterUtils.getResString("jms_itertions")); // $NON-NLS-1$
 
     private final JCheckBox useAuth =
         new JCheckBox(JMeterUtils.getResString("jms_use_auth"), false); //$NON-NLS-1$
 
-    private final JCheckBox readResponse =
+    private final JCheckBox storeResponse =
-        new JCheckBox(JMeterUtils.getResString("jms_read_response"), true); // $NON-NLS-1$
+        new JCheckBox(JMeterUtils.getResString("jms_store_response"), true); // $NON-NLS-1$
 
     private final JLabeledTextField timeout = 
         new JLabeledTextField(JMeterUtils.getResString("jms_timeout")); //$NON-NLS-1$
@@ -154,8 +154,8 @@ public class JMSSubscriberGui extends AbstractSamplerGui implements ChangeListen
         sampler.setUsername(jmsUser.getText());
         sampler.setPassword(jmsPwd.getText());
         sampler.setUseAuth(useAuth.isSelected());
-        sampler.setIterations(iterations.getText());
+        sampler.setIterations(samplesToAggregate.getText());
-        sampler.setReadResponse(String.valueOf(readResponse.isSelected()));
+        sampler.setReadResponse(String.valueOf(storeResponse.isSelected()));
         sampler.setClientChoice(clientChoice.getText());
         sampler.setStopBetweenSamples(stopBetweenSamples.isSelected());
         sampler.setTimeout(timeout.getText());
@@ -190,9 +190,9 @@ public class JMSSubscriberGui extends AbstractSamplerGui implements ChangeListen
         mainPanel.add(useAuth);
         mainPanel.add(jmsUser);
         mainPanel.add(jmsPwd);
-        mainPanel.add(iterations);
+        mainPanel.add(samplesToAggregate);
 
-        mainPanel.add(readResponse);
+        mainPanel.add(storeResponse);
         mainPanel.add(timeout);
         
         JPanel choice = new HorizontalPanel();
@@ -222,11 +222,11 @@ public class JMSSubscriberGui extends AbstractSamplerGui implements ChangeListen
         jmsSelector.setText(sampler.getJmsSelector());
         jmsUser.setText(sampler.getUsername());
         jmsPwd.setText(sampler.getPassword());
-        iterations.setText(sampler.getIterations());
+        samplesToAggregate.setText(sampler.getIterations());
         useAuth.setSelected(sampler.isUseAuth());
         jmsUser.setEnabled(useAuth.isSelected());
         jmsPwd.setEnabled(useAuth.isSelected());
-        readResponse.setSelected(sampler.getReadResponseAsBoolean());
+        storeResponse.setSelected(sampler.getReadResponseAsBoolean());
         clientChoice.setText(sampler.getClientChoice());
         stopBetweenSamples.setSelected(sampler.isStopBetweenSamples());
         timeout.setText(sampler.getTimeout());
@@ -247,13 +247,13 @@ public class JMSSubscriberGui extends AbstractSamplerGui implements ChangeListen
         jmsSelector.setText(""); // $NON-NLS-1$
         jmsUser.setText(""); // $NON-NLS-1$
         jmsPwd.setText(""); // $NON-NLS-1$
-        iterations.setText("1"); // $NON-NLS-1$
+        samplesToAggregate.setText("1"); // $NON-NLS-1$
         timeout.setText(""); // $NON-NLS-1$
         separator.setText(""); // $NON-NLS-1$
         useAuth.setSelected(false);
         jmsUser.setEnabled(false);
         jmsPwd.setEnabled(false);
-        readResponse.setSelected(true);
+        storeResponse.setSelected(true);
         clientChoice.setText(RECEIVE_RSC);
         stopBetweenSamples.setSelected(false);
         destSetup.setText(DEST_SETUP_STATIC);

src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/BaseJMSSampler.java

@@ -52,13 +52,20 @@ public abstract class BaseJMSSampler extends AbstractSampler {
 
     private static final String CREDENTIALS = "jms.security_credentials"; // $NON-NLS-1$
 
+    /*
+     * The number of samples to aggregate
+     */
     private static final String ITERATIONS = "jms.iterations"; // $NON-NLS-1$
 
     private static final String USE_AUTH = "jms.authenticate"; // $NON-NLS-1$
 
     private static final String USE_PROPERTIES_FILE = "jms.jndi_properties"; // $NON-NLS-1$
 
-    private static final String READ_RESPONSE = "jms.read_response"; // $NON-NLS-1$
+    /*
+     * If true, store the response in the sampleResponse
+     * (N.B. do not change the value, as it is used in JMX files)
+     */
+    private static final String STORE_RESPONSE = "jms.read_response"; // $NON-NLS-1$
 
     // Is Destination setup static? else dynamic
     private static final String DESTINATION_STATIC = "jms.destination_static"; // $NON-NLS-1$
@@ -203,18 +210,18 @@ public abstract class BaseJMSSampler extends AbstractSampler {
     }
 
     /**
-     * get the iterations as string
+     * get the number of samples to aggregate
      *
-     * @return the number of iterations
+     * @return String containing the the number of samples to aggregate
      */
     public String getIterations() {
         return getPropertyAsString(ITERATIONS);
     }
 
     /**
-     * return the number of iterations as int instead of string
+     * get the number of samples to aggregate
      *
-     * @return the number of iterations as int instead of string
+     * @return int containing the the number of samples to aggregate
      */
     public int getIterationCount() {
         return getPropertyAsInt(ITERATIONS);
@@ -240,30 +247,30 @@ public abstract class BaseJMSSampler extends AbstractSampler {
     }
 
     /**
-     * set whether the sampler should read the response or not
+     * set whether the sampler should store the response or not
      *
-     * @param read whether the sampler should read the response or not
+     * @param read whether the sampler should store the response or not
      */
     public void setReadResponse(String read) {
-        setProperty(READ_RESPONSE, read);
+        setProperty(STORE_RESPONSE, read);
     }
 
     /**
-     * return whether the sampler should read the response
+     * return whether the sampler should store the response
      *
-     * @return whether the sampler should read the response
+     * @return whether the sampler should store the response
      */
     public String getReadResponse() {
-        return getPropertyAsString(READ_RESPONSE);
+        return getPropertyAsString(STORE_RESPONSE);
     }
 
     /**
-     * return whether the sampler should read the response as a boolean value
+     * return whether the sampler should store the response
      *
-     * @return whether the sampler should read the response as a boolean value
+     * @return boolean: whether the sampler should read the response
      */
     public boolean getReadResponseAsBoolean() {
-        return getPropertyAsBoolean(READ_RESPONSE);
+        return getPropertyAsBoolean(STORE_RESPONSE);
     }
 
     /**

xdocs/changes.xml

@@ -121,6 +121,7 @@ Summary
 <li><bug>57913</bug>Automated backups of last saved JMX files. Contributed by Benoit Vatan (benoit.vatan at gmail.com)</li>
 <li><bug>57988</bug>Shortcuts (Ctrl+1 .. Ctrl+9) to quick add elements into test plan. Implemented by Andrey Pokhilko (andrey at blazemeter.com) and contributed by BlazeMeter Ltd.</li>
 <li><bug>58100</bug>Performance enhancements : Replace Random by ThreadLocalRandom.</li>
+<li><bug>58465</bug>JMS Read response field is badly named and documented</li>
 </ul>
 <ch_section>Non-functional changes</ch_section>
 <ul>

xdocs/usermanual/component_reference.xml

@@ -1644,7 +1644,7 @@ The following table shows some values which may be useful when configuring JMS:
   <property name="User" required="No">User Name</property>
   <property name="Password" required="No">Password (N.B. this is stored unencrypted in the test plan)</property>
   <property name="Number of samples to aggregate" required="Yes">number of samples to aggregate</property>
-  <property name="Read response" required="Yes">should the sampler read the response. If not, only the response length is returned.</property>
+  <property name="Read response" required="Yes">should the sampler store the response. If not, only the response length is returned.</property>
   <property name="Timeout" required="Yes">Specify the timeout to be applied, in milliseconds. <code>0</code>=none. 
   This is the overall aggregate timeout, not per sample.</property>
   <property name="Client" required="Yes">Which client implementation to use.