public interface HTTPUtilities
HTTPPluginControl.getHTTPUtilities()
Modifier and Type | Method and Description |
---|---|
NVPair |
basicAuthorizationHeader(java.lang.String userID,
java.lang.String password)
Create a
NVPair for an HTTP Basic Authorization header. |
HTTPResponse |
getLastResponse()
Return the response for the last request made by the calling worker thread.
|
java.lang.String |
valueFromBodyInput(java.lang.String tokenName)
Return the value for an input token with the given
tokenName in the
body of the last response. |
java.lang.String |
valueFromBodyInput(java.lang.String tokenName,
java.lang.String afterText)
Return the value for an input token with the given
tokenName in the
body of the last response. |
java.lang.String |
valueFromBodyURI(java.lang.String tokenName)
Return the value for a path parameter or query string name-value token with
the given
tokenName in a URI in the body of the last
response. |
java.lang.String |
valueFromBodyURI(java.lang.String tokenName,
java.lang.String afterText)
Return the value for a path parameter or query string name-value token with
the given
tokenName in a URI in the body of the last
response. |
java.lang.String |
valueFromHiddenInput(java.lang.String tokenName)
Return the value for a hidden input token with the given
tokenName in the body of the last response. |
java.lang.String |
valueFromHiddenInput(java.lang.String tokenName,
java.lang.String afterText)
Return the value for a hidden input token with the given
tokenName in the body of the last response. |
java.lang.String |
valueFromLocationURI(java.lang.String tokenName)
Return the value for a path parameter or query string name-value token with
the given
tokenName in a Location header from the last
response. |
java.util.List<java.lang.String> |
valuesFromBodyInput(java.lang.String tokenName)
Return all matching values for input tokens with the given
tokenName in the body of the last response. |
java.util.List<java.lang.String> |
valuesFromBodyInput(java.lang.String tokenName,
java.lang.String afterText)
Return all matching values for input tokens with the given
tokenName in the body of the last response. |
java.util.List<java.lang.String> |
valuesFromBodyURI(java.lang.String tokenName)
Return all matching values for path parameters or query string name-value
tokens with the given
tokenName in a URI in the body of the
last response. |
java.util.List<java.lang.String> |
valuesFromBodyURI(java.lang.String tokenName,
java.lang.String afterText)
Return all matching values for path parameters or query string name-value
tokens with the given
tokenName in a URI in the body of the
last response. |
java.util.List<java.lang.String> |
valuesFromHiddenInput(java.lang.String tokenName)
Return all matching values for hidden input tokens with the given
tokenName in the body of the last response. |
java.util.List<java.lang.String> |
valuesFromHiddenInput(java.lang.String tokenName,
java.lang.String afterText)
Return all matching values for hidden input tokens with the given
tokenName in the body of the last response. |
NVPair basicAuthorizationHeader(java.lang.String userID, java.lang.String password)
NVPair
for an HTTP Basic Authorization header.userID
- The user name.password
- The password.HTTPRequest
.HTTPResponse getLastResponse() throws GrinderException
null
if the calling thread has not
made any requests.GrinderException
- If not called from a worker thread.java.lang.String valueFromLocationURI(java.lang.String tokenName) throws GrinderException
tokenName
in a Location header from the last
response. If there are multiple matches, the first value is returned.
If there is no match, an empty string is returned rather than
null
. This makes scripts more robust (as they don't need to
check the value before using it), but they lose the ability to distinguish
between a missing token and an empty value.
tokenName
- The token name.GrinderException
- If not called from a worker thread.java.lang.String valueFromBodyInput(java.lang.String tokenName) throws GrinderException
tokenName
in the
body of the last response. If there are multiple matches, the first value
is returned.
If there is no match, an empty string is returned rather than null
.
This makes scripts more robust (as they don't need to check the value
before using it), but they lose the ability to distinguish between a
missing token and an empty value.
tokenName
- The token name.GrinderException
- If not called from a worker thread.valueFromBodyInput(String, String)
,
valuesFromBodyInput(String)
java.lang.String valueFromBodyInput(java.lang.String tokenName, java.lang.String afterText) throws GrinderException
tokenName
in the
body of the last response. If there are multiple matches, the first value
is returned. This version of valueFromBodyInput
only considers
matches following the first occurrence of the literal text afterText
. If there are multiple matches, the first value is returned.
If there is no match, an empty string is returned rather than null
.
This makes scripts more robust (as they don't need to check the value
before using it), but they lose the ability to distinguish between a
missing token and an empty value.
tokenName
- The token name.afterText
- The search begins after the first occurrence of this literal text.afterText
followed by a URI containing a
token with name tokenName
.GrinderException
- If not called from a worker thread.valueFromBodyInput(String)
,
valuesFromBodyInput(String, String)
java.util.List<java.lang.String> valuesFromBodyInput(java.lang.String tokenName) throws GrinderException
tokenName
in the body of the last response.tokenName
- The token name.GrinderException
- If not called from a worker thread.valueFromBodyInput(String)
,
valuesFromBodyInput(String, String)
java.util.List<java.lang.String> valuesFromBodyInput(java.lang.String tokenName, java.lang.String afterText) throws GrinderException
tokenName
in the body of the last response. This version of valueFromBodyInput
only considers matches following the first occurrence
of the literal text afterText
.tokenName
- The token name.afterText
- The search begins after the first occurrence of this literal text.GrinderException
- If not called from a worker thread.valuesFromBodyInput(String)
,
valueFromBodyInput(String, String)
java.lang.String valueFromHiddenInput(java.lang.String tokenName) throws GrinderException
tokenName
in the body of the last response. If there are
multiple matches, the first value is returned.
If there is no match, an empty string is returned rather than
null
. This makes scripts more robust (as they don't need to
check the value before using it), but they lose the ability to distinguish
between a missing token and an empty value.
tokenName
- The token name.GrinderException
- If not called from a worker thread.valueFromHiddenInput(String, String)
,
valuesFromHiddenInput(String)
java.lang.String valueFromHiddenInput(java.lang.String tokenName, java.lang.String afterText) throws GrinderException
tokenName
in the body of the last response. If there are
multiple matches, the first value is returned. This version of
valueFromHiddenInput
only considers matches following the
first occurrence of the literal text afterText
. If there
are multiple matches, the first value is returned.
If there is no match, an empty string is returned rather than
null
. This makes scripts more robust (as they don't need to
check the value before using it), but they lose the ability to distinguish
between a missing token and an empty value.
tokenName
- The token name.afterText
- The search begins after the first occurrence of this literal text.afterText
followed by a URI
containing a token with name tokenName
.GrinderException
- If not called from a worker thread.valueFromHiddenInput(String)
,
valuesFromHiddenInput(String, String)
java.util.List<java.lang.String> valuesFromHiddenInput(java.lang.String tokenName) throws GrinderException
tokenName
in the body of the last response.tokenName
- The token name.GrinderException
- If not called from a worker thread.valueFromHiddenInput(String)
,
valuesFromHiddenInput(String, String)
java.util.List<java.lang.String> valuesFromHiddenInput(java.lang.String tokenName, java.lang.String afterText) throws GrinderException
tokenName
in the body of the last response. This version of
valueFromHiddenInput
only considers matches following the
first occurrence of the literal text afterText
.tokenName
- The token name.afterText
- The search begins after the first occurrence of this literal text.GrinderException
- If not called from a worker thread.valuesFromHiddenInput(String)
,
valueFromHiddenInput(String, String)
java.lang.String valueFromBodyURI(java.lang.String tokenName) throws GrinderException
tokenName
in a URI in the body of the last
response. If there are multiple matches, the first value is returned.
If there is no match, an empty string is returned rather than
null
. This makes scripts more robust (as they don't need to
check the value before using it), but they lose the ability to distinguish
between a missing token and an empty value.
tokenName
- The token name.GrinderException
- If not called from a worker thread.valueFromBodyURI(String, String)
,
valuesFromBodyURI(String)
java.lang.String valueFromBodyURI(java.lang.String tokenName, java.lang.String afterText) throws GrinderException
tokenName
in a URI in the body of the last
response. This version of valueFromBodyURI
only considers
matches following the first occurrence of the literal text
afterText
. If there are multiple matches, the first value
is returned.
If there is no match, an empty string is returned rather than
null
. This makes scripts more robust (as they don't need to
check the value before using it), but they lose the ability to distinguish
between a missing token and an empty value.
tokenName
- The token name.afterText
- The search begins after the first occurrence of this literal text.afterText
followed by a URI
containing a token with name tokenName
.GrinderException
- If not called from a worker thread.valueFromBodyURI(String)
,
valuesFromBodyURI(String, String)
java.util.List<java.lang.String> valuesFromBodyURI(java.lang.String tokenName) throws GrinderException
tokenName
in a URI in the body of the
last response.tokenName
- The token name.GrinderException
- If not called from a worker thread.valueFromBodyURI(String)
,
valuesFromBodyURI(String, String)
java.util.List<java.lang.String> valuesFromBodyURI(java.lang.String tokenName, java.lang.String afterText) throws GrinderException
tokenName
in a URI in the body of the
last response. This version of valueFromBodyURI
only considers
matches following the first occurrence of the literal text
afterText
.tokenName
- The token name.afterText
- The search begins after the first occurrence of this literal text.GrinderException
- If not called from a worker thread.valuesFromBodyURI(String)
,
valueFromBodyURI(String, String)