HttpHeader (OWASP Zed Attack Proxy)

java.lang.Object
- org.parosproxy.paros.network.HttpHeader

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HttpRequestHeader, HttpResponseHeader
```
public abstract class HttpHeader
extends Object
implements Serializable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`_CHUNKED`
`static String`	`_CLOSE`
`static String`	`_KEEP_ALIVE`
`static String`	`ACCEPT_ENCODING`
`static String`	`ACCESS_CONTROL_ALLOW_HEADERS`
`static String`	`ACCESS_CONTROL_ALLOW_METHODS`
`static String`	`ACCESS_CONTROL_ALLOW_ORIGIN`
`static String`	`ACCESS_CONTROL_EXPOSE_HEADERS`
`static String`	`AUTHORIZATION`
`static String`	`CACHE_CONTROL`
`static String`	`CONNECTION`
`static String`	`CONTENT_ENCODING`
`static String`	`CONTENT_LENGTH`
`static String`	`CONTENT_TYPE`
`static String`	`COOKIE`
`static String`	`CRLF`
`static String`	`DEFLATE`
`static String`	`FORM_URLENCODED_CONTENT_TYPE`
`static String`	`GZIP`
`static String`	`HTTP`
`static String`	`HTTP09`
`static String`	`HTTP10`
`static String`	`HTTP11`
`static String`	`HTTPS`
`static String`	`IDENTITY`
`static String`	`IF_MODIFIED_SINCE`
`static String`	`IF_NONE_MATCH`
`static String`	`JSON_CONTENT_TYPE`
`static String`	`LF`
`static String`	`LOCATION`
`protected int`	`mContentLength`
`static String`	`METHODS_ALLOW`
`static String`	`METHODS_PUBLIC`
`protected Hashtable<String,Vector<String>>`	`mHeaderFields`
`protected String`	`mLineDelimiter`
`protected boolean`	`mMalformedHeader`
`protected String`	`mMsgHeader`
`protected String`	`mStartLine`
`protected String`	`mVersion`
`protected static String`	`p_METHOD`
`protected static String`	`p_REASON_PHRASE`
`protected static String`	`p_SP`
`protected static String`	`p_STATUS_CODE`
`protected static String`	`p_TEXT`
`protected static String`	`p_URI`
`protected static String`	`p_VERSION`
`static Pattern`	`patternCRLF`
`static Pattern`	`patternLF`
`static String`	`PRAGMA`
`static String`	`PROXY_AUTHENTICATE`
`static String`	`PROXY_AUTHORIZATION`
`static String`	`PROXY_CONNECTION`
`static String`	`REFERER`
`static String`	`SCHEME_HTTP`
`static String`	`SCHEME_HTTPS`
`static String`	`SEC_PROXY_INTERCEPT`
`static String`	`SEC_PROXY_RECORD`
`static String`	`SET_COOKIE`
`static String`	`SET_COOKIE2`
`static String`	`TRANSFER_ENCODING`
`static String`	`USER_AGENT`
`static String`	`WWW_AUTHENTICATE`
`static String`	`X_CONTENT_TYPE_OPTIONS`
`static String`	`X_CSRF_TOKEN`
`static String`	`X_CSRFTOKEN`
`static String`	`X_FRAME_OPTION`
`static String`	`X_SECURITY_PROXY`
`static String`	`X_XSRF_TOKEN`
`static String`	`X_XSS_PROTECTION`
`static String`	`X_ZAP_API_KEY`
`static String`	`X_ZAP_API_NONCE`
`static String`	`X_ZAP_REQUESTID`
`static String`	`X_ZAP_SCAN_ID`

Constructor Summary

Constructors
Constructor and Description

HttpHeader()

HttpHeader(String data)
Construct a HttpHeader from a given String.

Constructors
Constructor and Description
`HttpHeader()`
`HttpHeader(String data)` Construct a HttpHeader from a given String.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addHeader(String name, String val)` Add a header with the name and value given.
`void`	`clear()`
`String`	`getCharset()`
`int`	`getContentLength()` Get the content length of this header.
`String`	`getHeader(String name)` Get the first header value using the name given.
`List<HttpHeaderField>`	`getHeaders()`
`Vector<String>`	`getHeaders(String name)` Deprecated. since 2.9.0. See `getHeaderValues(String)` instead
`String`	`getHeadersAsString()` Get the headers as string.
`List<String>`	`getHeaderValues(String name)` Get header(s) with the name.
`String`	`getLineDelimiter()` Get the line delimiter of this header.
`String`	`getNormalisedContentTypeValue()` Gets the normalised value of the (first) `Content-Type` header.
`abstract String`	`getPrimeHeader()` Get the prime header.
`String`	`getVersion()` Return the HTTP version (e.g.
`boolean`	`hasContentType(String... contentTypes)` Tells whether or not the HTTP header contains any of the given `Content-Type` values.
`boolean`	`isConnectionClose()` Check if this header expect connection to be closed.
`boolean`	`isEmpty()` Tells whether or not the header is empty.
`boolean`	`isHttp10()` Check if this header is HTTP 1.0.
`boolean`	`isHttp11()` Check if this header is HTTP 1.1.
`boolean`	`isImage()` Get if this is a image header.
`boolean`	`isMalformedHeader()` Get if this is a malformed header.
`boolean`	`isText()` Get if this is a text header.
`boolean`	`isTransferEncodingChunked()` Check if Transfer Encoding Chunked is set in this header.
`protected boolean`	`parse(String data)` Parse this Http header using the String given.
`void`	`setContentLength(int len)` Set the content length of this header.
`void`	`setHeader(String name, String value)` Set a header name and value.
`void`	`setMessage(String data)` Set and parse this HTTP header with the string given.
`abstract void`	`setVersion(String version)` Set the HTTP version of this header.
`String`	`toString()` Get a string representation of this header.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CRLF
```
public static final String CRLF
```
    See Also:
    
    Constant Field Values
  - LF
```
public static final String LF
```
    See Also:
    
    Constant Field Values
  - CONTENT_LENGTH
```
public static final String CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
  - TRANSFER_ENCODING
```
public static final String TRANSFER_ENCODING
```
    See Also:
    
    Constant Field Values
  - CONTENT_ENCODING
```
public static final String CONTENT_ENCODING
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - PROXY_CONNECTION
```
public static final String PROXY_CONNECTION
```
    See Also:
    
    Constant Field Values
  - PROXY_AUTHENTICATE
```
public static final String PROXY_AUTHENTICATE
```
    See Also:
    
    Constant Field Values
  - CONNECTION
```
public static final String CONNECTION
```
    See Also:
    
    Constant Field Values
  - AUTHORIZATION
```
public static final String AUTHORIZATION
```
    See Also:
    
    Constant Field Values
  - WWW_AUTHENTICATE
```
public static final String WWW_AUTHENTICATE
```
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final String LOCATION
```
    See Also:
    
    Constant Field Values
  - IF_MODIFIED_SINCE
```
public static final String IF_MODIFIED_SINCE
```
    See Also:
    
    Constant Field Values
  - IF_NONE_MATCH
```
public static final String IF_NONE_MATCH
```
    See Also:
    
    Constant Field Values
  - USER_AGENT
```
public static final String USER_AGENT
```
    See Also:
    
    Constant Field Values
  - ACCEPT_ENCODING
```
public static final String ACCEPT_ENCODING
```
    See Also:
    
    Constant Field Values
  - CACHE_CONTROL
```
public static final String CACHE_CONTROL
```
    See Also:
    
    Constant Field Values
  - PRAGMA
```
public static final String PRAGMA
```
    See Also:
    
    Constant Field Values
  - REFERER
```
public static final String REFERER
```
    See Also:
    
    Constant Field Values
  - X_ZAP_REQUESTID
```
public static final String X_ZAP_REQUESTID
```
    See Also:
    
    Constant Field Values
  - X_SECURITY_PROXY
```
public static final String X_SECURITY_PROXY
```
    See Also:
    
    Constant Field Values
  - COOKIE
```
public static final String COOKIE
```
    See Also:
    
    Constant Field Values
  - SET_COOKIE
```
public static final String SET_COOKIE
```
    See Also:
    
    Constant Field Values
  - SET_COOKIE2
```
public static final String SET_COOKIE2
```
    See Also:
    
    Constant Field Values
  - X_XSS_PROTECTION
```
public static final String X_XSS_PROTECTION
```
    See Also:
    
    Constant Field Values
  - X_FRAME_OPTION
```
public static final String X_FRAME_OPTION
```
    See Also:
    
    Constant Field Values
  - X_CONTENT_TYPE_OPTIONS
```
public static final String X_CONTENT_TYPE_OPTIONS
```
    See Also:
    
    Constant Field Values
  - HTTP09
```
public static final String HTTP09
```
    See Also:
    
    Constant Field Values
  - HTTP10
```
public static final String HTTP10
```
    See Also:
    
    Constant Field Values
  - HTTP11
```
public static final String HTTP11
```
    See Also:
    
    Constant Field Values
  - _CLOSE
```
public static final String _CLOSE
```
    See Also:
    
    Constant Field Values
  - _KEEP_ALIVE
```
public static final String _KEEP_ALIVE
```
    See Also:
    
    Constant Field Values
  - _CHUNKED
```
public static final String _CHUNKED
```
    See Also:
    
    Constant Field Values
  - FORM_URLENCODED_CONTENT_TYPE
```
public static final String FORM_URLENCODED_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_CONTENT_TYPE
```
public static final String JSON_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - SCHEME_HTTP
```
public static final String SCHEME_HTTP
```
    See Also:
    
    Constant Field Values
  - SCHEME_HTTPS
```
public static final String SCHEME_HTTPS
```
    See Also:
    
    Constant Field Values
  - HTTP
```
public static final String HTTP
```
    See Also:
    
    Constant Field Values
  - HTTPS
```
public static final String HTTPS
```
    See Also:
    
    Constant Field Values
  - DEFLATE
```
public static final String DEFLATE
```
    See Also:
    
    Constant Field Values
  - GZIP
```
public static final String GZIP
```
    See Also:
    
    Constant Field Values
  - IDENTITY
```
public static final String IDENTITY
```
    See Also:
    
    Constant Field Values
  - SEC_PROXY_INTERCEPT
```
public static final String SEC_PROXY_INTERCEPT
```
    See Also:
    
    Constant Field Values
  - SEC_PROXY_RECORD
```
public static final String SEC_PROXY_RECORD
```
    See Also:
    
    Constant Field Values
  - patternCRLF
```
public static final Pattern patternCRLF
```
  - patternLF
```
public static final Pattern patternLF
```
  - p_TEXT
```
protected static final String p_TEXT
```
    See Also:
    
    Constant Field Values
  - p_METHOD
```
protected static final String p_METHOD
```
    See Also:
    
    Constant Field Values
  - p_SP
```
protected static final String p_SP
```
    See Also:
    
    Constant Field Values
  - p_URI
```
protected static final String p_URI
```
    See Also:
    
    Constant Field Values
  - p_VERSION
```
protected static final String p_VERSION
```
    See Also:
    
    Constant Field Values
  - p_STATUS_CODE
```
protected static final String p_STATUS_CODE
```
    See Also:
    
    Constant Field Values
  - p_REASON_PHRASE
```
protected static final String p_REASON_PHRASE
```
    See Also:
    
    Constant Field Values
  - mStartLine
```
protected String mStartLine
```
  - mMsgHeader
```
protected String mMsgHeader
```
  - mMalformedHeader
```
protected boolean mMalformedHeader
```
  - mHeaderFields
```
protected Hashtable<String,Vector<String>> mHeaderFields
```
  - mContentLength
```
protected int mContentLength
```
  - mLineDelimiter
```
protected String mLineDelimiter
```
  - mVersion
```
protected String mVersion
```
  - ACCESS_CONTROL_ALLOW_ORIGIN
```
public static final String ACCESS_CONTROL_ALLOW_ORIGIN
```
    See Also:
    
    Constant Field Values
  - ACCESS_CONTROL_ALLOW_HEADERS
```
public static final String ACCESS_CONTROL_ALLOW_HEADERS
```
    See Also:
    
    Constant Field Values
  - ACCESS_CONTROL_ALLOW_METHODS
```
public static final String ACCESS_CONTROL_ALLOW_METHODS
```
    See Also:
    
    Constant Field Values
  - ACCESS_CONTROL_EXPOSE_HEADERS
```
public static final String ACCESS_CONTROL_EXPOSE_HEADERS
```
    See Also:
    
    Constant Field Values
  - METHODS_ALLOW
```
public static final String METHODS_ALLOW
```
    See Also:
    
    Constant Field Values
  - METHODS_PUBLIC
```
public static final String METHODS_PUBLIC
```
    See Also:
    
    Constant Field Values
  - X_ZAP_SCAN_ID
```
public static final String X_ZAP_SCAN_ID
```
    See Also:
    
    Constant Field Values
  - X_ZAP_API_KEY
```
public static final String X_ZAP_API_KEY
```
    See Also:
    
    Constant Field Values
  - X_ZAP_API_NONCE
```
public static final String X_ZAP_API_NONCE
```
    See Also:
    
    Constant Field Values
  - PROXY_AUTHORIZATION
```
public static final String PROXY_AUTHORIZATION
```
    See Also:
    
    Constant Field Values
  - X_CSRF_TOKEN
```
public static final String X_CSRF_TOKEN
```
    See Also:
    
    Constant Field Values
  - X_CSRFTOKEN
```
public static final String X_CSRFTOKEN
```
    See Also:
    
    Constant Field Values
  - X_XSRF_TOKEN
```
public static final String X_XSRF_TOKEN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpHeader
```
public HttpHeader()
```
  - HttpHeader
```
public HttpHeader(String data)
           throws HttpMalformedHeaderException
```
    Construct a HttpHeader from a given String.
    
    Parameters:
    
    data -
    
    Throws:
    
    HttpMalformedHeaderException
- Method Detail
  - setMessage
```
public void setMessage(String data)
                throws HttpMalformedHeaderException
```
    Set and parse this HTTP header with the string given.
    
    Parameters:
    
    data -
    
    Throws:
    
    HttpMalformedHeaderException
  - clear
```
public void clear()
```
  - getHeader
```
public String getHeader(String name)
```
    Get the first header value using the name given. If there are multiple occurrence, only the first one will be returned as String.
    
    Parameters:
    
    name -
    
    Returns:
    
    the header value. null if not found.
  - getHeaders
```
@Deprecated
public Vector<String> getHeaders(String name)
```
    Deprecated. since 2.9.0. See getHeaderValues(String) instead
    
    Get headers with the name. Multiple value can be returned.
    
    Parameters:
    
    name -
    
    Returns:
    
    a vector holding the value as string.
  - getHeaderValues
```
public List<String> getHeaderValues(String name)
```
    Get header(s) with the name. Multiple values can be returned.
    
    Parameters:
    
    name - the name of the header(s) to return.
    
    Returns:
    
    a List holding the value(s) as String(s).
    
    Since:
    
    2.9.0
  - getHeaders
```
public List<HttpHeaderField> getHeaders()
```
  - addHeader
```
public void addHeader(String name,
                      String val)
```
    Add a header with the name and value given. It will be appended to the header string.
    
    Parameters:
    
    name -
    
    val -
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Set a header name and value. If the name is not found, it will be added. If the value is null, the header will be removed.
    
    Parameters:
    
    name -
    
    value -
  - getVersion
```
public String getVersion()
```
    Return the HTTP version (e.g. HTTP/1.0, HTTP/1.1)
    
    Returns:
  - setVersion
```
public abstract void setVersion(String version)
```
    Set the HTTP version of this header.
    
    Parameters:
    
    version -
  - getContentLength
```
public int getContentLength()
```
    Get the content length of this header.
    
    Returns:
    
    content length. -1 means content length not set.
  - setContentLength
```
public void setContentLength(int len)
```
    Set the content length of this header.
    
    Parameters:
    
    len -
  - isConnectionClose
```
public boolean isConnectionClose()
```
    Check if this header expect connection to be closed. HTTP/1.0 default to close. HTTP/1.1 default to keep-alive.
    
    Returns:
  - isHttp10
```
public boolean isHttp10()
```
    Check if this header is HTTP 1.0.
    
    Returns:
    
    true if HTTP 1.0.
  - isHttp11
```
public boolean isHttp11()
```
    Check if this header is HTTP 1.1.
    
    Returns:
    
    true if HTTP 1.0.
  - isTransferEncodingChunked
```
public boolean isTransferEncodingChunked()
```
    Check if Transfer Encoding Chunked is set in this header.
    
    Returns:
    
    true if transfer encoding chunked is set.
  - parse
```
protected boolean parse(String data)
                 throws Exception
```
    Parse this Http header using the String given.
    
    Parameters:
    
    data - String to be parsed to form this header.
    
    Returns:
    
    Throws:
    
    Exception
  - isMalformedHeader
```
public boolean isMalformedHeader()
```
    Get if this is a malformed header.
    
    Returns:
  - toString
```
public String toString()
```
    Get a string representation of this header.
    
    Overrides:
    
    toString in class Object
  - getPrimeHeader
```
public abstract String getPrimeHeader()
```
    Get the prime header.
    
    Returns:
    
    startline for request, statusline for response.
  - isImage
```
public boolean isImage()
```
    Get if this is a image header.
    
    Returns:
    
    true if image.
  - isText
```
public boolean isText()
```
    Get if this is a text header.
    
    Returns:
    
    true if text.
  - hasContentType
```
public boolean hasContentType(String... contentTypes)
```
    Tells whether or not the HTTP header contains any of the given Content-Type values.
    The values are expected to be in lower case.
    
    Parameters:
    
    contentTypes - the values to check.
    
    Returns:
    
    true if any of the given values is contained in the (first) Content-Type header, false otherwise.
    
    Since:
    
    2.8.0
    
    See Also:
    
    getNormalisedContentTypeValue()
  - getNormalisedContentTypeValue
```
public String getNormalisedContentTypeValue()
```
    Gets the normalised value of the (first) Content-Type header.
    The normalisation is done by changing all characters to lower case.
    
    Returns:
    
    the value normalised, might be null.
    
    Since:
    
    2.8.0
    
    See Also:
    
    hasContentType(String...)
  - getLineDelimiter
```
public String getLineDelimiter()
```
    Get the line delimiter of this header.
    
    Returns:
  - getHeadersAsString
```
public String getHeadersAsString()
```
    Get the headers as string. All the headers name value pair is concatenated and delimited.
    
    Returns:
    
    Eg "Host: www.example.com\r\nUser-agent: some agent\r\n"
  - isEmpty
```
public boolean isEmpty()
```
    Tells whether or not the header is empty.
    A header is empty if it has no content (for example, no start line nor headers).
    
    Returns:
    
    true if the header is empty, false otherwise.
  - getCharset
```
public String getCharset()
```

Class HttpHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CRLF

LF

CONTENT_LENGTH

TRANSFER_ENCODING

CONTENT_ENCODING

CONTENT_TYPE

PROXY_CONNECTION

PROXY_AUTHENTICATE

CONNECTION

AUTHORIZATION

WWW_AUTHENTICATE

LOCATION

IF_MODIFIED_SINCE

IF_NONE_MATCH

USER_AGENT

ACCEPT_ENCODING

CACHE_CONTROL

PRAGMA

REFERER

X_ZAP_REQUESTID

X_SECURITY_PROXY

COOKIE

SET_COOKIE

SET_COOKIE2

X_XSS_PROTECTION

X_FRAME_OPTION

X_CONTENT_TYPE_OPTIONS

HTTP09

HTTP10

HTTP11

_CLOSE

_KEEP_ALIVE

_CHUNKED

FORM_URLENCODED_CONTENT_TYPE

JSON_CONTENT_TYPE

SCHEME_HTTP

SCHEME_HTTPS

HTTP

HTTPS

DEFLATE

GZIP

IDENTITY

SEC_PROXY_INTERCEPT

SEC_PROXY_RECORD

patternCRLF

patternLF

p_TEXT

p_METHOD

p_SP

p_URI

p_VERSION

p_STATUS_CODE

p_REASON_PHRASE

mStartLine

mMsgHeader

mMalformedHeader

mHeaderFields

mContentLength

mLineDelimiter

mVersion

ACCESS_CONTROL_ALLOW_ORIGIN

ACCESS_CONTROL_ALLOW_HEADERS

ACCESS_CONTROL_ALLOW_METHODS

ACCESS_CONTROL_EXPOSE_HEADERS

METHODS_ALLOW

METHODS_PUBLIC

X_ZAP_SCAN_ID

X_ZAP_API_KEY

X_ZAP_API_NONCE

PROXY_AUTHORIZATION

X_CSRF_TOKEN

X_CSRFTOKEN

X_XSRF_TOKEN

Constructor Detail