Class HeaderManager
java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.config.ConfigTestElement
org.apache.jmeter.protocol.http.control.HeaderManager
- All Implemented Interfaces:
Serializable,Cloneable,ConfigElement,Searchable,TestElement
This class provides an interface to headers file to pass HTTP headers along
with a request.
- Version:
- $Revision: 1649126 $
- See Also:
-
Field Summary
FieldsFields inherited from class org.apache.jmeter.config.ConfigTestElement
PASSWORD, USERNAMEFields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidadd()Add an empty header.voidAdd a header.voidAdd header data from a file.voidclear()Clear the TestElement of all data.get(int i) Return the header at index i.getColumnClass(int column) intgetColumnName(int column) getHeader(int row) Get the collection of JMeterProperty entries representing the headers.Added support for SOAP related header stuff. 1-29-04 Peter Linmerge(TestElement element, boolean preferLocalValues) Merge the attributes with a another HeaderManager's attributes.voidremove(int index) Remove a header.voidremoveHeaderNamed(String name) Remove from Headers the header named namevoidSave the header data to a file.voidsetSOAPHeader(Object header) Set the SOAPHeader with the SOAPHTTPConnection object.intsize()Return the number of headers.Methods inherited from class org.apache.jmeter.config.ConfigTestElement
addConfigElement, addTestElement, expectsModificationMethods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, canRemove, 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, traversePropertyMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.jmeter.config.ConfigElement
clone
-
Field Details
-
HEADERS
- See Also:
-
-
Constructor Details
-
HeaderManager
public HeaderManager()
-
-
Method Details
-
clear
public void clear()Clear the TestElement of all data.- Specified by:
clearin interfaceTestElement- Overrides:
clearin classAbstractTestElement
-
getHeaders
Get the collection of JMeterProperty entries representing the headers.- Returns:
- the header collection property
-
getColumnCount
public int getColumnCount() -
getColumnName
-
getColumnClass
-
getHeader
-
save
Save the header data to a file.- Parameters:
headFile- name of the file to store headers into. If name is relative the system propertyuser.dirwill be prepended- Throws:
IOException- if writing the headers fails
-
addFile
Add header data from a file.- Parameters:
headerFile- name of the file to read headers from. If name is relative the system propertyuser.dirwill be prepended- Throws:
IOException- if reading headers fails
-
add
Add a header.- Parameters:
h-Headerto add
-
add
public void add()Add an empty header. -
remove
public void remove(int index) Remove a header.- Parameters:
index- index from the header to remove
-
size
public int size()Return the number of headers.- Returns:
- number of headers
-
get
Return the header at index i.- Parameters:
i- index of the header to get- Returns:
Headerat indexi
-
removeHeaderNamed
Remove from Headers the header named name- Parameters:
name- header name
-
getSOAPHeader
Added support for SOAP related header stuff. 1-29-04 Peter Lin- Returns:
- the SOAP header Object
-
setSOAPHeader
Set the SOAPHeader with the SOAPHTTPConnection object. We may or may not want to rename this to setHeaderObject(Object). Conceivably, other samplers may need this kind of functionality. 1-29-04 Peter Lin- Parameters:
header- soap header
-
merge
Merge the attributes with a another HeaderManager's attributes.- Parameters:
element- The object to be merged withpreferLocalValues- When both objects have a value for the same attribute, this flag determines which value is preferred.- Returns:
- merged HeaderManager
- Throws:
IllegalArgumentException- ifelementis not an instance ofHeaderManager
-