Class ResultCollector
- All Implemented Interfaces:
Serializable,Cloneable,NoThreadClone,Searchable,Clearable,Remoteable,SampleListener,org.apache.jmeter.testelement.TestElement,TestStateListener
- Direct Known Subclasses:
MailerResultCollector
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.jmeter.testelement.TestElement
org.apache.jmeter.testelement.TestElement.Companion -
Field Summary
FieldsFields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS -
Constructor Summary
ConstructorsConstructorDescriptionNo-arg constructor.ResultCollector(Summariser summer) Constructor which sets the usedSummariser -
Method Summary
Modifier and TypeMethodDescriptionvoidClears the current data of the object.clone()voidFlush PrintWriter to synchronize file contentsGet the filename of the file this collector usesbooleanGet the state of error loggingbooleanisSampleWanted(boolean success) Decides whether or not to a sample is wanted based on: errorOnly successOnly sample success Should only be called for single samples.static booleanisSampleWanted(boolean success, boolean errorOnly, boolean successOnly) Decides whether or not to a sample is wanted based on: errorOnly successOnly sample success This version is intended to be called by code that loops over many samples; it is cheaper than fetching the settings each time.booleanGet the state of successful only loggingvoidLoads an existing sample data (JTL) file.voidsampleOccurred(SampleEvent event) When a test result is received, display it and save it.voidA sample has started.voidA sample has stopped.protected final voidfinal voidsetErrorLogging(boolean errorLogging) Sets error logging flagvoidSets the filename attribute of the ResultCollector object.voidsetSaveConfig(SampleSaveConfiguration saveConfig) final voidsetSuccessOnlyLogging(boolean value) Sets the flag whether only successful samples should be loggedvoidCalled once for all threads after the end of a test.voidCalled once for all threads after the end of a 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.reporters.AbstractListenerElement
getVisualizer, setListenerMethods 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, traversePropertyMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods 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
-
FILENAME
- See Also:
-
-
Constructor Details
-
ResultCollector
public ResultCollector()No-arg constructor. -
ResultCollector
Constructor which sets the usedSummariser- Parameters:
summer- TheSummariserto use
-
-
Method Details
-
clone
- Specified by:
clonein interfaceorg.apache.jmeter.testelement.TestElement- Overrides:
clonein classAbstractListenerElement
-
getFilename
Get the filename of the file this collector uses- Returns:
- The name of the file
-
isErrorLogging
public boolean isErrorLogging()Get the state of error logging- Returns:
- Flag whether errors should be logged
-
setErrorLogging
public final void setErrorLogging(boolean errorLogging) Sets error logging flag- Parameters:
errorLogging- The flag whether errors should be logged
-
setSuccessOnlyLogging
public final void setSuccessOnlyLogging(boolean value) Sets the flag whether only successful samples should be logged- Parameters:
value- The flag whether only successful samples should be logged
-
isSuccessOnlyLogging
public boolean isSuccessOnlyLogging()Get the state of successful only logging- Returns:
- Flag whether only successful samples should be logged
-
isSampleWanted
public boolean isSampleWanted(boolean success) Decides whether or not to a sample is wanted based on:- errorOnly
- successOnly
- sample success
- Parameters:
success- is sample successful- Returns:
- whether to log/display the sample
-
isSampleWanted
public static boolean isSampleWanted(boolean success, boolean errorOnly, boolean successOnly) Decides whether or not to a sample is wanted based on:- errorOnly
- successOnly
- sample success
- Parameters:
success- status of sampleerrorOnly- if errors only wantedsuccessOnly- if success only wanted- Returns:
- whether to log/display the sample
-
setFilename
Sets the filename attribute of the ResultCollector object.- Parameters:
f- the new filename value
-
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 interfaceTestStateListener- Parameters:
host- name of host- See Also:
-
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 interfaceTestStateListener- Parameters:
host- name of host- See Also:
-
testEnded
public 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 interfaceTestStateListener- See Also:
-
testStarted
public 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 interfaceTestStateListener- See Also:
-
loadExistingFile
public void loadExistingFile()Loads an existing sample data (JTL) file. This can be one of:- XStream format
- CSV format
-
sampleStarted
Description copied from interface:SampleListenerA sample has started.- Specified by:
sampleStartedin interfaceSampleListener- Parameters:
e- theSampleEventthat has started
-
sampleStopped
Description copied from interface:SampleListenerA sample has stopped.- Specified by:
sampleStoppedin interfaceSampleListener- Parameters:
e- theSampleEventthat has stopped
-
sampleOccurred
When a test result is received, display it and save it.- Specified by:
sampleOccurredin interfaceSampleListener- Parameters:
event- the sample event that was received
-
sendToVisualizer
-
flushFile
public void flushFile()Flush PrintWriter to synchronize file contents -
getSaveConfig
- Returns:
- Returns the saveConfig.
-
setSaveConfig
- Parameters:
saveConfig- The saveConfig to set.
-
clearData
public void clearData()Description copied from interface:ClearableClears the current data of the object.
-