HttpRequestHeader (OWASP Zed Attack Proxy)

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

All Implemented Interfaces:

Serializable
```
public class HttpRequestHeader
extends HttpHeader
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPT` The `Accept` request header.
`static String`	`CONNECT`
`static String`	`DELETE`
`static String`	`GET`
`static String`	`HEAD`
`static String`	`HOST`
`static String[]`	`METHODS`
`static String`	`OPTIONS`
`static String`	`ORIGIN` The `Origin` request header.
`static String`	`PATCH`
`static String`	`POST`
`static String`	`PUT`
`static String`	`TRACE`
`static String`	`TRACK`

Fields inherited from class org.parosproxy.paros.network.HttpHeader
_CHUNKED, _CLOSE, _KEEP_ALIVE, ACCEPT_ENCODING, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_ENCODING, CONTENT_LENGTH, CONTENT_TYPE, COOKIE, CRLF, DEFLATE, FORM_URLENCODED_CONTENT_TYPE, GZIP, HTTP, HTTP09, HTTP10, HTTP11, HTTPS, IDENTITY, IF_MODIFIED_SINCE, IF_NONE_MATCH, JSON_CONTENT_TYPE, LF, LOCATION, mContentLength, METHODS_ALLOW, METHODS_PUBLIC, mHeaderFields, mLineDelimiter, mMalformedHeader, mMsgHeader, mStartLine, mVersion, p_METHOD, p_REASON_PHRASE, p_SP, p_STATUS_CODE, p_TEXT, p_URI, p_VERSION, patternCRLF, patternLF, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_CONNECTION, REFERER, SCHEME_HTTP, SCHEME_HTTPS, SEC_PROXY_INTERCEPT, SEC_PROXY_RECORD, SET_COOKIE, SET_COOKIE2, TRANSFER_ENCODING, USER_AGENT, WWW_AUTHENTICATE, X_CONTENT_TYPE_OPTIONS, X_CSRF_TOKEN, X_CSRFTOKEN, X_FRAME_OPTION, X_SECURITY_PROXY, X_XSRF_TOKEN, X_XSS_PROTECTION, X_ZAP_API_KEY, X_ZAP_API_NONCE, X_ZAP_REQUESTID, X_ZAP_SCAN_ID

Constructor Summary

