Class HeaderManager
-
- All Implemented Interfaces:
-
java.io.Serializable
,java.lang.Cloneable
,org.apache.jmeter.config.ConfigElement
,org.apache.jmeter.gui.Replaceable
,org.apache.jmeter.gui.Searchable
,org.apache.jmeter.testelement.TestElement
public class HeaderManager extends ConfigTestElement implements Serializable, Replaceable
This class provides an interface to headers file to pass HTTP headers along with a request.
-
-
Field Summary
Fields Modifier and Type Field Description public final static String
HEADERS
public final static String
USERNAME
public final static String
PASSWORD
public transient JMeterContext
threadContext
public transient String
threadName
public final static TestElement.Companion
Companion
public final static String
NAME
public final static String
GUI_CLASS
public final static String
ENABLED
public final static String
TEST_CLASS
public final static String
COMMENTS
-
Constructor Summary
Constructors Constructor Description HeaderManager()
-
Method Summary
Modifier and Type Method Description HeaderManagerSchema
getSchema()
PropertiesAccessor<out HeaderManager, out HeaderManagerSchema>
getProps()
void
recoverRunningVersion()
void
clear()
CollectionProperty
getHeaders()
Get the collection of JMeterProperty entries representing the headers. int
getColumnCount()
String
getColumnName(int column)
Class<out String>
getColumnClass(int column)
Header
getHeader(int row)
void
save(String headFile)
Save the header data to a file. void
addFile(String headerFile)
Add header data from a file. void
add(Header h)
Add a header. void
add()
Add an empty header. void
remove(int index)
Remove a header. int
size()
Return the number of headers. Header
get(int i)
Return the header at index i. Header
getFirstHeaderNamed(String name)
Get the first header from Headers by the header name, or null
if not found.void
removeHeaderNamed(String name)
Remove from Headers the header named name HeaderManager
merge(TestElement element, boolean preferLocalValues)
Merge the attributes with a another HeaderManager's attributes. HeaderManager
merge(TestElement element)
Merge the attributes with a another HeaderManager's attributes. int
replace(String regex, String replaceBy, boolean caseSensitive)
-
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
canRemove, clearTestElementChildren, clone, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyOrNull, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, propertyIterator, removeProperty, setComment, setEnabled, setName, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse
-
Methods inherited from class org.apache.jmeter.config.ConfigTestElement
addConfigElement, addTestElement, expectsModification
-
Methods inherited from class org.apache.jmeter.testelement.TestElement
get, get, get, get, get, get, get, get, get, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getProps, getSchema, getString, removed, set
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getSchema
HeaderManagerSchema getSchema()
-
getProps
PropertiesAccessor<out HeaderManager, out HeaderManagerSchema> getProps()
-
recoverRunningVersion
void recoverRunningVersion()
-
clear
void clear()
-
getHeaders
CollectionProperty getHeaders()
Get the collection of JMeterProperty entries representing the headers.
-
getColumnCount
int getColumnCount()
-
getColumnName
String getColumnName(int column)
-
getColumnClass
Class<out String> getColumnClass(int column)
-
save
void save(String headFile)
Save the header data to a file.
- Parameters:
headFile
- name of the file to store headers into.
-
addFile
void addFile(String headerFile)
Add header data from a file.
- Parameters:
headerFile
- name of the file to read headers from.
-
add
void add()
Add an empty header.
-
remove
void remove(int index)
Remove a header.
- Parameters:
index
- index from the header to remove
-
size
int size()
Return the number of headers.
-
getFirstHeaderNamed
Header getFirstHeaderNamed(String name)
Get the first header from Headers by the header name, or
null
if not found.- Parameters:
name
- header name
-
removeHeaderNamed
void removeHeaderNamed(String name)
Remove from Headers the header named name
- Parameters:
name
- header name
-
merge
@Deprecated() HeaderManager merge(TestElement element, boolean preferLocalValues)
Merge the attributes with a another HeaderManager's attributes.
- Parameters:
element
- The object to be merged withpreferLocalValues
- Not used
-
merge
HeaderManager merge(TestElement element)
Merge the attributes with a another HeaderManager's attributes.
- Parameters:
element
- The object to be merged with
-
-
-
-