jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1649078 - in /jmeter/trunk/src: monitor/components/org/apache/jmeter/visualizers/ protocol/http/org/apache/jmeter/protocol/http/config/ protocol/jdbc/org/apache/jmeter/protocol/jdbc/ protocol/jdbc/org/apache/jmeter/protocol/jdbc/config/ pr...
Date Fri, 02 Jan 2015 17:06:12 GMT
Author: fschumacher
Date: Fri Jan  2 17:06:11 2015
New Revision: 1649078

URL: http://svn.apache.org/r1649078
Log:
Bug 57193: Add param and return tags to javadoc
Bugzilla Id: 57193

Modified:
    jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorHealthPanel.java
    jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorPerformancePanel.java
    jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/ServerPanel.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/MultipartUrlConfig.java
    jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/JDBCTestElementBeanInfoSupport.java
    jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/config/DataSourceElementBeanInfo.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ClientPool.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/Publisher.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSPropertiesPanel.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSSamplerGui.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/MessageAdmin.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/Receiver.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/TemporaryQueueExecutor.java
    jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArgument.java
    jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArguments.java
    jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LDAPExtSampler.java
    jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapClient.java
    jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapExtClient.java
    jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/gui/SmtpPanel.java
    jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java
    jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SynchronousTransportListener.java
    jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/config/MongoDBHolder.java
    jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/sampler/MongoScriptRunner.java
    jmeter/trunk/src/protocol/native/org/apache/jmeter/protocol/system/SystemSampler.java
    jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/BinaryTCPClientImpl.java
    jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/TCPClient.java