Constructors
Constructor and Description
`HttpRequestHeader()` Constructor for an empty header.
`HttpRequestHeader(String data)` Constructor of a request header with the string.
`HttpRequestHeader(String data, boolean isSecure)` Constructor of a request header with the string.
`HttpRequestHeader(String method, org.apache.commons.httpclient.URI uri, String version)` Constructs a `HttpRequestHeader` with the given method, URI, and version.
`HttpRequestHeader(String method, org.apache.commons.httpclient.URI uri, String version, ConnectionParam params)` Deprecated. (2.8.0) Use `HttpRequestHeader(String, URI, String)` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clear()`
`int`	`getContentLength()` Get the content length in this request header.
`TreeSet<HtmlParameter>`	`getCookieParams()`
`static String`	`getDefaultUserAgent()` Gets the user agent used by `default request header`.
`String`	`getHostName()` Get the host name in this request header.
`int`	`getHostPort()` Gets the host port number of this request message, a non-negative integer.
`List<HttpCookie>`	`getHttpCookies()` Gets a list of the http cookies from this request Header.
`String`	`getMethod()` Get the HTTP method (GET, POST ...
`String`	`getPrimeHeader()` Return the prime header (first line).
`boolean`	`getSecure()` Deprecated. Replaced by `isSecure()`. It will be removed in a future release.
`InetAddress`	`getSenderAddress()` Gets the senders IP address
`org.apache.commons.httpclient.URI`	`getURI()` Get the URI of this request header.
`boolean`	`isImage()` Return if this request header is a image request basing on the path suffix.
`static boolean`	`isRequestLine(String data)` Return if the data given is a request header basing on the first start line.
`boolean`	`isSecure()` Tells whether the request is secure, or not.
`static org.apache.commons.httpclient.URI`	`parseURI(String sUri)`
`void`	`setCookieParams(TreeSet<HtmlParameter> cookieParams)`
`void`	`setCookies(List<HttpCookie> cookies)` Construct new "Cookie:" line in request header based on HttpCookies.
`static void`	`setDefaultUserAgent(String defaultUserAgent)` Sets the user agent used by `default request header`.
`void`	`setGetParams(TreeSet<HtmlParameter> getParams)`
`void`	`setMessage(String data)` Set this request header with the given message.
`void`	`setMessage(String data, boolean isSecure)` Set this request header with the given message.
`void`	`setMethod(String method)` Set the HTTP method of this request header.
`void`	`setSecure(boolean isSecure)` Sets whether or not the request is done using a secure scheme, HTTPS.
`void`	`setSenderAddress(InetAddress inetAddress)` Sets the senders IP address.
`void`	`setURI(org.apache.commons.httpclient.URI uri)` Sets the URI of this request header.
`void`	`setVersion(String version)` Set the HTTP version of this request header.

Methods inherited from class org.parosproxy.paros.network.HttpHeader
addHeader, getCharset, getHeader, getHeaders, getHeaders, getHeadersAsString, getLineDelimiter, getNormalisedContentTypeValue, getVersion, hasContentType, isConnectionClose, isEmpty, isHttp10, isHttp11, isMalformedHeader, isText, isTransferEncodingChunked, parse, setContentLength, setHeader, toString

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

- Field Detail
  - ACCEPT
```
public static final String ACCEPT
```
    The Accept request header.
    
    Since:
    
    2.8.0
    
    See Also:
    
    Constant Field Values
  - ORIGIN
```
public static final String ORIGIN
```
    The Origin request header.
    
    Since:
    
    2.8.0
    
    See Also:
    
    Constant Field Values
  - CONNECT
```
public static final String CONNECT
```
    See Also:
    
    Constant Field Values
  - DELETE
```
public static final String DELETE
```
    See Also:
    
    Constant Field Values
  - GET
```
public static final String GET
```
    See Also:
    
    Constant Field Values
  - HEAD
```
public static final String HEAD
```
    See Also:
    
    Constant Field Values
  - OPTIONS
```
public static final String OPTIONS
```
    See Also:
    
    Constant Field Values
  - PATCH
```
public static final String PATCH
```
    See Also:
    
    Constant Field Values
  - POST
```
public static final String POST
```
    See Also:
    
    Constant Field Values
  - PUT
```
public static final String PUT
```
    See Also:
    
    Constant Field Values
  - TRACE
```
public static final String TRACE
```
    See Also:
    
    Constant Field Values
  - TRACK
```
public static final String TRACK
```
    See Also:
    
    Constant Field Values
  - METHODS
```
public static final String[] METHODS
```
  - HOST
```
public static final String HOST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpRequestHeader
```
public HttpRequestHeader()
```
    Constructor for an empty header.
  - HttpRequestHeader
```
public HttpRequestHeader(String data,
                         boolean isSecure)
                  throws HttpMalformedHeaderException
```
    Constructor of a request header with the string.
    
    Parameters:
    
    data - the request header
    
    isSecure - true if the request should be secure, false otherwise
    
    Throws:
    
    HttpMalformedHeaderException - if the request being set is malformed
    
    See Also:
    
    setSecure(boolean)
  - HttpRequestHeader
```
public HttpRequestHeader(String data)
                  throws HttpMalformedHeaderException
```
    Constructor of a request header with the string. Whether this is a secure header depends on the URL given.
    
    Parameters:
    
    data - the request header
    
    Throws:
    
    HttpMalformedHeaderException - if the request being set is malformed
  - HttpRequestHeader
```
public HttpRequestHeader(String method,
                         org.apache.commons.httpclient.URI uri,
                         String version)
                  throws HttpMalformedHeaderException
```
    Constructs a HttpRequestHeader with the given method, URI, and version.
    The following headers are automatically added:
    - Host, with the domain and port from the given URI.
    - User-Agent, using the getDefaultUserAgent().
    - Pragma: no-cache
    - Cache-Control: no-cache, if version is HTTP/1.1
    - Content-Type: application/x-www-form-urlencoded, if the method is POST or PUT.
    Parameters:
    
    method - the request method.
    
    uri - the request target.
    
    version - the version, for example, HTTP/1.1.
    
    Throws:
    
    HttpMalformedHeaderException - if the resulting HTTP header is malformed.
  - HttpRequestHeader
