Class BackendListener
- All Implemented Interfaces:
Serializable
,Cloneable
,NoThreadClone
,Searchable
,Remoteable
,SampleListener
,org.apache.jmeter.testelement.TestElement
,TestStateListener
,Backend
BackendListenerClient
- Since:
- 2.13
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.jmeter.testelement.TestElement
org.apache.jmeter.testelement.TestElement.Companion
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Property key representing the arguments for the BackendListenerClient.static final String
Property key representing the classname of the BackendListenerClient to user.static final String
static final String
Queue sizeFields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Get the arguments (parameters) for the BackendListenerClient to be executed with.Gets the Classname of the BackendListenerClient objectGets the queue sizevoid
sampleOccurred
(SampleEvent event) A sample has started and stopped.void
A sample has started.void
A sample has stopped.void
setArguments
(Arguments args) Set the arguments (parameters) for the BackendListenerClient to be executed with.void
setClassname
(String classname) Sets the Classname of the BackendListenerClient objectvoid
setQueueSize
(String queueSize) Sets the queue sizevoid
Called once for all threads after the end of a test.void
Method called at the end of the test.void
Called just before the start of the test from the main engine thread.void
testStarted
(String host) Called just before the start of the test from the main engine thread.Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.jmeter.testelement.TestElement
get, get, get, get, get, get, get, get, get, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getPropertyOrNull, getProps, getSchema, getString, removed, removeProperty, set, set, set, set, set, set, set, set, set
-
Field Details
-
CLASSNAME
Property key representing the classname of the BackendListenerClient to user.- See Also:
-
QUEUE_SIZE
Queue size- See Also:
-
ARGUMENTS
Property key representing the arguments for the BackendListenerClient.- See Also:
-
DEFAULT_QUEUE_SIZE
- See Also:
-
-
Constructor Details
-
BackendListener
public BackendListener()Create a BackendListener.
-
-
Method Details
-
clone
- Specified by:
clone
in interfaceorg.apache.jmeter.testelement.TestElement
- Overrides:
clone
in classAbstractTestElement
-
sampleOccurred
Description copied from interface:SampleListener
A sample has started and stopped.- Specified by:
sampleOccurred
in interfaceSampleListener
- Parameters:
event
- theSampleEvent
that has occurred
-
testStarted
public void testStarted()Description copied from interface:TestStateListener
Called just before the start of the test from the main engine thread. This is before the test elements are cloned. Note that not all the test variables will have been set up at this point.
N.B. testStarted() and testEnded() are called from different threads.
- Specified by:
testStarted
in interfaceTestStateListener
- See Also:
-
testStarted
Description copied from interface:TestStateListener
Called just before the start of the test from the main engine thread. This is before the test elements are cloned. Note that not all the test variables will have been set up at this point.
N.B. testStarted() and testEnded() are called from different threads.
- Specified by:
testStarted
in interfaceTestStateListener
- Parameters:
host
- name of host- See Also:
-
testEnded
Method called at the end of the test. This is called only on one instance of BackendListener. This method will loop through all of the other BackendListenerClients which have been registered (automatically in the constructor) and notify them that the test has ended, allowing the BackendListenerClients to cleanup. Implements TestStateListener.testEnded(String)- Specified by:
testEnded
in interfaceTestStateListener
- Parameters:
host
- name of host- See Also:
-
testEnded
public void testEnded()Description copied from interface:TestStateListener
Called once for all threads after the end of a test. This will use the same element instances as at the start of the test.
N.B. testStarted() and testEnded() are called from different threads.
- Specified by:
testEnded
in interfaceTestStateListener
- See Also:
-
sampleStarted
Description copied from interface:SampleListener
A sample has started.- Specified by:
sampleStarted
in interfaceSampleListener
- Parameters:
e
- theSampleEvent
that has started
-
sampleStopped
Description copied from interface:SampleListener
A sample has stopped.- Specified by:
sampleStopped
in interfaceSampleListener
- Parameters:
e
- theSampleEvent
that has stopped
-
setArguments
Set the arguments (parameters) for the BackendListenerClient to be executed with.- Parameters:
args
- the new arguments. These replace any existing arguments.
-
getArguments
Get the arguments (parameters) for the BackendListenerClient to be executed with.- Returns:
- the arguments
-
setClassname
Sets the Classname of the BackendListenerClient object- Parameters:
classname
- the new Classname value
-
getClassname
Gets the Classname of the BackendListenerClient object- Returns:
- the Classname value
-
setQueueSize
Sets the queue size- Parameters:
queueSize
- the size of the queue
-
getQueueSize
Gets the queue size- Returns:
- int queueSize
-