Package org.omegazero.http.h1

Class HTTP1MessageTransmitter

java.lang.Object

org.omegazero.http.h1.HTTP1MessageTransmitter

public class HTTP1MessageTransmitter
extends Object

This class is used for transmitting HTTP headers.

HTTPRequests and HTTPResponses are supported by this class.

Since:

1.2.1

Field Summary

Fields

Modifier and Type	Field	Description
protected final WritableSocket	socket

Constructor Summary

Constructors

Constructor	Description
HTTP1MessageTransmitter()	Creates a new HTTP1MessageTransmitter.
HTTP1MessageTransmitter(WritableSocket socket)	Creates a new HTTP1MessageTransmitter.

Method Summary

Modifier and Type	Method	Description
protected void	addHeaders(HTTPMessage msg, StringBuilder sb)	Adds any headers that are not part of the default HTTPMessage header map.
static void	appendHeader(StringBuilder sb, String name, String value)	Appends a HTTP/1-style header to the given StringBuilder.
byte[]	generate(HTTPMessage msg)	Encodes the given HTTPMessage into a byte array.
WritableSocket	getSocket()	Returns the WritableSocket passed in the constructor.
protected String	getStartLine(HTTPMessage msg)	Returns the HTTP/1 start line of the given HTTPMessage.
void	send(HTTPMessage msg)	Encodes the given HTTPMessage using generate(HTTPMessage) and writes it to the WritableSocket passed in the constructor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

socket

protected final WritableSocket socket

Constructor Details

HTTP1MessageTransmitter

public HTTP1MessageTransmitter()

Creates a new HTTP1MessageTransmitter.

HTTP1MessageTransmitter

public HTTP1MessageTransmitter(WritableSocket socket)

Creates a new HTTP1MessageTransmitter.

Parameters:

socket - The socket to write encoded HTTPMessages to. This is only required is send(HTTPMessage) is used

Method Details

send

public void send(HTTPMessage msg)

Encodes the given HTTPMessage using generate(HTTPMessage) and writes it to the WritableSocket passed in the constructor.

Parameters:

msg - The HTTPMessage

See Also:

• generate(HTTPMessage)
• HTTP1MessageTransmitter(WritableSocket)

generate

public byte[] generate(HTTPMessage msg)

Encodes the given HTTPMessage into a byte array. This includes the request or response line (depending on the type of HTTPMessage), the HTTP headers and the terminating CR LF.

Parameters:

msg - The HTTPMessage

Returns:

The encoded data

getStartLine

protected String getStartLine(HTTPMessage msg)

Returns the HTTP/1 start line of the given HTTPMessage.

Parameters:

msg - The HTTPMessage

Returns:

The start line

addHeaders

protected void addHeaders(HTTPMessage msg,
 StringBuilder sb)

Adds any headers that are not part of the default HTTPMessage header map. For example, HTTPRequests have an additional Host header with the value of HTTPRequest.getAuthority().

Headers are added to the given StringBuilder using appendHeader(StringBuilder, String, String).

Parameters:

msg - The HTTPMessage

sb - The string builder

getSocket

public WritableSocket getSocket()

Returns the WritableSocket passed in the constructor.

Returns:

The WritableSocket

appendHeader

public static void appendHeader(StringBuilder sb,
 String name,
 String value)

Appends a HTTP/1-style header to the given StringBuilder.

Parameters:

sb - The string builder

name - The header name

value - The header value