Class HTTPAbstractImpl
- java.lang.Object
-
- org.apache.jmeter.protocol.http.sampler.HTTPAbstractImpl
-
- All Implemented Interfaces:
HTTPConstantsInterface
,Interruptible
- Direct Known Subclasses:
HTTPFileImpl
,HTTPHCAbstractImpl
,HTTPJavaImpl
public abstract class HTTPAbstractImpl extends Object implements Interruptible, HTTPConstantsInterface
Base class for HTTP implementations used by the HTTPSamplerProxy sampler.
-
-
Field Summary
Fields Modifier and Type Field Description protected HTTPSamplerBase
testElement
-
Fields inherited from interface org.apache.jmeter.protocol.http.util.HTTPConstantsInterface
APPLICATION_X_WWW_FORM_URLENCODED, CACHE_CONTROL, CONNECT, CONNECTION_CLOSE, COPY, DATE, DEFAULT_HTTP_PORT, DEFAULT_HTTP_PORT_STRING, DEFAULT_HTTPS_PORT, DEFAULT_HTTPS_PORT_STRING, DELETE, ENCODING_GZIP, ETAG, EXPIRES, GET, HEAD, HEADER_AUTHORIZATION, HEADER_CONNECTION, HEADER_CONTENT_DISPOSITION, HEADER_CONTENT_ENCODING, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_COOKIE, HEADER_HOST, HEADER_LOCAL_ADDRESS, HEADER_LOCATION, HEADER_SET_COOKIE, HTTP_1_1, IF_MODIFIED_SINCE, IF_NONE_MATCH, KEEP_ALIVE, LAST_MODIFIED, LOCK, MKCALENDAR, MKCOL, MOVE, MULTIPART_FORM_DATA, OPTIONS, PATCH, POST, PROPFIND, PROPPATCH, PROTOCOL_HTTP, PROTOCOL_HTTPS, PUT, REPORT, TRACE, TRANSFER_ENCODING, UNLOCK
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
HTTPAbstractImpl(HTTPSamplerBase testElement)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected HTTPSampleResult
errorResult(Throwable t, HTTPSampleResult res)
Populates the provided HTTPSampleResult with details from the Exception.protected Arguments
getArguments()
InvokesHTTPSamplerBase.getArguments()
protected AuthManager
getAuthManager()
InvokesHTTPSamplerBase.getAuthManager()
protected boolean
getAutoRedirects()
protected CacheManager
getCacheManager()
protected int
getConnectTimeout()
protected String
getContentEncoding()
protected CookieManager
getCookieManager()
protected boolean
getDoBrowserCompatibleMultipart()
protected HeaderManager
getHeaderManager()
protected HTTPFileArg[]
getHTTPFiles()
Get the collection of files as a list.protected String
getIpSource()
InvokesHTTPSamplerBase.getIpSource()
protected InetAddress
getIpSourceAddress()
Gets the IP source address (IP spoofing) if one has been provided.protected String
getProxyHost()
InvokesHTTPSamplerBase.getProxyHost()
protected String
getProxyPass()
InvokesHTTPSamplerBase.getProxyPass()
protected int
getProxyPortInt()
protected String
getProxyUser()
InvokesHTTPSamplerBase.getProxyUser()
protected int
getResponseTimeout()
protected boolean
getSendFileAsPostBody()
Determine whether to send a file as the entire body of an entity enclosing request such as POST, PUT or PATCH.protected boolean
getSendParameterValuesAsPostBody()
Determine whether to send concatenated parameters as the entire body of an entity enclosing request such as POST, PUT or PATCH.protected boolean
getUseKeepAlive()
protected boolean
getUseMultipartForPost()
Determine if we should usemultipart/form-data
orapplication/x-www-form-urlencoded
for the postprotected boolean
hasArguments()
InvokesHTTPSamplerBase.hasArguments()
protected boolean
isMonitor()
InvokesHTTPSamplerBase.isMonitor()
protected boolean
isSuccessCode(int errorLevel)
Determine if the HTTP status code is successful or not i.e. in range 200 to 399 inclusiveprotected void
notifyFirstSampleAfterLoopRestart()
protected void
notifySSLContextWasReset()
Called by testIterationStart if the SSL Context was reset.protected byte[]
readResponse(SampleResult res, BufferedInputStream in, int contentLength)
Read response from the input stream, converting to MD5 digest if the useMD5 property is set.protected byte[]
readResponse(SampleResult res, InputStream instream, int responseContentLength)
Read response from the input stream, converting to MD5 digest if the useMD5 property is set.protected HTTPSampleResult
resultProcessing(boolean areFollowingRedirect, int frameDepth, HTTPSampleResult res)
Follow redirects and download page resources if appropriate. this works, but the container stuff here is what's doing it. followRedirects() is actually doing the work to make sure we have only one container to make this work more naturally, I think this method - sample() - needs to take an HTTPSamplerResult container parameter instead of a boolean:areFollowingRedirect.protected abstract HTTPSampleResult
sample(URL url, String method, boolean areFollowingRedirect, int frameDepth)
protected void
setUseKeepAlive(boolean b)
protected void
threadFinished()
protected HTTPSampleResult
updateSampleResultForResourceInCache(HTTPSampleResult res)
Update HTTPSampleResult for a resource in cache-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.jmeter.samplers.Interruptible
interrupt
-
-
-
-
Field Detail
-
testElement
protected final HTTPSamplerBase testElement
-
-
Constructor Detail
-
HTTPAbstractImpl
protected HTTPAbstractImpl(HTTPSamplerBase testElement)
-
-
Method Detail
-
sample
protected abstract HTTPSampleResult sample(URL url, String method, boolean areFollowingRedirect, int frameDepth)
-
threadFinished
protected void threadFinished()
-
notifyFirstSampleAfterLoopRestart
protected void notifyFirstSampleAfterLoopRestart()
-
errorResult
protected HTTPSampleResult errorResult(Throwable t, HTTPSampleResult res)
Populates the provided HTTPSampleResult with details from the Exception. Does not create a new instance, so should not be used directly to add a subsample.See
HTTPSamplerBase.errorResult(Throwable, HTTPSampleResult)
- Parameters:
t
- Exception representing the error.res
- SampleResult to be modified- Returns:
- the modified sampling result containing details of the Exception. Invokes
-
getArguments
protected Arguments getArguments()
InvokesHTTPSamplerBase.getArguments()
- Returns:
- the arguments of the associated test element
-
getAuthManager
protected AuthManager getAuthManager()
InvokesHTTPSamplerBase.getAuthManager()
- Returns:
- the
AuthManager
of the associated test element
-
getAutoRedirects
protected boolean getAutoRedirects()
- Returns:
- flag whether to do auto redirects
-
getCacheManager
protected CacheManager getCacheManager()
- Returns:
- the
CacheManager
of the associated test element
-
getConnectTimeout
protected int getConnectTimeout()
- Returns:
- the connect timeout of the associated test element
-
getContentEncoding
protected String getContentEncoding()
- Returns:
- the encoding of the content, i.e. its charset name
-
getCookieManager
protected CookieManager getCookieManager()
- Returns:
- the
CookieManager
of the associated test element
-
getHeaderManager
protected HeaderManager getHeaderManager()
- Returns:
- the
HeaderManager
of the associated test element
-
getHTTPFiles
protected HTTPFileArg[] getHTTPFiles()
Get the collection of files as a list. The list is built up from the filename/filefield/mimetype properties, plus any additional entries saved in the FILE_ARGS property.If there are no valid file entries, then an empty list is returned.
Invokes
HTTPSamplerBase.getHTTPFiles()
- Returns:
- an array of file arguments (never
null
)
-
getIpSource
protected String getIpSource()
InvokesHTTPSamplerBase.getIpSource()
- Returns:
- the configured ip source for the associated test element
-
getIpSourceAddress
protected InetAddress getIpSourceAddress() throws UnknownHostException, SocketException
Gets the IP source address (IP spoofing) if one has been provided.- Returns:
- the IP source address to use (or
null
, if none provided or the device address could not be found) - Throws:
UnknownHostException
- if the hostname/ip forgetIpSource()
could not be resolved or not interface was found for itSocketException
- if an I/O error occurs
-
getProxyHost
protected String getProxyHost()
InvokesHTTPSamplerBase.getProxyHost()
- Returns:
- the configured host to use as a proxy
-
getProxyPass
protected String getProxyPass()
InvokesHTTPSamplerBase.getProxyPass()
- Returns:
- the configured password to use for the proxy
-
getProxyPortInt
protected int getProxyPortInt()
- Returns:
- the configured port to use for the proxy
-
getProxyUser
protected String getProxyUser()
InvokesHTTPSamplerBase.getProxyUser()
- Returns:
- the configured user to use for the proxy
-
getResponseTimeout
protected int getResponseTimeout()
- Returns:
- the configured timeout for responses
-
getSendFileAsPostBody
protected boolean getSendFileAsPostBody()
Determine whether to send a file as the entire body of an entity enclosing request such as POST, PUT or PATCH. InvokesHTTPSamplerBase.getSendFileAsPostBody()
- Returns:
- flag whether to send a file as POST, PUT or PATCH
-
getSendParameterValuesAsPostBody
protected boolean getSendParameterValuesAsPostBody()
Determine whether to send concatenated parameters as the entire body of an entity enclosing request such as POST, PUT or PATCH. InvokesHTTPSamplerBase.getSendParameterValuesAsPostBody()
- Returns:
- flag whether to send concatenated parameters as the entire body
-
getUseKeepAlive
protected boolean getUseKeepAlive()
- Returns:
- flag whether to use keep-alive for requests
-
getUseMultipartForPost
protected boolean getUseMultipartForPost()
Determine if we should usemultipart/form-data
orapplication/x-www-form-urlencoded
for the post- Returns:
true
ifmultipart/form-data
should be used and method is POST
-
getDoBrowserCompatibleMultipart
protected boolean getDoBrowserCompatibleMultipart()
- Returns:
- flag whether we should do browser compatible multiparts
-
hasArguments
protected boolean hasArguments()
InvokesHTTPSamplerBase.hasArguments()
- Returns:
- flag whether we have arguments to send
-
isMonitor
protected boolean isMonitor()
InvokesHTTPSamplerBase.isMonitor()
- Returns:
- flag whether monitor is enabled
-
isSuccessCode
protected boolean isSuccessCode(int errorLevel)
Determine if the HTTP status code is successful or not i.e. in range 200 to 399 inclusive- Parameters:
errorLevel
- status code to check- Returns:
- whether in range 200-399 or not
-
readResponse
protected byte[] readResponse(SampleResult res, InputStream instream, int responseContentLength) throws IOException
Read response from the input stream, converting to MD5 digest if the useMD5 property is set.For the MD5 case, the result byte count is set to the size of the original response.
Closes the inputStream
Invokes
HTTPSamplerBase.readResponse(SampleResult, InputStream, int)
- Parameters:
res
- sample to store information about the response intoinstream
- input stream from which to read the responseresponseContentLength
- expected input length or zero- Returns:
- the response or the MD5 of the response
- Throws:
IOException
- if reading the result fails
-
readResponse
protected byte[] readResponse(SampleResult res, BufferedInputStream in, int contentLength) throws IOException
Read response from the input stream, converting to MD5 digest if the useMD5 property is set.For the MD5 case, the result byte count is set to the size of the original response.
Closes the inputStream
Invokes
HTTPSamplerBase.readResponse(SampleResult, InputStream, int)
- Parameters:
res
- sample to store information about the response intoin
- input stream from which to read the responsecontentLength
- expected input length or zero- Returns:
- the response or the MD5 of the response
- Throws:
IOException
- when reading the result fails
-
resultProcessing
protected HTTPSampleResult resultProcessing(boolean areFollowingRedirect, int frameDepth, HTTPSampleResult res)
Follow redirects and download page resources if appropriate. this works, but the container stuff here is what's doing it. followRedirects() is actually doing the work to make sure we have only one container to make this work more naturally, I think this method - sample() - needs to take an HTTPSamplerResult container parameter instead of a boolean:areFollowingRedirect.Invokes
HTTPSamplerBase.resultProcessing(boolean, int, HTTPSampleResult)
- Parameters:
areFollowingRedirect
- flag whether we are getting a redirect targetframeDepth
- Depth of this target in the frame structure. Used only to prevent infinite recursion.res
- sample result to process- Returns:
- the sample result
-
setUseKeepAlive
protected void setUseKeepAlive(boolean b)
- Parameters:
b
- flag whether to use keep-alive for requests
-
notifySSLContextWasReset
protected void notifySSLContextWasReset()
Called by testIterationStart if the SSL Context was reset. This implementation does nothing.
-
updateSampleResultForResourceInCache
protected HTTPSampleResult updateSampleResultForResourceInCache(HTTPSampleResult res)
Update HTTPSampleResult for a resource in cache- Parameters:
res
-HTTPSampleResult
- Returns:
- HTTPSampleResult
-
-