Package org.apache.jmeter.samplers
Class SampleResult
java.lang.Object
org.apache.jmeter.samplers.SampleResult
- All Implemented Interfaces:
Serializable
,Cloneable
- Direct Known Subclasses:
HTTPSampleResult
,StatisticalSampleResult
This is a nice packaging for the various information returned from taking a
sample of an entry.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Data type value indicating that the response data is binary.protected static final String
The default encoding to be used to decode the responseData byte array.static final String
The default encoding to be used if not overridden.static final byte[]
empty array which can be returned instead of nullstatic final String
Data type value indicating that the response data is text. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
SampleResult
(long elapsed, boolean atend) Create a sample with a specific elapsed time but don't allow the times to be changed later (only used by HTTPSampleResult)SampleResult
(long stamp, long elapsed) Allow users to create a sample with specific timestamp and elapsed times for cloning purposes, but don't allow the times to be changed later Currently used by OldSaveService, CSVSaveService and StatisticalSampleResultSampleResult
(SampleResult res) Copy constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAssertionResult
(AssertionResult assertResult) void
addRawSubResult
(SampleResult subResult) Add a subresult to the collection without updating any parent fields.void
addSubResult
(SampleResult subResult) Add a subresult and adjust the parent byte count and end-time.void
Clean up cached dataclone()
void
Set the time to the end of connectingstatic SampleResult
createTestSample
(long elapsed) Create a sample with a specific elapsed time for test purposes, but don't allow the times to be changed laterstatic SampleResult
createTestSample
(long start, long end) Create a sample with specific start and end times for test purposes, but don't allow the times to be changed later (used by StatVisualizerModel.Test)long
Helper method to get 1 ms resolution timing.int
Gets the assertion results associated with this sample.int
int
getBytes()
return the bytes returned by the response.long
Returns the dataEncoding.Returns the dataEncoding or the default if no dataEncoding was provided.protected String
getDataEncodingWithDefault
(String defaultEncoding) Returns the dataEncoding or the default if no dataEncoding was provided.long
int
Returns the count of errors.int
int
Get the headers size in byteslong
long
Get the media type from the Content Typebyte[]
Gets the responseData attribute of the SampleResult object.Gets the responseData of the SampleResult object as a Stringint
return the sample count. by default, the value is 1.getSampleLabel
(boolean includeGroup) Get the sample label for use in summary reports etc.long
Gets the subresults associated with this sample.long
getTime()
Get the time it took this sample to occur.long
Get the sample timestamp, which may be either the start time or the end time.getURL()
Get a String representation of the URL (if defined).boolean
If the sampler is a monitor, method will return true.boolean
boolean
boolean
boolean
boolean
boolean
boolean
void
Set the time to the first responseboolean
Set the "marked" flag to show that the result has been written to the file.void
Allow custom SampleSenders to drop unwanted assertionResultsvoid
Allow custom SampleSenders to drop unwanted subResultsvoid
Record the end time of a sample and calculate the elapsed timevoid
Pause a samplevoid
Resume a samplevoid
Record the start time of a samplevoid
setAllThreads
(int n) void
setBodySize
(int bodySize) void
setBytes
(int length) In the event the sampler does want to pass back the actual contents, we still want to calculate the throughput.void
setConnectTime
(long time) This is only intended for use by SampleResultConverter!void
setContentType
(String string) Stores the content-type string, e.g.void
setDataEncoding
(String dataEncoding) Sets the dataEncoding.void
setDataType
(String dataType) void
Extract and save the DataEncoding and DataType from the parameter provided.void
setEndTime
(long end) void
setErrorCount
(int i) void
setGroupThreads
(int n) void
setHeadersSize
(int size) Set the headers size in bytesvoid
setIdleTime
(long idle) Set idle time pause.void
setLatency
(long latency) This is only intended for use by SampleResultConverter!void
setMonitor
(boolean monitor) When a Sampler is working as a monitorvoid
setParent
(SampleResult parent) void
setRequestHeaders
(String string) void
setResponseCode
(String code) void
Set response code to OK, i.e. "200"void
setResponseData
(byte[] response) Sets the responseData attribute of the SampleResult object.void
setResponseData
(String response) Deprecated.- only intended for use from BeanShell codevoid
setResponseData
(String response, String encoding) Sets the encoding and responseData attributes of the SampleResult object.void
setResponseHeaders
(String string) void
setResponseMessage
(String msg) void
void
Set result statuses OK - shorthand method to set: ResponseCode ResponseMessage Successful statusvoid
setResultFileName
(String resultFileName) void
setSampleCount
(int count) The statistical sample sender aggregates several samples to save on transmission costs.void
setSampleLabel
(String label) void
void
setSaveConfig
(SampleSaveConfiguration propertiesToSave) void
setStampAndTime
(long stamp, long elapsed) For use by SaveService only.void
setStartNextThreadLoop
(boolean startNextThreadLoop) protected final void
setStartTime
(long start) void
setStopTest
(boolean b) void
setStopTestNow
(boolean b) void
setStopThread
(boolean b) void
setSuccessful
(boolean success) Sets the successful attribute of the SampleResult object.void
setThreadName
(String threadName) void
setTimeStamp
(long timeStamp) This is only intended for use by SampleResultConverter!void
void
storeSubResult
(SampleResult subResult) Add a subresult read from a results file.toString()
Returns the display name.
-
Field Details
-
DEFAULT_HTTP_ENCODING
The default encoding to be used if not overridden. The value is ISO-8859-1.- See Also:
-
DEFAULT_ENCODING
The default encoding to be used to decode the responseData byte array. The value is defined by the property "sampleresult.default.encoding" with a default of DEFAULT_HTTP_ENCODING if that is not defined. -
TEXT
Data type value indicating that the response data is text. -
BINARY
Data type value indicating that the response data is binary. -
EMPTY_BA
public static final byte[] EMPTY_BAempty array which can be returned instead of null
-
-
Constructor Details
-
SampleResult
public SampleResult() -
SampleResult
Copy constructor.- Parameters:
res
- existing sample result
-
SampleResult
protected SampleResult(long elapsed, boolean atend) Create a sample with a specific elapsed time but don't allow the times to be changed later (only used by HTTPSampleResult)- Parameters:
elapsed
- timeatend
- create the sample finishing now, else starting now
-
SampleResult
public SampleResult(long stamp, long elapsed) Allow users to create a sample with specific timestamp and elapsed times for cloning purposes, but don't allow the times to be changed later Currently used by OldSaveService, CSVSaveService and StatisticalSampleResult- Parameters:
stamp
- this may be a start time or an end time (both in milliseconds)elapsed
- time in milliseconds
-
-
Method Details
-
setSaveConfig
- Parameters:
propertiesToSave
- The propertiesToSave to set.
-
getSaveConfig
-
isStampedAtStart
public boolean isStampedAtStart() -
createTestSample
Create a sample with specific start and end times for test purposes, but don't allow the times to be changed later (used by StatVisualizerModel.Test)- Parameters:
start
- start time in milliseconds since unix epochend
- end time in milliseconds since unix epoch- Returns:
- sample with given start and end time
-
createTestSample
Create a sample with a specific elapsed time for test purposes, but don't allow the times to be changed later- Parameters:
elapsed
- - desired elapsed time in milliseconds- Returns:
- sample that starts 'now' and ends
elapsed
milliseconds later
-
currentTimeInMillis
public long currentTimeInMillis()Helper method to get 1 ms resolution timing.- Returns:
- the current time in milliseconds
- Throws:
RuntimeException
- whenuseNanoTime
istrue
butnanoTimeOffset
is not set
-
setStampAndTime
public void setStampAndTime(long stamp, long elapsed) For use by SaveService only.- Parameters:
stamp
- this may be a start time or an end time (both in milliseconds)elapsed
- time in milliseconds- Throws:
RuntimeException
- whenstartTime
orendTime
has been set already
-
markFile
Set the "marked" flag to show that the result has been written to the file.- Parameters:
filename
- the name of the file- Returns:
true
if the result was previously marked
-
getResponseCode
-
setResponseCodeOK
public void setResponseCodeOK()Set response code to OK, i.e. "200" -
setResponseCode
-
isResponseCodeOK
public boolean isResponseCodeOK() -
getResponseMessage
-
setResponseMessage
-
setResponseMessageOK
public void setResponseMessageOK() -
setResponseOK
public void setResponseOK()Set result statuses OK - shorthand method to set:- ResponseCode
- ResponseMessage
- Successful status
-
getThreadName
-
setThreadName
-
getTimeStamp
public long getTimeStamp()Get the sample timestamp, which may be either the start time or the end time.- Returns:
- timeStamp in milliseconds
- See Also:
-
getSampleLabel
-
getSampleLabel
Get the sample label for use in summary reports etc.- Parameters:
includeGroup
- whether to include the thread group name- Returns:
- the label
-
setSampleLabel
-
addAssertionResult
-
getAssertionResults
Gets the assertion results associated with this sample.- Returns:
- an array containing the assertion results for this sample. Returns empty array if there are no assertion results.
-
addSubResult
Add a subresult and adjust the parent byte count and end-time.- Parameters:
subResult
- theSampleResult
to be added
-
addRawSubResult
Add a subresult to the collection without updating any parent fields.- Parameters:
subResult
- theSampleResult
to be added
-
storeSubResult
Add a subresult read from a results file.As for
addSubResult(SampleResult)
, except that the fields don't need to be accumulated- Parameters:
subResult
- theSampleResult
to be added
-
getSubResults
Gets the subresults associated with this sample.- Returns:
- an array containing the subresults for this sample. Returns an empty array if there are no subresults.
-
setResponseData
public void setResponseData(byte[] response) Sets the responseData attribute of the SampleResult object. If the parameter is null, then the responseData is set to an empty byte array. This ensures that getResponseData() can never be null.- Parameters:
response
- the new responseData value
-
setResponseData
Deprecated.- only intended for use from BeanShell codeSets the responseData attribute of the SampleResult object. Should only be called after setting the dataEncoding (if necessary)- Parameters:
response
- the new responseData value (String)
-
setResponseData
Sets the encoding and responseData attributes of the SampleResult object.- Parameters:
response
- the new responseData value (String)encoding
- the encoding to set and then use (if null, use platform default)
-
getResponseData
public byte[] getResponseData()Gets the responseData attribute of the SampleResult object.Note that some samplers may not store all the data, in which case getResponseData().length will be incorrect. Instead, always use
getBytes()
to obtain the sample result byte count.- Returns:
- the responseData value (cannot be null)
-
getResponseDataAsString
Gets the responseData of the SampleResult object as a String- Returns:
- the responseData value as a String, converted according to the encoding
-
setSamplerData
-
getSamplerData
-
getTime
public long getTime()Get the time it took this sample to occur.- Returns:
- elapsed time in milliseonds
-
isSuccessful
public boolean isSuccessful() -
setDataType
-
getDataType
-
setEncodingAndType
Extract and save the DataEncoding and DataType from the parameter provided. Does not save the full content Type.- Parameters:
ct
- - content type (may be null)- See Also:
-
setSuccessful
public void setSuccessful(boolean success) Sets the successful attribute of the SampleResult object.- Parameters:
success
- the new successful value
-
toString
Returns the display name. -
getDataEncodingWithDefault
Returns the dataEncoding or the default if no dataEncoding was provided.- Returns:
- the value of the dataEncoding or DEFAULT_ENCODING
-
getDataEncodingWithDefault
Returns the dataEncoding or the default if no dataEncoding was provided.- Parameters:
defaultEncoding
- the default to be applied- Returns:
- the value of the dataEncoding or the provided default
-
getDataEncodingNoDefault
Returns the dataEncoding. May be null or the empty String.- Returns:
- the value of the dataEncoding
-
setDataEncoding
Sets the dataEncoding.- Parameters:
dataEncoding
- the dataEncoding to set, e.g. ISO-8895-1, UTF-8
-
isStopTest
public boolean isStopTest()- Returns:
- whether to stop the test
-
isStopTestNow
public boolean isStopTestNow()- Returns:
- whether to stop the test now
-
isStopThread
public boolean isStopThread()- Returns:
- whether to stop this thread
-
setStopTest
public void setStopTest(boolean b) -
setStopTestNow
public void setStopTestNow(boolean b) -
setStopThread
public void setStopThread(boolean b) -
getRequestHeaders
- Returns:
- the request headers
-
getResponseHeaders
- Returns:
- the response headers
-
setRequestHeaders
- Parameters:
string
- - request headers
-
setResponseHeaders
- Parameters:
string
- - response headers
-
getContentType
- Returns:
- the full content type - e.g. text/html [;charset=utf-8 ]
-
getMediaType
Get the media type from the Content Type- Returns:
- the media type - e.g. text/html (without charset, if any)
-
setContentType
Stores the content-type string, e.g.text/xml; charset=utf-8
- Parameters:
string
- the content-type to be set- See Also:
-
getIdleTime
public long getIdleTime()- Returns:
- idleTime
-
getEndTime
public long getEndTime()- Returns:
- the end time
-
getStartTime
public long getStartTime()- Returns:
- the start time
-
setStartTime
protected final void setStartTime(long start) -
setEndTime
public void setEndTime(long end) -
setIdleTime
public void setIdleTime(long idle) Set idle time pause. For use by SampleResultConverter/CSVSaveService.- Parameters:
idle
- long
-
sampleStart
public void sampleStart()Record the start time of a sample -
sampleEnd
public void sampleEnd()Record the end time of a sample and calculate the elapsed time -
samplePause
public void samplePause()Pause a sample -
sampleResume
public void sampleResume()Resume a sample -
setMonitor
public void setMonitor(boolean monitor) When a Sampler is working as a monitor- Parameters:
monitor
- flag whether this sampler is working as a monitor
-
isMonitor
public boolean isMonitor()If the sampler is a monitor, method will return true.- Returns:
- true if the sampler is a monitor
-
setSampleCount
public void setSampleCount(int count) The statistical sample sender aggregates several samples to save on transmission costs.- Parameters:
count
- number of samples represented by this instance
-
getSampleCount
public int getSampleCount()return the sample count. by default, the value is 1.- Returns:
- the sample count
-
getErrorCount
public int getErrorCount()Returns the count of errors.- Returns:
- 0 - or 1 if the sample failed TODO do we need allow for nested samples?
-
setErrorCount
public void setErrorCount(int i) -
setBytes
public void setBytes(int length) In the event the sampler does want to pass back the actual contents, we still want to calculate the throughput. The bytes are the bytes of the response data.- Parameters:
length
- the number of bytes of the response data for this sample
-
getBytes
public int getBytes()return the bytes returned by the response.- Returns:
- byte count
-
getLatency
public long getLatency()- Returns:
- Returns the latency.
-
latencyEnd
public void latencyEnd()Set the time to the first response -
setLatency
public void setLatency(long latency) This is only intended for use by SampleResultConverter!- Parameters:
latency
- The latency to set.
-
getConnectTime
public long getConnectTime()- Returns:
- Returns the connect time.
-
connectEnd
public void connectEnd()Set the time to the end of connecting -
setConnectTime
public void setConnectTime(long time) This is only intended for use by SampleResultConverter!- Parameters:
time
- The connect time to set.
-
setTimeStamp
public void setTimeStamp(long timeStamp) This is only intended for use by SampleResultConverter!- Parameters:
timeStamp
- The timeStamp to set.
-
setURL
-
getURL
-
getUrlAsString
Get a String representation of the URL (if defined).- Returns:
- ExternalForm of URL, or empty string if url is null
-
getParent
- Returns:
- Returns the parent.
-
setParent
- Parameters:
parent
- The parent to set.
-
getResultFileName
-
setResultFileName
-
getGroupThreads
public int getGroupThreads() -
setGroupThreads
public void setGroupThreads(int n) -
getAllThreads
public int getAllThreads() -
setAllThreads
public void setAllThreads(int n) -
removeAssertionResults
public void removeAssertionResults()Allow custom SampleSenders to drop unwanted assertionResults -
removeSubResults
public void removeSubResults()Allow custom SampleSenders to drop unwanted subResults -
setHeadersSize
public void setHeadersSize(int size) Set the headers size in bytes- Parameters:
size
- the number of bytes of the header
-
getHeadersSize
public int getHeadersSize()Get the headers size in bytes- Returns:
- the headers size
-
getBodySize
public int getBodySize()- Returns:
- the body size in bytes
-
setBodySize
public void setBodySize(int bodySize) - Parameters:
bodySize
- the body size to set
-
isStartNextThreadLoop
public boolean isStartNextThreadLoop()- Returns:
- the startNextThreadLoop
-
setStartNextThreadLoop
public void setStartNextThreadLoop(boolean startNextThreadLoop) - Parameters:
startNextThreadLoop
- the startNextLoop to set
-
cleanAfterSample
public void cleanAfterSample()Clean up cached data -
clone
-