Class AbstractBackendListenerClient
java.lang.Object
org.apache.jmeter.visualizers.backend.AbstractBackendListenerClient
- All Implemented Interfaces:
BackendListenerClient
- Direct Known Subclasses:
GraphiteBackendListenerClient
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 BackendListenerClient.handleSampleResults(java.util.List, BackendListenerContext)
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
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateSampleResult
(BackendListenerContext context, SampleResult result) Create a copy of SampleResult, this method is here to allow customizing what is kept in the copy, for example copy could remove some useless fields.Provide a list of parameters which this test supports.protected Logger
Get a Logger instance which can be used by subclasses to log information.protected Map
<String, SamplerMetric> protected final SamplerMetric
getSamplerMetric
(String sampleLabel) protected UserMetric
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.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.jmeter.visualizers.backend.BackendListenerClient
handleSampleResults
-
Constructor Details
-
AbstractBackendListenerClient
public AbstractBackendListenerClient()
-
-
Method Details
-
setupTest
Description copied from interface:BackendListenerClient
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.- Specified by:
setupTest
in interfaceBackendListenerClient
- Parameters:
context
- the context to run with. This provides access to initialization parameters. Context is readonly- Throws:
Exception
- when setup fails
-
teardownTest
Description copied from interface:BackendListenerClient
Do any clean-up required at the end of a test run.- Specified by:
teardownTest
in interfaceBackendListenerClient
- Parameters:
context
- the context to run with. This provides access to initialization parameters.- Throws:
Exception
- when tear down fails
-
getDefaultParameters
Description copied from interface:BackendListenerClient
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.- Specified by:
getDefaultParameters
in interfaceBackendListenerClient
- 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.
-
getLogger
protected Logger getLogger()Get a Logger instance which can be used by subclasses to log information. As this class is designed to be subclassed this is useful.- Returns:
- a Logger instance which can be used for logging
-
createSampleResult
Create a copy of SampleResult, this method is here to allow customizing what is kept in the copy, for example copy could remove some useless fields. Note that if it returns null, the sample result is not put in the queue. Defaults to returning result.- Specified by:
createSampleResult
in interfaceBackendListenerClient
- Parameters:
context
-BackendListenerContext
result
-SampleResult
- Returns:
SampleResult
-
getSamplerMetric
- Parameters:
sampleLabel
- Name of sample used as key- Returns:
SamplerMetric
-
getMetricsPerSampler
- Returns:
- Map where key is SampleLabel and
SamplerMetric
is the metrics of this Sample
-
getUserMetrics
- Returns:
UserMetric
-