HttpRequestHeaders (http 1.0.30 API)

java.lang.Object
- serguei.http.HttpRequestHeaders

```
public final class HttpRequestHeaders
extends Object
```
This represents request headers - combination of the the request line and the following headers as specified in RFC-2616: https://tools.ietf.org/html/rfc2616 This class is mutable and it is not thread safe. One would directly create and manipulate instance of this class to prepare request headers in the client

Author:

Serguei Poliakov

Field Summary

Fields
Modifier and Type Field and Description

protected static byte[] SPACE

Fields
Modifier and Type	Field and Description
`protected static byte[]`	`SPACE`

Constructor Summary

Constructors
Constructor and Description
`HttpRequestHeaders(InputStream inputStream)` This creates an instance of this class by reading request line and headers from a stream
`HttpRequestHeaders(String requestLine, String... headers)` This creates an instance of HttpRequestHeaders

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addHeader(String line)` Adds a header, if header header with this name already exists, it adds a new entry without deleting existing
`void`	`addHeader(String headerName, String headerValue)` Adds a header, if header header with this name already exists, it adds a new entry without deleting existing
`static HttpRequestHeaders`	`connectRequest(String host)` Creates request headers for CONNECT request
`long`	`getContentLength()`
`String`	`getHeader(String headerName)` This returns a header by name, if there are more then one header with this name, the first one will be returned Returns null if header does not exit
`List<String>`	`getHeaders(String headerName)` This returns headers by name, if there are more then one header with this name, all of them will be returned
`String`	`getHost()` This returns host from Host header or, if Host header does not exist (e.g.
`String`	`getMethod()`
`String`	`getPath()`
`static HttpRequestHeaders`	`getRequest(String url)` Creates request headers for GET request
`URL`	`getUrl()` This returns Url based on command line and host header.
`String`	`getVersion()`
`boolean`	`hasChunkedBody()`
`List<String>`	`listHeaderNames()`
`static HttpRequestHeaders`	`postRequest(String url)` Creates request headers for POST request
`protected void`	`readHeaders(serguei.http.HeaderLineReader reader)` Read headers into the stream
`void`	`removeHeader(String headerName)` Removes header with a specified name
`void`	`setHeader(String headerName, String value)` Sets header If headers with this name already exists, replaces it
`String`	`toString()`
`void`	`write(OutputStream outputStream)` This writes the request line and headers into the output stream This includes an empty line separating headers and body (i.e.

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

- Field Detail
  - SPACE
```
protected static final byte[] SPACE
```
- Constructor Detail
  - HttpRequestHeaders
```
public HttpRequestHeaders(String requestLine,
                          String... headers)
                   throws HttpException
```
    This creates an instance of HttpRequestHeaders
    
    Parameters:
    
    requestLine - - request line, e.g. "GET / HTTP/1."
    
    headers - - headers in the form "Host: www.google.co.uk"
    
    Throws:
    
    HttpException - - can be thrown when request line or headers do not follow HTTP standards
  - HttpRequestHeaders
```
public HttpRequestHeaders(InputStream inputStream)
                   throws IOException
```
    This creates an instance of this class by reading request line and headers from a stream
    
    Parameters:
    
    inputStream -
    
    Throws:
    
    IOException - - thrown when the data is not HTTP or IO errors
- Method Detail
  - getUrl
```
public URL getUrl()
           throws HttpException
```
    This returns Url based on command line and host header. If request line contains host, it has a priority over what is specified in host header
    
    Throws:
    
    HttpException - - thrown when URL is incorrect
  - getHost
```
public String getHost()
               throws HttpException
```
    This returns host from Host header or, if Host header does not exist (e.g. when HTTP/1.0) then from path in command line
    
    Throws:
    
    HttpException - - thrown if there was an error parsing path in request line
  - write
```
public void write(OutputStream outputStream)
           throws IOException
```
    This writes the request line and headers into the output stream This includes an empty line separating headers and body (i.e. you can start writing the body immediately after this)
    
    Throws:
    
    IOException
  - getMethod
```
public String getMethod()
```
    Returns:
    
    request method (e.g. "GET", "POST")
  - getVersion
```
public String getVersion()
```
    Returns:
    
    HTTP version (e.g. "HTTP/1.1")
  - getPath
```
public String getPath()
```
    Returns:
    
    Path as specified in Request Line
  - toString
```
public String toString()
```
  - connectRequest
```
public static HttpRequestHeaders connectRequest(String host)
```
    Creates request headers for CONNECT request
  - getRequest
```
public static HttpRequestHeaders getRequest(String url)
                                     throws IOException
```
    Creates request headers for GET request
    
    Throws:
    
    IOException
  - postRequest
```
public static HttpRequestHeaders postRequest(String url)
                                      throws IOException
```
    Creates request headers for POST request
    
    Throws:
    
    IOException
  - readHeaders
```
protected void readHeaders(serguei.http.HeaderLineReader reader)
                    throws IOException
```
    Read headers into the stream
    
    Throws:
    
    IOException
  - getHeader
```
public String getHeader(String headerName)
```
    This returns a header by name, if there are more then one header with this name, the first one will be returned Returns null if header does not exit
  - getHeaders
```
public List<String> getHeaders(String headerName)
```
    This returns headers by name, if there are more then one header with this name, all of them will be returned
  - getContentLength
```
public long getContentLength()
```
    Returns:
    
    content length or -1 if content length is not defined
  - hasChunkedBody
```
public boolean hasChunkedBody()
```
    Returns:
    
    true if the body is chunked or false if not
  - addHeader
```
protected void addHeader(String line)
                  throws HttpException
```
    Adds a header, if header header with this name already exists, it adds a new entry without deleting existing
    
    Throws:
    
    HttpException
  - setHeader
```
public void setHeader(String headerName,
                      String value)
```
    Sets header If headers with this name already exists, replaces it
  - addHeader
```
public void addHeader(String headerName,
                      String headerValue)
```
    Adds a header, if header header with this name already exists, it adds a new entry without deleting existing
  - removeHeader
```
public void removeHeader(String headerName)
```
    Removes header with a specified name
  - listHeaderNames
```
public List<String> listHeaderNames()
```
    Returns:
    
    List of header names

Class HttpRequestHeaders

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SPACE

Constructor Detail

HttpRequestHeaders

HttpRequestHeaders

Method Detail

getUrl

getHost

write

getMethod

getVersion

getPath

toString

connectRequest

getRequest

postRequest

readHeaders

getHeader

getHeaders

getContentLength

hasChunkedBody

addHeader

setHeader

addHeader

removeHeader

listHeaderNames