AbstractBackendListenerClient 5.6.3 API

All Implemented Interfaces:

org.apache.jmeter.visualizers.backend.BackendListenerClient
```
public abstract class AbstractBackendListenerClient
 implements BackendListenerClient
                    
```
An abstract implementation of the BackendListenerClient 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 BackendListenerClient implementations. While it may be necessary to make changes to the BackendListenerClient 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 BackendListenerClient implementation, developers are encouraged to subclass this abstract class rather than implementing the BackendListenerClient interface directly. Implementing BackendListenerClient 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 handleSampleResults method of BackendListenerClient 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.

Since:

2.13

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`AbstractBackendListenerClient()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`void`	`setupTest(BackendListenerContext context)`	Do any initialization required by this client.
`void`	`teardownTest(BackendListenerContext context)`	Do any clean-up required 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.visualizers.backend.BackendListenerClient
createSampleResult, handleSampleResults
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractBackendListenerClient
```
AbstractBackendListenerClient()
```
- Method Detail
  - setupTest
```
 void setupTest(BackendListenerContext context)
```
    Do any initialization required by this client. It is generally recommended to do any initialization such as getting parameter values here rather than handleSampleResults in order to add as little overhead as possible to the test.
    
    Parameters:
    
    context - provides access to initialization parameters.
  - teardownTest
```
 void teardownTest(BackendListenerContext context)
```
    Do any clean-up required at the end of a test run.
    
    Parameters:
    
    context - provides access to initialization parameters.
  - 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.
    
    Returns:
    
    a specification of the parameters used by this test which should be listed in the GUI, or null if no parameters should be listed.