serguei.http

Class HttpResponseHeaders

java.lang.Object

serguei.http.HttpResponseHeaders

public final class HttpResponseHeaders
extends Object

This represents response headers - combination of the the status 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 response headers in the server

Author:

Serguei Poliakov

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
HttpResponseHeaders(InputStream inputStream) This creates an instance of this class by reading status line and headers from a stream
HttpResponseHeaders(String statusLine, String... headers) This creates an instance of HttpResponseHeaders

Method Summary

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
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	getReason()
int	getStatusCode()
String	getVersion()
boolean	hasChunkedBody()
List<String>	listHeaderNames()
static HttpResponseHeaders	notFound()
static HttpResponseHeaders	ok()
protected void	readHeaders(serguei.http.HeaderLineReader reader) Read headers into the stream
static HttpResponseHeaders	redirectTo(String location)
void	removeHeader(String headerName) Removes header with a specified name
static HttpResponseHeaders	serverError()
void	setHeader(String headerName, String value) Sets header If headers with this name already exists, replaces it
String	toString()
void	write(OutputStream outputStream) Write headers into the stream

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

HttpResponseHeaders

public HttpResponseHeaders(String statusLine,
                           String... headers)
                    throws HttpException

This creates an instance of HttpResponseHeaders

Parameters:

statusLine - - status line, e.g. "GET / HTTP/1."

headers - - headers in the form "Content-Length: 100"

Throws:

HttpException - - can be thrown when status line or headers do not follow HTTP standards

HttpResponseHeaders

public HttpResponseHeaders(InputStream inputStream)
                    throws IOException

This creates an instance of this class by reading status line and headers from a stream

Parameters:

inputStream -

Throws:

IOException - - thrown when the data is not HTTP or IO errors

Method Detail

ok

public static HttpResponseHeaders ok()

redirectTo

public static HttpResponseHeaders redirectTo(String location)

notFound

public static HttpResponseHeaders notFound()

serverError

public static HttpResponseHeaders serverError()

write

public void write(OutputStream outputStream)
           throws IOException

Write headers into the stream

Throws:

IOException

toString

public String toString()

getVersion

public String getVersion()

getStatusCode

public int getStatusCode()

getReason

public String getReason()

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