Package org.apache.jmeter.extractor
Class RegexExtractor
java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.testelement.AbstractScopedTestElement
org.apache.jmeter.extractor.RegexExtractor
- All Implemented Interfaces:
Serializable
,Cloneable
,Searchable
,PostProcessor
,TestElement
public class RegexExtractor
extends AbstractScopedTestElement
implements PostProcessor, Serializable
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Fields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the default value for the variable, which should be used, if no matches are foundint
Get the prefix name of the variable to be used to store the regex matchesgetRegex()
Get the regex which is to be usedvoid
process()
Parses the response data using regular expressions and saving the results into variables for use later in the test.void
setDefaultValue
(String defaultValue) Sets the value of the variable if no matches are foundvoid
setMatchNumber
(int matchNumber) Set which Match to use.void
setMatchNumber
(String matchNumber) void
setRefName
(String refName) Set the prefix name of the variable to be used to store the regex matchesvoid
Set the regex to be usedvoid
setTemplate
(String template) void
setUseField
(String actionCommand) boolean
useBody()
boolean
boolean
useCode()
boolean
boolean
boolean
boolean
boolean
useUrl()
Methods inherited from class org.apache.jmeter.testelement.AbstractScopedTestElement
fetchScope, getSampleList, getScopeName, getVariableName, isScopeAll, isScopeChildren, isScopeParent, isScopeVariable, isScopeVariable, setScopeAll, setScopeChildren, setScopeParent, setScopeVariable
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, clone, 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
-
Field Details
-
USE_HDRS
- See Also:
-
USE_REQUEST_HDRS
- See Also:
-
USE_BODY
- See Also:
-
USE_BODY_UNESCAPED
- See Also:
-
USE_BODY_AS_DOCUMENT
- See Also:
-
USE_URL
- See Also:
-
USE_CODE
- See Also:
-
USE_MESSAGE
- See Also:
-
-
Constructor Details
-
RegexExtractor
public RegexExtractor()
-
-
Method Details
-
process
public void process()Parses the response data using regular expressions and saving the results into variables for use later in the test.- Specified by:
process
in interfacePostProcessor
- See Also:
-
setRegex
Set the regex to be used- Parameters:
regex
- The string representation of the regex
-
getRegex
Get the regex which is to be used- Returns:
- string representing the regex
-
setRefName
Set the prefix name of the variable to be used to store the regex matches- Parameters:
refName
- prefix of the variables to be used
-
getRefName
Get the prefix name of the variable to be used to store the regex matches- Returns:
- The prefix of the variables to be used
-
setMatchNumber
public void setMatchNumber(int matchNumber) Set which Match to use. This can be any positive number, indicating the exact match to use, or0
, which is interpreted as meaning random.- Parameters:
matchNumber
- The number of the match to be used, or0
if a random match should be used.
-
setMatchNumber
-
getMatchNumber
public int getMatchNumber() -
getMatchNumberAsString
-
setDefaultValue
Sets the value of the variable if no matches are found- Parameters:
defaultValue
- The default value for the variable
-
getDefaultValue
Get the default value for the variable, which should be used, if no matches are found- Returns:
- The default value for the variable
-
setTemplate
-
getTemplate
-
useHeaders
public boolean useHeaders() -
useRequestHeaders
public boolean useRequestHeaders() -
useBody
public boolean useBody() -
useUnescapedBody
public boolean useUnescapedBody() -
useBodyAsDocument
public boolean useBodyAsDocument() -
useUrl
public boolean useUrl() -
useCode
public boolean useCode() -
useMessage
public boolean useMessage() -
setUseField
-