Modified: jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorHealthPanel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorHealthPanel.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorHealthPanel.java (original)
+++ jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorHealthPanel.java Fri Jan  2 17:06:11 2015
@@ -69,6 +69,7 @@ public class MonitorHealthPanel extends
     }
 
     /**
+     * @param model model to use
      *
      */
     public MonitorHealthPanel(MonitorAccumModel model) {
@@ -111,7 +112,7 @@ public class MonitorHealthPanel extends
 
     /**
      *
-     * @param model
+     * @param model information about monitored server
      */
     @Override
     public void addSample(MonitorModel model) {

Modified: jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorPerformancePanel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorPerformancePanel.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorPerformancePanel.java (original)
+++ jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorPerformancePanel.java Fri Jan  2 17:06:11 2015
@@ -112,6 +112,8 @@ public class MonitorPerformancePanel ext
     }
 
     /**
+     * @param model model to use
+     * @param graph graph to use
      *
      */
     public MonitorPerformancePanel(MonitorAccumModel model, MonitorGraph graph) {

Modified: jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/ServerPanel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/ServerPanel.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/ServerPanel.java (original)
+++ jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/ServerPanel.java Fri Jan  2 17:06:11 2015
@@ -87,7 +87,10 @@ public class ServerPanel extends JPanel
     // private MonitorModel DATA;
 
     /**
+     * Creates a new server panel for a monitored server
      *
+     * @param model
+     *            information about the monitored server
      */
     public ServerPanel(MonitorModel model) {
         super();
@@ -108,7 +111,7 @@ public class ServerPanel extends JPanel
      * Init will create the JLabel widgets for the host, health, load and
      * timestamp.
      *
-     * @param model
+     * @param model information about the monitored server
      */
     private void init(MonitorModel model) {
         this.setLayout(new FlowLayout());

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/MultipartUrlConfig.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/MultipartUrlConfig.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/MultipartUrlConfig.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/MultipartUrlConfig.java Fri Jan  2 17:06:11 2015
@@ -117,6 +117,8 @@ public class MultipartUrlConfig implemen
      * This method allows a proxy server to send over the raw text from a
      * browser's output stream to be parsed and stored correctly into the
      * UrlConfig object.
+     *
+     * @param queryString text to parse
      */
     public void parseArguments(String queryString) {
         String[] parts = JOrphanUtils.split(queryString, "--" + getBoundary()); //$NON-NLS-1$

Modified: jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/JDBCTestElementBeanInfoSupport.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/JDBCTestElementBeanInfoSupport.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/JDBCTestElementBeanInfoSupport.java (original)
+++ jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/JDBCTestElementBeanInfoSupport.java Fri Jan  2 17:06:11 2015
@@ -27,7 +27,7 @@ import org.apache.jmeter.testbeans.gui.T
 public abstract class JDBCTestElementBeanInfoSupport extends BeanInfoSupport {
 
     /**
-     *
+     * @param beanClass class to create bean info for
      */
     public JDBCTestElementBeanInfoSupport(Class<? extends TestBean> beanClass) {
         super(beanClass);

Modified: jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/config/DataSourceElementBeanInfo.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/config/DataSourceElementBeanInfo.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/config/DataSourceElementBeanInfo.java (original)
+++ jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/config/DataSourceElementBeanInfo.java Fri Jan  2 17:06:11 2015
@@ -104,8 +104,18 @@ public class DataSourceElementBeanInfo e
     }
 
     /**
-     * @param tag 
-     * @return int value for String
+     * Converts a string description of a valid transaction isolation mode to the respective integer value.
+     * Currently supported tags and their values are:
+     * <dl>
+     * <dt>DEFAULT</dt><dd>-1</dd>
+     * <dt>TRANSACTION_NONE</dt><dd>{@value Connection#TRANSACTION_NONE}</dd>
+     * <dt>TRANSACTION_REAd_COMMITTED</dt><dd>{@value Connection#TRANSACTION_READ_COMMITTED}</dd>
+     * <dt>TRANSACTION_READ_UNCOMMITTED</dt><dd>{@value Connection#TRANSACTION_READ_UNCOMMITTED}</dd>
+     * <dt>TRANSACTION_REPEATABLE_READ</dt><dd>{@value Connection#TRANSACTION_REPEATABLE_READ}</dd>
+     * <dt>TRANSACTION_SERIALIZABLE</dt><dd>{@value Connection#TRANSACTION_SERIALIZABLE}</dd>
+     * </dl>
+     * @param tag name of the transaction isolation mode
+     * @return integer value of the given transaction isolation mode
      */
     public static int getTransactionIsolationMode(String tag) {
         if (!StringUtils.isEmpty(tag)) {

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java Fri Jan  2 17:06:11 2015
@@ -133,9 +133,12 @@ public final class Utils {
      * Method will lookup a given destination (topic/queue) using JNDI.
      *
      * @param context
-     * @param name the destination name
+     *            context to use for lookup
+     * @param name
+     *            the destination name
      * @return the destination, never null
-     * @throws NamingException if the name cannot be found as a Destination
+     * @throws NamingException
+     *             if the name cannot be found as a Destination
      */
     public static Destination lookupDestination(Context context, String name) throws NamingException {
         Object o = context.lookup(name);
@@ -146,12 +149,16 @@ public final class Utils {
     }
 
     /**
-     * Get value from Context environment taking into account non fully compliant
-     * JNDI implementations
+     * Get value from Context environment taking into account non fully
+     * compliant JNDI implementations
+     *
      * @param context
+     *            context to use
      * @param key
-     * @return String or null if context.getEnvironment() is not compliant
-     * @throws NamingException 
+     *            key to lookup in contexts environment
+     * @return String or <code>null</code> if context.getEnvironment() is not compliant
+     * @throws NamingException
+     *             if a naming problem occurs while getting the environment
      */
     public static final String getFromEnvironment(Context context, String key) throws NamingException {
         try {
@@ -173,10 +180,14 @@ public final class Utils {
      * Obtain the queue connection from the context and factory name.
      * 
      * @param ctx
+     *            context to use
      * @param factoryName
+     *            name of the object factory to look up in <code>context</code>
      * @return the queue connection
      * @throws JMSException
+     *             when creation of the connection fails
      * @throws NamingException
+     *             when lookup in context fails
      */
     public static Connection getConnection(Context ctx, String factoryName) throws JMSException, NamingException {
         Object objfac = null;

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ClientPool.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ClientPool.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ClientPool.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ClientPool.java Fri Jan  2 17:06:11 2015
@@ -44,7 +44,7 @@ public class ClientPool {
      * Add a ReceiveClient to the ClientPool. This is so that we can make sure
      * to close all clients and make sure all threads are destroyed.
      *
-     * @param client
+     * @param client the ReceiveClient to add
      */
     public static synchronized void addClient(Closeable client) {
         clients.add(client);

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java Fri Jan  2 17:06:11 2015
@@ -43,11 +43,11 @@ public class InitialContextFactory {
      * 
      * @param initialContextFactory used to set the property {@link Context#INITIAL_CONTEXT_FACTORY}
      * @param providerUrl used to set the property {@link Context#PROVIDER_URL}
-     * @param useAuth set true if security is to be used.
+     * @param useAuth set <code>true</code> if security is to be used.
      * @param securityPrincipal used to set the property {@link Context#SECURITY_PRINCIPAL}
      * @param securityCredentials used to set the property {@link Context#SECURITY_CREDENTIALS}
-     * @return the context, never null
-     * @throws NamingException 
+     * @return the context, never <code>null</code>
+     * @throws NamingException when creation of the context fails
      */
     public static Context lookupContext(String initialContextFactory, 
             String providerUrl, boolean useAuth, String securityPrincipal, String securityCredentials) throws NamingException {
@@ -121,15 +121,29 @@ public class InitialContextFactory {
     /**
      * Initialize the JNDI initial context
      *
-     * @param useProps if true, create a new InitialContext; otherwise use the other parameters to call
-     * {@link #lookupContext(String, String, boolean, String, String)} 
-     * @param initialContextFactory (ignored if useProps is true)
-     * @param providerUrl (ignored if useProps is true)
-     * @param useAuth (ignored if useProps is true)
-     * @param securityPrincipal (ignored if useProps is true)
-     * @param securityCredentials (ignored if useProps is true)
-     * @return  the context, never null
-     * @throws NamingException 
+     * @param useProps
+     *            if true, create a new InitialContext; otherwise use the other
+     *            parameters to call
+     *            {@link #lookupContext(String, String, boolean, String, String)}
+     * @param initialContextFactory
+     *            name of the initial context factory (ignored if
+     *            <code>useProps</code> is <code>true</code>)
+     * @param providerUrl
+     *            url of the provider to use (ignored if <code>useProps</code>
+     *            is <code>true</code>)
+     * @param useAuth
+     *            <code>true</code> if auth should be used, <code>false</code>
+     *            otherwise (ignored if <code>useProps</code> is
+     *            <code>true</code>)
+     * @param securityPrincipal
+     *            name of the principal to (ignored if <code>useProps</code> is
+     *            <code>true</code>)
+     * @param securityCredentials
+     *            credentials for the principal (ignored if
+     *            <code>useProps</code> is <code>true</code>)
+     * @return the context, never <code>null</code>
+     * @throws NamingException
+     *             when creation of the context fails
      */
     public static Context getContext(boolean useProps, 
             String initialContextFactory, String providerUrl, 

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/Publisher.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/Publisher.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/Publisher.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/Publisher.java Fri Jan  2 17:06:11 2015
@@ -55,19 +55,31 @@ public class Publisher implements Closea
     private final boolean staticDest;
 
     /**
-     * Create a publisher using either the jndi.properties file or the provided parameters.
-     * Uses a static destination and persistent messages(for backward compatibility)
-     * 
-     * @param useProps true if a jndi.properties file is to be used
-     * @param initialContextFactory the (ignored if useProps is true)
-     * @param providerUrl (ignored if useProps is true)
+     * Create a publisher using either the jndi.properties file or the provided
+     * parameters. Uses a static destination and persistent messages(for
+     * backward compatibility)
+     *
+     * @param useProps
+     *            true if a jndi.properties file is to be used
+     * @param initialContextFactory
+     *            the (ignored if useProps is true)
+     * @param providerUrl
+     *            (ignored if useProps is true)
      * @param connfactory
+     *            name of the object factory to look up in context
      * @param destinationName
-     * @param useAuth (ignored if useProps is true)
-     * @param securityPrincipal (ignored if useProps is true)
-     * @param securityCredentials (ignored if useProps is true) 
-     * @throws JMSException if the context could not be initialised, or there was some other error
-     * @throws NamingException 
+     *            name of the destination to use
+     * @param useAuth
+     *            (ignored if useProps is true)
+     * @param securityPrincipal
+     *            (ignored if useProps is true)
+     * @param securityCredentials
+     *            (ignored if useProps is true)
+     * @throws JMSException
+     *             if the context could not be initialised, or there was some
+     *             other error
+     * @throws NamingException
+     *             when creation of the publisher fails
      */
     public Publisher(boolean useProps, String initialContextFactory, String providerUrl, 
             String connfactory, String destinationName, boolean useAuth,
@@ -79,18 +91,32 @@ public class Publisher implements Closea
     
     
     /**
-     * Create a publisher using either the jndi.properties file or the provided parameters
-     * @param useProps true if a jndi.properties file is to be used
-     * @param initialContextFactory the (ignored if useProps is true)
-     * @param providerUrl (ignored if useProps is true)
+     * Create a publisher using either the jndi.properties file or the provided
+     * parameters
+     *
+     * @param useProps
+     *            true if a jndi.properties file is to be used
+     * @param initialContextFactory
+     *            the (ignored if useProps is true)
+     * @param providerUrl
+     *            (ignored if useProps is true)
      * @param connfactory
+     *            name of the object factory to lookup in context
      * @param destinationName
-     * @param useAuth (ignored if useProps is true)
-     * @param securityPrincipal (ignored if useProps is true)
-     * @param securityCredentials (ignored if useProps is true)
-     * @param staticDestination true if the destination is not to change between loops
-     * @throws JMSException if the context could not be initialised, or there was some other error
-     * @throws NamingException 
+     *            name of the destination to use
+     * @param useAuth
+     *            (ignored if useProps is true)
+     * @param securityPrincipal
+     *            (ignored if useProps is true)
+     * @param securityCredentials
+     *            (ignored if useProps is true)
+     * @param staticDestination
+     *            true if the destination is not to change between loops
+     * @throws JMSException
+     *             if the context could not be initialised, or there was some
+     *             other error
+     * @throws NamingException
+     *             when creation of the publisher fails
      */
     public Publisher(boolean useProps, String initialContextFactory, String providerUrl, 
             String connfactory, String destinationName, boolean useAuth,

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java Fri Jan  2 17:06:11 2015
@@ -69,24 +69,44 @@ public class ReceiveSubscriber implement
 
     /**
      * Constructor takes the necessary JNDI related parameters to create a
-     * connection and prepare to begin receiving messages.
-     * <br>
+     * connection and prepare to begin receiving messages. <br>
      * The caller must then invoke {@link #start()} to enable message reception.
-     * 
-     * @param useProps if true, use jndi.properties instead of 
-     * initialContextFactory, providerUrl, securityPrincipal, securityCredentials
+     *
+     * @param useProps
+     *            if <code>true</code>, use <em>jndi.properties</em> instead of
+     *            <code>initialContextFactory</code>, <code>providerUrl</code>,
+     *            <code>securityPrincipal</code>,
+     *            <code>securityCredentials</code>
      * @param initialContextFactory
+     *            name of the initial context factory (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
      * @param providerUrl
+     *            url of the provider (will be ignored if <code>useProps</code>
+     *            is <code>true</code>)
      * @param connfactory
+     *            name of the object factory to look up in context
      * @param destinationName
+     *            name of the destination
      * @param durableSubscriptionId
+     *            id for a durable subscription (if empty or <code>null</code>
+     *            no durable subscription will be done)
      * @param clientId
-     * @param jmsSelector Message Selector
+     *            client id to use (may be empty or <code>null</code>)
+     * @param jmsSelector
+     *            Message Selector
      * @param useAuth
+     *            flag whether auth should be used (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
      * @param securityPrincipal
+     *            name of the principal to use for auth (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
      * @param securityCredentials
-     * @throws JMSException if could not create context or other problem occurred.
-     * @throws NamingException 
+     *            credentials for the principal (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
+     * @throws JMSException
+     *             if could not create context or other problem occurred.
+     * @throws NamingException
+     *             when lookup of context or destination fails
      */
     public ReceiveSubscriber(boolean useProps, 
             String initialContextFactory, String providerUrl, String connfactory, String destinationName,
@@ -100,25 +120,48 @@ public class ReceiveSubscriber implement
 
     /**
      * Constructor takes the necessary JNDI related parameters to create a
-     * connection and create an onMessageListener to prepare to begin receiving messages.
-     * <br>
+     * connection and create an onMessageListener to prepare to begin receiving
+     * messages. <br>
      * The caller must then invoke {@link #start()} to enable message reception.
-     * 
-     * @param queueSize maximum queue size, where a queueSize &lt;=0 means no limit
-     * @param useProps if true, use jndi.properties instead of 
-     * initialContextFactory, providerUrl, securityPrincipal, securityCredentials
+     *
+     * @param queueSize
+     *            maximum queue size, where a <code>queueSize</code> &lt;=0
+     *            means no limit
+     * @param useProps
+     *            if <code>true</code>, use <em>jndi.properties</em> instead of
+     *            <code>initialContextFactory</code>, <code>providerUrl</code>,
+     *            <code>securityPrincipal</code>,
+     *            <code>securityCredentials</code>
      * @param initialContextFactory
+     *            name of the initial context factory (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
      * @param providerUrl
+     *            url of the provider (will be ignored if <code>useProps</code>
+     *            is <code>true</code>)
      * @param connfactory
+     *            name of the object factory to look up in context
      * @param destinationName
+     *            name of the destination
      * @param durableSubscriptionId
+     *            id for a durable subscription (if empty or <code>null</code>
+     *            no durable subscription will be done)
      * @param clientId
-     * @param jmsSelector Message Selector
+     *            client id to use (may be empty or <code>null</code>)
+     * @param jmsSelector
+     *            Message Selector
      * @param useAuth
+     *            flag whether auth should be used (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
      * @param securityPrincipal
+     *            name of the principal to use for auth (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
      * @param securityCredentials
-     * @throws JMSException if could not create context or other problem occurred.
-     * @throws NamingException 
+     *            credentials for the principal (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
+     * @throws JMSException
+     *             if could not create context or other problem occurred.
+     * @throws NamingException
+     *             when lookup of context or destination fails
      */
     public ReceiveSubscriber(int queueSize, boolean useProps, 
             String initialContextFactory, String providerUrl, String connfactory, String destinationName,
@@ -133,26 +176,51 @@ public class ReceiveSubscriber implement
     
     /**
      * Constructor takes the necessary JNDI related parameters to create a
-     * connection and create an onMessageListener to prepare to begin receiving messages.
-     * <br/>
+     * connection and create an onMessageListener to prepare to begin receiving
+     * messages. <br/>
      * The caller must then invoke {@link #start()} to enable message reception.
-     * 
-     * @param queueSize maximum queue, where a queueSize &lt;=0 means no limit
-     * @param useProps if true, use jndi.properties instead of 
-     * initialContextFactory, providerUrl, securityPrincipal, securityCredentials
+     *
+     * @param queueSize
+     *            maximum queue, where a queueSize &lt;=0 means no limit
+     * @param useProps
+     *            if <code>true</code>, use <em>jndi.properties</em> instead of
+     *            <code>initialContextFactory</code>, <code>providerUrl</code>,
+     *            <code>securityPrincipal</code>,
+     *            <code>securityCredentials</code>
      * @param initialContextFactory
+     *            name of the initial context factory (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
      * @param providerUrl
+     *            url of the provider (will be ignored if <code>useProps</code>
+     *            is <code>true</code>)
      * @param connfactory
+     *            name of the object factory to look up in context
      * @param destinationName
+     *            name of the destination
      * @param durableSubscriptionId
+     *            id for a durable subscription (if empty or <code>null</code>
+     *            no durable subscription will be done)
      * @param clientId
-     * @param jmsSelector Message Selector
+     *            client id to use (may be empty or <code>null</code>)
+     * @param jmsSelector
+     *            Message Selector
      * @param useAuth
+     *            flag whether auth should be used (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
      * @param securityPrincipal
+     *            name of the principal to use for auth (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
      * @param securityCredentials
-     * @param useMessageListener if true create an onMessageListener to prepare to begin receiving messages, otherwise queue will be null
-     * @throws JMSException if could not create context or other problem occurred.
-     * @throws NamingException 
+     *            credentials for the principal (will be ignored if
+     *            <code>useProps</code> is <code>true</code>)
+     * @param useMessageListener
+     *            if <code>true</code> create an onMessageListener to prepare to
+     *            begin receiving messages, otherwise queue will be
+     *            <code>null</code>
+     * @throws JMSException
+     *             if could not create context or other problem occurred.
+     * @throws NamingException
+     *             when lookup of context or destination fails
      */
     private ReceiveSubscriber(int queueSize, boolean useProps, 
             String initialContextFactory, String providerUrl, String connfactory, String destinationName,
@@ -222,7 +290,7 @@ public class ReceiveSubscriber implement
 
     /**
      * Calls Connection.start() to begin receiving inbound messages.
-     * @throws JMSException 
+     * @throws JMSException when starting the context fails
      */
     public void start() throws JMSException {
         log.debug("start()");
@@ -232,7 +300,7 @@ public class ReceiveSubscriber implement
 
     /**
      * Calls Connection.stop() to stop receiving inbound messages.
-     * @throws JMSException 
+     * @throws JMSException when stopping the context fails
      */
     public void stop() throws JMSException {
         log.debug("stop()");
@@ -241,13 +309,14 @@ public class ReceiveSubscriber implement
     }
 
     /**
-     * Get the next message or null.
+     * Get the next message or <code>null</code>.
+     * <p>
      * Never blocks for longer than the specified timeout.
      * 
      * @param timeout in milliseconds
-     * @return the next message or null
+     * @return the next message or <code>null</code>
      * 
-     * @throws JMSException
+     * @throws JMSException when receiving the message fails
      */
     public Message getMessage(long timeout) throws JMSException {
         Message message = null;

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSPropertiesPanel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSPropertiesPanel.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSPropertiesPanel.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSPropertiesPanel.java Fri Jan  2 17:06:11 2015
@@ -87,6 +87,9 @@ public class JMSPropertiesPanel extends
     /**
      * Modifies a given TestElement to mirror the data in the gui components.
      *
+     * @param el
+     *            the test element to modify
+     *
      * @see org.apache.jmeter.gui.JMeterGUIComponent#modifyTestElement(TestElement)
      */
     public void modifyTestElement(TestElement el) {

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSSamplerGui.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSSamplerGui.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSSamplerGui.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/control/gui/JMSSamplerGui.java Fri Jan  2 17:06:11 2015
@@ -148,7 +148,7 @@ public class JMSSamplerGui extends Abstr
 
     /**
      *
-     * @param element
+     * @param element the test element being created
      */
     @Override
     public void modifyTestElement(TestElement element) {

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java Fri Jan  2 17:06:11 2015
@@ -547,7 +547,7 @@ public class JMSSampler extends Abstract
     }
     
     /**
-     * @param string
+     * @param string name of the initial context factory to use
      */
     public void setInitialContextFactory(String string) {
         setProperty(JNDI_INITIAL_CONTEXT_FACTORY, string);
@@ -555,7 +555,7 @@ public class JMSSampler extends Abstract
     }
 
     /**
-     * @param string
+     * @param string url of the provider
      */
     public void setContextProvider(String string) {
         setProperty(JNDI_CONTEXT_PROVIDER_URL, string);

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/MessageAdmin.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/MessageAdmin.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/MessageAdmin.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/MessageAdmin.java Fri Jan  2 17:06:11 2015
@@ -41,12 +41,27 @@ public class MessageAdmin {
     private MessageAdmin() {
     }
 
+    /**
+     * Get the singleton MessageAdmin object
+     * 
+     * @return singleton instance
+     */
     public static MessageAdmin getAdmin() {
         return SINGLETON;
     }
 
     /**
+     * Store a request under the given id, so that an arriving reply can be
+     * associated with this request and the waiting party can be signaled by
+     * means of a {@link CountDownLatch}
+     *
+     * @param id
+     *            id of the request
      * @param request
+     *            request object to store under id
+     * @param latch
+     *            communication latch to signal when a reply for this request
+     *            was received
      */
     public void putRequest(String id, Message request, CountDownLatch latch) {
         if (log.isDebugEnabled()) {
@@ -55,6 +70,16 @@ public class MessageAdmin {
         table.put(id, new PlaceHolder(request, latch));
     }
 
+    /**
+     * Try to associate a reply to a previously stored request. If a matching
+     * request is found, the owner of the request will be notified with the
+     * registered {@link CountDownLatch}
+     * 
+     * @param id
+     *            id of the request
+     * @param reply
+     *            object with the reply
+     */
     public void putReply(String id, Message reply) {
         PlaceHolder holder = table.get(id);
         if (log.isDebugEnabled()) {

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java Fri Jan  2 17:06:11 2015
@@ -269,7 +269,7 @@ public class PublisherSampler extends Ba
      * The implementation uses TextFile to load the contents of the file and
      * returns a string.
      *
-     * @param path
+     * @param path path to the file to read in
      * @return the contents of the file
      */
     public String getFileContent(String path) {
@@ -404,6 +404,10 @@ public class PublisherSampler extends Ba
      * set the source of the message
      *
      * @param choice
+     *            source of the messages. One of
+     *            {@link JMSPublisherGui#USE_FILE_RSC},
+     *            {@link JMSPublisherGui#USE_RANDOM_RSC} or
+     *            JMSPublisherGui#USE_TEXT_RSC
      */
     public void setConfigChoice(String choice) {
         setProperty(CONFIG_CHOICE, choice);
@@ -416,6 +420,8 @@ public class PublisherSampler extends Ba
     /**
      * return the source of the message
      * Converts from old JMX files which used the local language string
+     *
+     * @return source of the messages
      */
     public String getConfigChoice() {
         // Allow for the old JMX file which used the local language string
@@ -434,14 +440,14 @@ public class PublisherSampler extends Ba
     /**
      * set the type of the message
      *
-     * @param choice
+     * @param choice type of the message (Text, Object, Map)
      */
     public void setMessageChoice(String choice) {
         setProperty(MESSAGE_CHOICE, choice);
     }
 
     /**
-     * return the type of the message (Text, Object, Map)
+     * @return the type of the message (Text, Object, Map)
      *
      */
     public String getMessageChoice() {
@@ -451,14 +457,14 @@ public class PublisherSampler extends Ba
     /**
      * set the input file for the publisher
      *
-     * @param file
+     * @param file input file for the publisher
      */
     public void setInputFile(String file) {
         setProperty(INPUT_FILE, file);
     }
 
     /**
-     * return the path of the input file
+     * @return the path of the input file
      *
      */
     public String getInputFile() {
@@ -468,14 +474,14 @@ public class PublisherSampler extends Ba
     /**
      * set the random path for the messages
      *
-     * @param path
+     * @param path random path for the messages
      */
     public void setRandomPath(String path) {
         setProperty(RANDOM_PATH, path);
     }
 
     /**
-     * return the random path for messages
+     * @return the random path for messages
      *
      */
     public String getRandomPath() {
@@ -485,14 +491,14 @@ public class PublisherSampler extends Ba
     /**
      * set the text for the message
      *
-     * @param message
+     * @param message text for the message
      */
     public void setTextMessage(String message) {
         setProperty(TEXT_MSG, message);
     }
 
     /**
-     * return the text for the message
+     * @return the text for the message
      *
      */
     public String getTextMessage() {

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/Receiver.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/Receiver.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/Receiver.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/Receiver.java Fri Jan  2 17:06:11 2015
@@ -84,15 +84,23 @@ public final class Receiver implements R
 
     /**
      * Create a receiver to process responses.
-     * 
+     *
      * @param factory
+     *            connection factory to use
      * @param receiveQueue
+     *            name of the receiving queue
      * @param principal
+     *            user name to use for connecting to the queue
      * @param credentials
-     * @param useResMsgIdAsCorrelId true if should use JMSMessageId, false if should use JMSCorrelationId
-     * @param jmsSelector JMS selector
+     *            credentials to use for connecting to the queue
+     * @param useResMsgIdAsCorrelId
+     *            <code>true</code> if should use JMSMessageId,
+     *            <code>false</code> if should use JMSCorrelationId
+     * @param jmsSelector
+     *            JMS selector
      * @return the Receiver which will process the responses
      * @throws JMSException
+     *             when creating the receiver fails
      */
     public static Receiver createReceiver(ConnectionFactory factory, Destination receiveQueue,
             String principal, String credentials, boolean useResMsgIdAsCorrelId, String jmsSelector)

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java Fri Jan  2 17:06:11 2015
@@ -358,6 +358,11 @@ public class SubscriberSampler extends B
     /**
      * Set the client choice. There are two options: ReceiveSusbscriber and
      * OnMessageSubscriber.
+     *
+     * @param choice
+     *            the client to use. One of {@link JMSSubscriberGui#RECEIVE_RSC
+     *            RECEIVE_RSC} or {@link JMSSubscriberGui#ON_MESSAGE_RSC
+     *            ON_MESSAGE_RSC}
      */
     public void setClientChoice(String choice) {
         setProperty(CLIENT_CHOICE, choice);
@@ -366,7 +371,9 @@ public class SubscriberSampler extends B
     /**
      * Return the client choice.
      *
-     * @return the client choice, either RECEIVE_RSC or ON_MESSAGE_RSC
+     * @return the client choice, either {@link JMSSubscriberGui#RECEIVE_RSC
+     *         RECEIVE_RSC} or {@link JMSSubscriberGui#ON_MESSAGE_RSC
+     *         ON_MESSAGE_RSC}
      */
     public String getClientChoice() {
         String choice = getPropertyAsString(CLIENT_CHOICE);
@@ -436,7 +443,9 @@ public class SubscriberSampler extends B
     
     /**
      * Separator for sampler results
+     *
      * @param text
+     *            separator to use for sampler results
      */
     public void setSeparator(String text) {
         setProperty(SEPARATOR, text, SEPARATOR_DEFAULT);

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/TemporaryQueueExecutor.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/TemporaryQueueExecutor.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/TemporaryQueueExecutor.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/TemporaryQueueExecutor.java Fri Jan  2 17:06:11 2015
@@ -41,6 +41,9 @@ public class TemporaryQueueExecutor impl
      * @param destination
      *            the queue to send the message on
      * @throws JMSException
+     *             when internally used {@link QueueRequestor} can not be
+     *             constructed with <code>session</code> and
+     *             <code>destination</code>
      */
     public TemporaryQueueExecutor(QueueSession session, Queue destination) throws JMSException {
         requestor = new QueueRequestor(session, destination);

Modified: jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArgument.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArgument.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArgument.java (original)
+++ jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArgument.java Fri Jan  2 17:06:11 2015
@@ -67,6 +67,10 @@ public class LDAPArgument extends Abstra
      *            the argument name
      * @param value
      *            the argument value
+     * @param opcode
+     *            the operation to perform, may be one of <code>add</code>,
+     *            <code>delete</code>, <code>remove</code> or
+     *            <code>modify</code>.
      */
     public LDAPArgument(String name, String value, String opcode) {
         setProperty(new StringProperty(ARG_NAME, name));
@@ -81,6 +85,10 @@ public class LDAPArgument extends Abstra
      *            the argument name
      * @param value
      *            the argument value
+     * @param opcode
+     *            the operation to perform, may be one of <code>add</code>,
+     *            <code>delete</code>, <code>remove</code> or
+     *            <code>modify</code>.
      * @param metadata
      *            the argument metadata
      */

Modified: jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArguments.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArguments.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArguments.java (original)
+++ jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/config/gui/LDAPArguments.java Fri Jan  2 17:06:11 2015
@@ -102,6 +102,10 @@ public class LDAPArguments extends Confi
      *            the name of the argument
      * @param value
      *            the value of the argument
+     * @param opcode
+     *            the operation to perform, may be one of <code>add</code>,
+     *            <code>delete</code>, <code>remove</code> or
+     *            <code>modify</code>.
      */
     public void addArgument(String name, String value, String opcode) {
         addArgument(new LDAPArgument(name, value, opcode, null));
@@ -128,6 +132,10 @@ public class LDAPArguments extends Confi
      *            the name of the argument
      * @param value
      *            the value of the argument
+     * @param opcode
+     *            the operation to perform, may be one of <code>add</code>,
+     *            <code>delete</code>, <code>remove</code> or
+     *            <code>modify</code>.
      * @param metadata
      *            the metadata for the argument
      */

Modified: jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LDAPExtSampler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LDAPExtSampler.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LDAPExtSampler.java (original)
+++ jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LDAPExtSampler.java Fri Jan  2 17:06:11 2015
@@ -201,6 +201,8 @@ public class LDAPExtSampler extends Abst
     /***************************************************************************
      * Sets the username attribute of the LDAP object
      *
+     * @param newUserDN
+     *            distinguished name of the user
      **************************************************************************/
 
     public void setUserDN(String newUserDN) {
@@ -220,6 +222,8 @@ public class LDAPExtSampler extends Abst
     /***************************************************************************
      * Sets the password attribute of the LDAP object
      *
+     * @param newUserPw
+     *            password of the user
      **************************************************************************/
 
     public void setUserPw(String newUserPw) {
@@ -366,6 +370,8 @@ public class LDAPExtSampler extends Abst
     /***************************************************************************
      * Sets the return objects attribute of the LDAPSampler object
      *
+     * @param newRobj
+     *            whether the objects should be returned
      **************************************************************************/
     public void setRetobj(String newRobj) {
         this.setProperty(RETOBJ, newRobj);

Modified: jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapClient.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapClient.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapClient.java (original)
+++ jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapClient.java Fri Jan  2 17:06:11 2015
@@ -52,6 +52,20 @@ public class LdapClient {
 
     /**
      * Connect to server.
+     * 
+     * @param host
+     *            name of the ldap server
+     * @param port
+     *            port of the ldap server
+     * @param rootdn
+     *            base dn to start ldap operations from
+     * @param username
+     *            user name to use for binding
+     * @param password
+     *            password to use for binding
+     * @throws NamingException
+     *             if {@link InitialDirContext} can not be build using the above
+     *             parameters
      */
     public void connect(String host, String port, String rootdn, String username, String password)
             throws NamingException {
@@ -85,6 +99,10 @@ public class LdapClient {
      *            where the search should start
      * @param searchFilter
      *            filter this value from the base
+     * @return <code>true</code> when the search yields results,
+     *         <code>false</code> otherwise
+     * @throws NamingException
+     *             when searching fails
      */
     public boolean searchTest(String searchBase, String searchFilter) throws NamingException {
         // System.out.println("Base="+searchBase+" Filter="+searchFilter);
@@ -111,9 +129,10 @@ public class LdapClient {
      * Modify the attribute in the ldap directory for the given string.
      *
      * @param mods
-     *            add all the entry in to the ModificationItem
+     *            list of all {@link ModificationItem}s to apply
      * @param string
-     *            the string (dn) value
+     *            dn of the object to modify
+     * @throws NamingException when modification fails
      */
     public void modifyTest(ModificationItem[] mods, String string) throws NamingException {
         dirContext.modifyAttributes(string, mods);
@@ -126,6 +145,7 @@ public class LdapClient {
      *            add all the entry in to the basicattribute
      * @param string
      *            the string (dn) value
+     * @throws NamingException when creating subcontext fails
      */
     public void createTest(BasicAttributes basicattributes, String string) throws NamingException {
         // DirContext dc = //TODO perhaps return this?
@@ -137,6 +157,7 @@ public class LdapClient {
      *
      * @param string
      *            the string (dn) value
+     * @throws NamingException when destroying sub context fails
      */
     public void deleteTest(String string) throws NamingException {
         dirContext.destroySubcontext(string);

Modified: jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapExtClient.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapExtClient.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapExtClient.java (original)
+++ jmeter/trunk/src/protocol/ldap/org/apache/jmeter/protocol/ldap/sampler/LdapExtClient.java Fri Jan  2 17:06:11 2015
@@ -63,13 +63,23 @@ public class LdapExtClient {
      * connect to server
      *
      * @param host
-     *            Description of Parameter
+     *            name of the server to connect
+     * @param port
+     *            port of the server to connect
+     * @param rootdn
+     *            base of the tree to operate on
      * @param username
-     *            Description of Parameter
+     *            name of the user to use for binding
      * @param password
-     *            Description of Parameter
+     *            password to use for binding
+     * @param connTimeOut
+     *            connection timeout for connecting the server see
+     *            "com.sun.jndi.ldap.connect.timeout"
+     * @param secure
+     *            flag whether ssl should be used
+     * @return newly created {@link DirContext}
      * @exception NamingException
-     *                Description of Exception
+     *                when creating the {@link DirContext} fails
      */
     public static DirContext connect(String host, String port, String rootdn, String username, String password, String connTimeOut, boolean secure)
             throws NamingException {
@@ -104,6 +114,9 @@ public class LdapExtClient {
 
     /**
      * disconnect from the server
+     *
+     * @param dirContext
+     *            context do disconnect (may be <code>null</code>)
      */
     public static void disconnect(DirContext dirContext) {
         if (dirContext == null) {
@@ -120,11 +133,34 @@ public class LdapExtClient {
 
     /***************************************************************************
      * Filter the data in the ldap directory for the given search base
+     * 
+     * @param dirContext
+     *            context to perform the search on
      *
      * @param searchBase
      *            base where the search should start
      * @param searchFilter
-     *            filter filter this value from the base
+     *            filter this value from the base
+     * @param scope
+     *            scope for search. May be one of
+     *            {@link SearchControls#OBJECT_SCOPE},
+     *            {@link SearchControls#ONELEVEL_SCOPE} or
+     *            {@link SearchControls#SUBTREE_SCOPE}
+     * @param countlim
+     *            max number of results to get, <code>0</code> for all entries
+     * @param timelim
+     *            max time to wait for entries (in milliseconds), <code>0</code>
+     *            for unlimited time
+     * @param attrs
+     *            list of attributes to return. If <code>null</code> all
+     *            attributes will be returned. If empty, none will be returned
+     * @param retobj
+     *            flag whether the objects should be returned
+     * @param deref
+     *            flag whether objects should be dereferenced
+     * @return result of the search
+     * @throws NamingException
+     *             when searching fails
      **************************************************************************/
     public static NamingEnumeration<SearchResult> searchTest(DirContext dirContext, String searchBase, String searchFilter, int scope, long countlim,
             int timelim, String[] attrs, boolean retobj, boolean deref) throws NamingException {
@@ -151,8 +187,15 @@ public class LdapExtClient {
     /***************************************************************************
      * Filter the data in the ldap directory
      *
+     * @param dirContext
+     *            the context to operate on
      * @param filter
      *            filter this value from the base
+     * @param entrydn
+     *            distinguished name of entry to compare
+     * @return result of the search
+     * @throws NamingException
+     *             when searching fails
      **************************************************************************/
     public static NamingEnumeration<SearchResult> compare(DirContext dirContext, String filter, String entrydn) throws NamingException {
         if (dirContext == null) {
@@ -165,6 +208,15 @@ public class LdapExtClient {
     /***************************************************************************
      * ModDN the data in the ldap directory for the given search base
      *
+     * @param dirContext
+     *            context to operate on
+     * @param ddn
+     *            distinguished name name of object to rename
+     * @param newdn
+     *            new distinguished name of object
+     * @throws NamingException
+     *             when renaming fails
+     *
      **************************************************************************/
     public static void moddnOp(DirContext dirContext, String ddn, String newdn) throws NamingException {
         log.debug("ddn and newDn= " + ddn + "@@@@" + newdn);
@@ -177,10 +229,15 @@ public class LdapExtClient {
     /***************************************************************************
      * Modify the attribute in the ldap directory for the given string
      *
+     * @param dirContext
+     *            context to operate on
      * @param mods
-     *            add all the entry in to the ModificationItem
+     *            list of all the {@link ModificationItem}s to apply on
+     *            <code>string</code>
      * @param string
-     *            The string (dn) value
+     *            distinguished name of the object to modify
+     * @throws NamingException
+     *             when modification fails
      **************************************************************************/
     public static void modifyTest(DirContext dirContext, ModificationItem[] mods, String string) throws NamingException {
         if (dirContext == null) {
@@ -193,10 +250,15 @@ public class LdapExtClient {
     /***************************************************************************
      * Create the entry in the ldap directory for the given string
      *
+     * @param dirContext
+     *            context to operate on
      * @param attributes
      *            add all the attributes and values from the attributes object
      * @param string
-     *            The string (dn) value
+     *            distinguished name of the subcontext to create
+     * @return newly created subcontext
+     * @throws NamingException
+     *             when creating subcontext fails
      **************************************************************************/
     public static DirContext createTest(DirContext dirContext, Attributes attributes, String string)
             throws NamingException {
@@ -209,8 +271,12 @@ public class LdapExtClient {
     /***************************************************************************
      * Delete the attribute from the ldap directory
      *
+     * @param dirContext
+     *            context to operate on
      * @param string
-     *            The string (dn) value
+     *            distinguished name of the subcontext to destroy
+     * @throws NamingException
+     *             when destroying the subcontext fails
      **************************************************************************/
     public static void deleteTest(DirContext dirContext, String string) throws NamingException {
         if (dirContext == null) {

Modified: jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/gui/SmtpPanel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/gui/SmtpPanel.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/gui/SmtpPanel.java (original)
+++ jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/gui/SmtpPanel.java Fri Jan  2 17:06:11 2015
@@ -342,7 +342,7 @@ public class SmtpPanel extends JPanel {
     /**
      * Sets the property that defines if the subject header should be suppressed
      *
-     * @param emptySubject
+     * @param emptySubject flag whether subject header should be suppressed
      *
      */
     public void setSuppressSubject(boolean emptySubject) {
@@ -379,7 +379,7 @@ public class SmtpPanel extends JPanel {
     /**
      * Set whether mail server needs auth.
      *
-     * @param selected
+     * @param selected flag whether mail server needs auth
      */
     public void setUseAuth(boolean selected){
         cbUseAuth.setSelected(selected);

Modified: jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java (original)
+++ jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java Fri Jan  2 17:06:11 2015
@@ -117,7 +117,10 @@ public class SendMailCommand {
      *
      * @return Message-object to be sent to execute()-method
      * @throws MessagingException
+     *             when problems constructing or sending the mail occur
      * @throws IOException
+     *             when the mail content can not be read or truststore problems
+     *             are detected
      */
     public Message prepareMessage() throws MessagingException, IOException {
 
@@ -258,13 +261,18 @@ public class SendMailCommand {
     }
 
     /**
-     * Sends message to mailserver, waiting for delivery if using synchronous mode.
+     * Sends message to mailserver, waiting for delivery if using synchronous
+     * mode.
      *
      * @param message
      *            Message previously prepared by prepareMessage()
      * @throws MessagingException
+     *             when problems sending the mail arise
      * @throws IOException
+     *             TODO can not see how
      * @throws InterruptedException
+     *             when interrupted while waiting for delivery in synchronous
+     *             modus
      */
     public void execute(Message message) throws MessagingException, IOException, InterruptedException {
 
@@ -298,9 +306,14 @@ public class SendMailCommand {
     /**
      * Processes prepareMessage() and execute()
      *
-     * @throws InterruptedException 
-     * @throws IOException 
-     * @throws MessagingException 
+     * @throws InterruptedException
+     *             when interrupted while waiting for delivery in synchronous
+     *             modus
+     * @throws IOException
+     *             when the mail content can not be read or truststore problems
+     *             are detected
+     * @throws MessagingException
+     *             when problems constructing or sending the mail occur
      */
     public void execute() throws MessagingException, IOException, InterruptedException {
         execute(prepareMessage());
@@ -798,7 +811,7 @@ public class SendMailCommand {
     /**
      * Set the mail body.
      *
-     * @param body
+     * @param body the body of the mail
      */
     public void setMailBody(String body){
         mailBody = body;

Modified: jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SynchronousTransportListener.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SynchronousTransportListener.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SynchronousTransportListener.java (original)
+++ jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SynchronousTransportListener.java Fri Jan  2 17:06:11 2015
@@ -74,8 +74,12 @@ public class SynchronousTransportListene
 
     /**
      * Synchronized-method
+     * <p>
+     * Waits until {@link #finish()} was called and thus the end of the mail
+     * sending was signalled.
      *
      * @throws InterruptedException
+     *             when interrupted while waiting with the lock
      */
     public void attend() throws InterruptedException {
         synchronized(LOCK) {

Modified: jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/config/MongoDBHolder.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/config/MongoDBHolder.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/config/MongoDBHolder.java (original)
+++ jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/config/MongoDBHolder.java Fri Jan  2 17:06:11 2015
@@ -42,8 +42,8 @@ public final class MongoDBHolder {
      * Get access to MongoDB object
      * @param varName String MongoDB source
      * @param dbName Mongo DB database name
-     * @param login
-     * @param password 
+     * @param login name to use for login
+     * @param password password to use for login
      * @return {@link DB}
      */
     public static DB getDBFromSource(String varName, String dbName, String login, String password) {

Modified: jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/sampler/MongoScriptRunner.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/sampler/MongoScriptRunner.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/sampler/MongoScriptRunner.java (original)
+++ jmeter/trunk/src/protocol/mongodb/org/apache/jmeter/protocol/mongodb/sampler/MongoScriptRunner.java Fri Jan  2 17:06:11 2015
@@ -34,11 +34,15 @@ public class MongoScriptRunner {
     }
 
     /**
-     * 
+     * Evaluate a script on the database
+     *
      * @param db
+     *            database connection to use
      * @param script
-     * @return Object
+     *            script to evaluate on the database
+     * @return result of evaluation on the database
      * @throws Exception
+     *             when evaluation on the database fails
      */
     public Object evaluate(DB db, String script)
         throws Exception {

Modified: jmeter/trunk/src/protocol/native/org/apache/jmeter/protocol/system/SystemSampler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/native/org/apache/jmeter/protocol/system/SystemSampler.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/native/org/apache/jmeter/protocol/system/SystemSampler.java (original)
+++ jmeter/trunk/src/protocol/native/org/apache/jmeter/protocol/system/SystemSampler.java Fri Jan  2 17:06:11 2015
@@ -197,13 +197,18 @@ public class SystemSampler extends Abstr
         return APPLIABLE_CONFIG_CLASSES.contains(guiClass);
     }
 
+    /**
+     * @return working directory to use for system commands
+     */
     public String getDirectory() {
         return getPropertyAsString(DIRECTORY, FileServer.getDefaultBase());
     }
-    
+
     /**
+     * Set the working directory to use for system commands
      * 
      * @param directory
+     *            working directory to use for system commands
      */
     public void setDirectory(String directory) {
         setProperty(DIRECTORY, directory, FileServer.getDefaultBase());

Modified: jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/BinaryTCPClientImpl.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/BinaryTCPClientImpl.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/BinaryTCPClientImpl.java (original)
+++ jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/BinaryTCPClientImpl.java Fri Jan  2 17:06:11 2015
@@ -115,7 +115,7 @@ public class BinaryTCPClientImpl extends
      * the end of the stream is reached.
      * Response data is converted to hex-encoded binary
      * @return hex-encoded binary string
-     * @throws ReadException 
+     * @throws ReadException when reading fails
      */
     @Override
     public String read(InputStream is) throws ReadException {

Modified: jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/TCPClient.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/TCPClient.java?rev=1649078&r1=1649077&r2=1649078&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/TCPClient.java (original)
+++ jmeter/trunk/src/protocol/tcp/org/apache/jmeter/protocol/tcp/sampler/TCPClient.java Fri Jan  2 17:06:11 2015
@@ -49,6 +49,7 @@ public interface TCPClient {
      *            OutputStream for socket
      * @param is -
      *            InputStream to be written to Socket
+     * @throws IOException when writing fails
      */
     void write(OutputStream os, InputStream is) throws IOException;
 
@@ -58,6 +59,7 @@ public interface TCPClient {
      *            OutputStream for socket
      * @param s -
      *            String to write
+     * @throws IOException when writing fails
      */
     void write(OutputStream os, String s) throws IOException;
 



Mime
View raw message