Package org.apache.jmeter.protocol.java.sampler

Class AbstractJavaSamplerClient

  • All Implemented Interfaces:
    org.apache.jmeter.protocol.java.sampler.JavaSamplerClient 
    
public abstract class AbstractJavaSamplerClient
 implements JavaSamplerClient

    An abstract implementation of the JavaSamplerClient interface. This implementation provides default implementations of most of the methods in the interface, as well as some convenience methods, in order to simplify development of JavaSamplerClient implementations.

    See org.apache.jmeter.protocol.java.test.SleepTest for an example of how to extend this class.

    While it may be necessary to make changes to the JavaSamplerClient interface from time to time (therefore requiring changes to any implementations of this interface), we intend to make this abstract class provide reasonable implementations of any new methods so that subclasses do not necessarily need to be updated for new versions. Therefore, when creating a new JavaSamplerClient implementation, developers are encouraged to subclass this abstract class rather than implementing the JavaSamplerClient interface directly. Implementing JavaSamplerClient directly will continue to be supported for cases where extending this class is not possible (for example, when the client class is already a subclass of some other class).

    The runTest() method of JavaSamplerClient does not have a default implementation here, so subclasses must define at least this method. It may be useful to override other methods as well.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      void setupTest(JavaSamplerContext context) Do any initialization required by this client.
      void teardownTest(JavaSamplerContext context) Do any clean-up required by this test at the end of a test run.
      Arguments getDefaultParameters() Provide a list of parameters which this test supports.

      • Methods inherited from class org.apache.jmeter.protocol.java.sampler.JavaSamplerClient

        runTest

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AbstractJavaSamplerClient

        AbstractJavaSamplerClient()

    • Method Detail

      • setupTest

         void setupTest(JavaSamplerContext context)

        Do any initialization required by this client. It is generally recommended to do any initialization such as getting parameter values in the setupTest method rather than the runTest method in order to add as little overhead as possible to the test.

        Parameters:
        context - the context to run with.

      • teardownTest

         void teardownTest(JavaSamplerContext context)

        Do any clean-up required by this test at the end of a test run.

        Parameters:
        context - the context to run with.

      • getDefaultParameters

         Arguments getDefaultParameters()

        Provide a list of parameters which this test supports. Any parameter names and associated values returned by this method will appear in the GUI by default so the user doesn't have to remember the exact names. The user can add other parameters which are not listed here. If this method returns null then no parameters will be listed. If the value for some parameter is null then that parameter will be listed in the GUI with an empty value.