```
@Deprecated
public HttpRequestHeader(String method,
                                     org.apache.commons.httpclient.URI uri,
                                     String version,
                                     ConnectionParam params)
                              throws HttpMalformedHeaderException
```
    Deprecated. (2.8.0) Use HttpRequestHeader(String, URI, String) instead.
    Constructs a HttpRequestHeader with the given method, URI, and version.
    The following headers are automatically added:
    - Host, with the domain and port from the given URI.
    - User-Agent, using the getDefaultUserAgent().
    - Pragma: no-cache
    - Cache-Control: no-cache, if version is HTTP/1.1
    - Content-Type: application/x-www-form-urlencoded, if the method is POST or PUT.
    Parameters:
    
    method - the request method.
    
    uri - the request target.
    
    version - the version, for example, HTTP/1.1.
    
    params - unused.
    
    Throws:
    
    HttpMalformedHeaderException - if the resulting HTTP header is malformed.
    
    Since:
    
    2.4.2
- Method Detail
  - clear
```
public void clear()
```
    Overrides:
    
    clear in class HttpHeader
  - setMessage
```
public void setMessage(String data,
                       boolean isSecure)
                throws HttpMalformedHeaderException
```
    Set this request header with the given message.
    
    Parameters:
    
    data - the request header
    
    isSecure - true if the request should be secure, false otherwise
    
    Throws:
    
    HttpMalformedHeaderException - if the request being set is malformed
    
    See Also:
    
    setSecure(boolean)
  - setMessage
```
public void setMessage(String data)
                throws HttpMalformedHeaderException
```
    Set this request header with the given message. Whether this is a secure header depends on the URL given.
    
    Overrides:
    
    setMessage in class HttpHeader
    
    Throws:
    
    HttpMalformedHeaderException
  - getMethod
```
public String getMethod()
```
    Get the HTTP method (GET, POST ... etc).
    
    Returns:
    
    the request method
  - setMethod
```
public void setMethod(String method)
```
    Set the HTTP method of this request header.
    
    Parameters:
    
    method - the new method, must not be null.
  - getURI
```
public org.apache.commons.httpclient.URI getURI()
```
    Get the URI of this request header.
    
    Returns:
    
    the request URI
  - setURI
```
public void setURI(org.apache.commons.httpclient.URI uri)
            throws org.apache.commons.httpclient.URIException
```
    Sets the URI of this request header.
    
    Parameters:
    
    uri - the new request URI
    
    Throws:
    
    org.apache.commons.httpclient.URIException - if an error occurred while setting the request URI
  - getSecure
```
@Deprecated
public boolean getSecure()
```
    Deprecated. Replaced by isSecure(). It will be removed in a future release.
    
    Get if this request header is under secure connection.
    
    Returns:
    
    true if the request is secure, false otherwise
  - isSecure
```
public boolean isSecure()
```
    Tells whether the request is secure, or not. A request is considered secure if it's using the HTTPS protocol.
    
    Returns:
    
    true if the request is secure, false otherwise.
  - setSecure
```
public void setSecure(boolean isSecure)
               throws org.apache.commons.httpclient.URIException
```
    Sets whether or not the request is done using a secure scheme, HTTPS.
    
    Parameters:
    
    isSecure - true if the request should be secure, false otherwise
    
    Throws:
    
    org.apache.commons.httpclient.URIException - if an error occurred while rebuilding the request URI
  - setVersion
```
public void setVersion(String version)
```
    Set the HTTP version of this request header.
    
    Specified by:
    
    setVersion in class HttpHeader
  - getContentLength
```
public int getContentLength()
```
    Get the content length in this request header. If the content length is undetermined, 0 will be returned.
    
    Overrides:
    
    getContentLength in class HttpHeader
    
    Returns:
    
    content length. -1 means content length not set.
  - getHostName
