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 SummaryNested classes/interfaces inherited from interface org.apache.jmeter.testelement.TestElementorg.apache.jmeter.testelement.TestElement.Companion
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringProperty key representing the arguments for the BackendListenerClient.static final StringProperty key representing the classname of the BackendListenerClient to user.static final Stringstatic final StringQueue sizeFields inherited from interface org.apache.jmeter.testelement.TestElementCOMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionclone()Get the arguments (parameters) for the BackendListenerClient to be executed with.Gets the Classname of the BackendListenerClient objectGets the queue sizevoidsampleOccurred(SampleEvent event) A sample has started and stopped.voidA sample has started.voidA sample has stopped.voidsetArguments(Arguments args) Set the arguments (parameters) for the BackendListenerClient to be executed with.voidsetClassname(String classname) Sets the Classname of the BackendListenerClient objectvoidsetQueueSize(String queueSize) Sets the queue sizevoidCalled once for all threads after the end of a test.voidMethod called at the end of the test.voidCalled just before the start of the test from the main engine thread.voidtestStarted(String host) Called just before the start of the test from the main engine thread.Methods inherited from class org.apache.jmeter.testelement.AbstractTestElementaddPropertiesValues, 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, traversePropertyMethods inherited from class java.lang.Objectfinalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.jmeter.testelement.TestElementget, 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- 
CLASSNAMEProperty key representing the classname of the BackendListenerClient to user.- See Also:
 
- 
QUEUE_SIZEQueue size- See Also:
 
- 
ARGUMENTSProperty key representing the arguments for the BackendListenerClient.- See Also:
 
- 
DEFAULT_QUEUE_SIZE- See Also:
 
 
- 
- 
Constructor Details- 
BackendListenerpublic BackendListener()Create a BackendListener.
 
- 
- 
Method Details- 
clone- Specified by:
- clonein interface- org.apache.jmeter.testelement.TestElement
- Overrides:
- clonein class- AbstractTestElement
 
- 
sampleOccurredDescription copied from interface:SampleListenerA sample has started and stopped.- Specified by:
- sampleOccurredin interface- SampleListener
- Parameters:
- event- the- SampleEventthat has occurred
 
- 
testStartedpublic void testStarted()Description copied from interface:TestStateListenerCalled 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:
- testStartedin interface- TestStateListener
- See Also:
 
- 
testStartedDescription copied from interface:TestStateListenerCalled 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:
- testStartedin interface- TestStateListener
- Parameters:
- host- name of host
- See Also:
 
- 
testEndedMethod 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:
- testEndedin interface- TestStateListener
- Parameters:
- host- name of host
- See Also:
 
- 
testEndedpublic void testEnded()Description copied from interface:TestStateListenerCalled 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:
- testEndedin interface- TestStateListener
- See Also:
 
- 
sampleStartedDescription copied from interface:SampleListenerA sample has started.- Specified by:
- sampleStartedin interface- SampleListener
- Parameters:
- e- the- SampleEventthat has started
 
- 
sampleStoppedDescription copied from interface:SampleListenerA sample has stopped.- Specified by:
- sampleStoppedin interface- SampleListener
- Parameters:
- e- the- SampleEventthat has stopped
 
- 
setArgumentsSet the arguments (parameters) for the BackendListenerClient to be executed with.- Parameters:
- args- the new arguments. These replace any existing arguments.
 
- 
getArgumentsGet the arguments (parameters) for the BackendListenerClient to be executed with.- Returns:
- the arguments
 
- 
setClassnameSets the Classname of the BackendListenerClient object- Parameters:
- classname- the new Classname value
 
- 
getClassnameGets the Classname of the BackendListenerClient object- Returns:
- the Classname value
 
- 
setQueueSizeSets the queue size- Parameters:
- queueSize- the size of the queue
 
- 
getQueueSizeGets the queue size- Returns:
- int queueSize
 
 
-