org.apache.jmeter.visualizers.backend

Class BackendListener

java.lang.Object

org.apache.jmeter.testelement.AbstractTestElement

org.apache.jmeter.visualizers.backend.BackendListener

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.apache.jmeter.engine.util.NoThreadClone, org.apache.jmeter.gui.Searchable, org.apache.jmeter.samplers.Remoteable, org.apache.jmeter.samplers.SampleListener, org.apache.jmeter.testelement.TestElement, org.apache.jmeter.testelement.TestStateListener, org.apache.jmeter.visualizers.backend.Backend

public class BackendListener
extends org.apache.jmeter.testelement.AbstractTestElement
implements org.apache.jmeter.visualizers.backend.Backend, java.io.Serializable, org.apache.jmeter.samplers.SampleListener, org.apache.jmeter.testelement.TestStateListener, org.apache.jmeter.engine.util.NoThreadClone, org.apache.jmeter.samplers.Remoteable

Async Listener that delegates SampleResult handling to implementations of BackendListenerClient

Since:

2.13

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARGUMENTS Property key representing the arguments for the BackendListenerClient.
static java.lang.String	CLASSNAME Property key representing the classname of the BackendListenerClient to user.
static java.lang.String	DEFAULT_QUEUE_SIZE
static java.lang.String	QUEUE_SIZE Queue size

Fields inherited from interface org.apache.jmeter.testelement.TestElement

COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS

Constructor Summary

Constructors

Constructor and Description
BackendListener() Create a BackendListener.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
org.apache.jmeter.config.Arguments	getArguments() Get the arguments (parameters) for the BackendListenerClient to be executed with.
java.lang.String	getClassname() Gets the Classname of the BackendListenerClient object
java.lang.String	getQueueSize() Gets the queue size
void	sampleOccurred(org.apache.jmeter.samplers.SampleEvent event)
void	sampleStarted(org.apache.jmeter.samplers.SampleEvent e)
void	sampleStopped(org.apache.jmeter.samplers.SampleEvent e)
void	setArguments(org.apache.jmeter.config.Arguments args) Set the arguments (parameters) for the BackendListenerClient to be executed with.
void	setClassname(java.lang.String classname) Sets the Classname of the BackendListenerClient object
void	setQueueSize(java.lang.String queueSize) Sets the queue size
void	testEnded()
void	testEnded(java.lang.String host) Method called at the end of the test.
void	testStarted()
void	testStarted(java.lang.String host)

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, 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

removed

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

Property key representing the classname of the BackendListenerClient to user.

See Also:

Constant Field Values

QUEUE_SIZE

public static final java.lang.String QUEUE_SIZE

Queue size

See Also:

Constant Field Values

ARGUMENTS

public static final java.lang.String ARGUMENTS

Property key representing the arguments for the BackendListenerClient.

See Also:

Constant Field Values

DEFAULT_QUEUE_SIZE

public static final java.lang.String DEFAULT_QUEUE_SIZE

See Also:

Constant Field Values

Constructor Detail

BackendListener

public BackendListener()

Create a BackendListener.

Method Detail

clone

public java.lang.Object clone()

Specified by:

clone in interface org.apache.jmeter.testelement.TestElement

Overrides:

clone in class org.apache.jmeter.testelement.AbstractTestElement

sampleOccurred

public void sampleOccurred(org.apache.jmeter.samplers.SampleEvent event)

Specified by:

sampleOccurred in interface org.apache.jmeter.samplers.SampleListener

testStarted

public void testStarted()

Specified by:

testStarted in interface org.apache.jmeter.testelement.TestStateListener

testStarted

public void testStarted(java.lang.String host)

Specified by:

testStarted in interface org.apache.jmeter.testelement.TestStateListener

testEnded

public void testEnded(java.lang.String host)

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 interface org.apache.jmeter.testelement.TestStateListener

testEnded

public void testEnded()

Specified by:

testEnded in interface org.apache.jmeter.testelement.TestStateListener

sampleStarted

public void sampleStarted(org.apache.jmeter.samplers.SampleEvent e)

Specified by:

sampleStarted in interface org.apache.jmeter.samplers.SampleListener

sampleStopped

public void sampleStopped(org.apache.jmeter.samplers.SampleEvent e)

Specified by:

sampleStopped in interface org.apache.jmeter.samplers.SampleListener

setArguments

public void setArguments(org.apache.jmeter.config.Arguments args)

Set the arguments (parameters) for the BackendListenerClient to be executed with.

Parameters:

args - the new arguments. These replace any existing arguments.

getArguments

public org.apache.jmeter.config.Arguments getArguments()

Get the arguments (parameters) for the BackendListenerClient to be executed with.

Returns:

the arguments

setClassname

public void setClassname(java.lang.String classname)

Sets the Classname of the BackendListenerClient object

Parameters:

classname - the new Classname value

getClassname

public java.lang.String getClassname()

Gets the Classname of the BackendListenerClient object

Returns:

the Classname value

setQueueSize

public void setQueueSize(java.lang.String queueSize)

Sets the queue size

Parameters:

queueSize - the size of the queue

getQueueSize

public java.lang.String getQueueSize()

Gets the queue size

Returns:

int queueSize