```
public String getHostName()
```
    Get the host name in this request header.
    
    Returns:
    
    Host name.
  - getHostPort
```
public int getHostPort()
```
    Gets the host port number of this request message, a non-negative integer.
    If no port is defined the default port for the used scheme will be returned, either 80 for HTTP or 443 for HTTPS.
    
    Returns:
    
    the host port number, a non-negative integer
  - isImage
```
public boolean isImage()
```
    Return if this request header is a image request basing on the path suffix.
    
    Overrides:
    
    isImage in class HttpHeader
    
    Returns:
    
    true if image.
  - isRequestLine
```
public static boolean isRequestLine(String data)
```
    Return if the data given is a request header basing on the first start line.
    
    Parameters:
    
    data - the data to be checked
    
    Returns:
    
    true if the data contains a request line, false otherwise.
  - getPrimeHeader
```
public String getPrimeHeader()
```
    Return the prime header (first line).
    
    Specified by:
    
    getPrimeHeader in class HttpHeader
    
    Returns:
    
    startline for request, statusline for response.
  - parseURI
```
public static org.apache.commons.httpclient.URI parseURI(String sUri)
                                                  throws org.apache.commons.httpclient.URIException
```
    Throws:
    
    org.apache.commons.httpclient.URIException
  - setGetParams
```
public void setGetParams(TreeSet<HtmlParameter> getParams)
```
  - setCookies
```
public void setCookies(List<HttpCookie> cookies)
```
    Construct new "Cookie:" line in request header based on HttpCookies.
    
    Parameters:
    
    cookies - the new cookies
  - setCookieParams
```
public void setCookieParams(TreeSet<HtmlParameter> cookieParams)
```
  - getCookieParams
```
public TreeSet<HtmlParameter> getCookieParams()
```
  - getHttpCookies
```
public List<HttpCookie> getHttpCookies()
```
    Gets a list of the http cookies from this request Header.
    
    Returns:
    
    the http cookies
    
    Throws:
    
    IllegalArgumentException - if a problem is encountered while processing the "Cookie: " header line.
  - setSenderAddress
```
public void setSenderAddress(InetAddress inetAddress)
```
    Sets the senders IP address. Note that this is not persisted.
    
    Parameters:
    
    inetAddress - the senders IP address
    
    Since:
    
    2.6.0
  - getSenderAddress
```
public InetAddress getSenderAddress()
```
    Gets the senders IP address
    
    Returns:
    
    the senders IP address
    
    Since:
    
    2.6.0
  - setDefaultUserAgent
```
public static void setDefaultUserAgent(String defaultUserAgent)
```
    Sets the user agent used by default request header.
    This is expected to be called only by core code, when the corresponding option is changed.
    
    Parameters:
    
    defaultUserAgent - the default user agent.
    
    Since:
    
    2.8.0
  - getDefaultUserAgent
```
public static String getDefaultUserAgent()
```
    Gets the user agent used by default request header.
    
    Returns:
    
    the default user agent.
    
    Since:
    
    2.8.0

Class HttpRequestHeader

Field Summary

Fields inherited from class org.parosproxy.paros.network.HttpHeader

Constructor Summary

Method Summary

Methods inherited from class org.parosproxy.paros.network.HttpHeader

Methods inherited from class java.lang.Object

Field Detail

ACCEPT

ORIGIN

CONNECT

DELETE

GET

HEAD

OPTIONS

PATCH

POST

PUT

TRACE

TRACK

METHODS

HOST

Constructor Detail

HttpRequestHeader

HttpRequestHeader

HttpRequestHeader

HttpRequestHeader

HttpRequestHeader

Method Detail

clear

setMessage

setMessage

getMethod

setMethod

getURI

setURI

getSecure

isSecure

setSecure

setVersion

getContentLength

getHostName

getHostPort

isImage

isRequestLine

getPrimeHeader

parseURI

setGetParams

setCookies

setCookieParams

getCookieParams

getHttpCookies

setSenderAddress

getSenderAddress

setDefaultUserAgent

getDefaultUserAgent