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
public class HeaderManager extends ConfigTestElement implements Serializable
This class provides an interface to headers file to pass HTTP headers along with a request.
Version:
$Revision: 1649126 $
See Also:

  • Field Details

  • Constructor Details

    • HeaderManager

      public HeaderManager()

  • Method Details

    • clear

      public void clear()
      Clear the TestElement of all data.
      Specified by:
      clear in interface TestElement
      Overrides:
      clear in class AbstractTestElement

    • getHeaders

      public CollectionProperty getHeaders()
      Get the collection of JMeterProperty entries representing the headers.
      Returns:
      the header collection property

    • getColumnCount

      public int getColumnCount()

    • getColumnName

      public String getColumnName(int column)

    • getColumnClass

      public Class<? extends String> getColumnClass(int column)

    • getHeader

      public Header getHeader(int row)

    • save

      public void save(String headFile) throws IOException
      Save the header data to a file.
      Parameters:
      headFile - name of the file to store headers into. If name is relative the system property user.dir will be prepended
      Throws:
      IOException - if writing the headers fails

    • addFile

      public void addFile(String headerFile) throws IOException
      Add header data from a file.
      Parameters:
      headerFile - name of the file to read headers from. If name is relative the system property user.dir will be prepended
      Throws:
      IOException - if reading headers fails

    • add

      public void add(Header h)
      Add a header.
      Parameters:
      h - Header to 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

      public Header get(int i)
      Return the header at index i.
      Parameters:
      i - index of the header to get
      Returns:
      Header at index i

    • removeHeaderNamed

      public void removeHeaderNamed(String name)
      Remove from Headers the header named name
      Parameters:
      name - header name

    • getSOAPHeader

      public Object getSOAPHeader()
      Added support for SOAP related header stuff. 1-29-04 Peter Lin
      Returns:
      the SOAP header Object

    • setSOAPHeader

      public void setSOAPHeader(Object header)
      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

      public HeaderManager merge(TestElement element, boolean preferLocalValues)
      Merge the attributes with a another HeaderManager's attributes.
      Parameters:
      element - The object to be merged with
      preferLocalValues - When both objects have a value for the same attribute, this flag determines which value is preferred.
      Returns:
      merged HeaderManager
      Throws:
      IllegalArgumentException - if element is not an instance of HeaderManager