org.glassfish.grizzly.http

Class HttpHeader.Builder<T extends HttpHeader.Builder>

java.lang.Object

org.glassfish.grizzly.http.HttpHeader.Builder<T>

Direct Known Subclasses:

HttpRequestPacket.Builder, HttpResponsePacket.Builder

Enclosing class:

HttpHeader

public abstract static class HttpHeader.Builder<T extends HttpHeader.Builder>
extends java.lang.Object

HttpHeader message builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	chunked
protected java.lang.Long	contentLength
protected java.lang.String	contentType
protected MimeHeaders	mimeHeaders
protected Protocol	protocol
protected java.lang.String	protocolString
protected java.lang.String	upgrade

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HttpHeader	build()
T	chunked(boolean chunked) Set true, if this HttpPacket content will be transferred in chunking mode, or false if case of fixed-length message.
T	contentLength(long contentLength) Set the content-length of this HttpPacket.
T	contentType(java.lang.String contentType) Set the content-type of this HttpPacket.
protected abstract HttpHeader	create()
T	header(Header header, java.lang.String value) Add the HTTP mime header.
T	header(java.lang.String name, java.lang.String value) Add the HTTP mime header.
T	maxNumHeaders(int maxHeaders) Sets the maximum number of headers allowed.
T	protocol(Protocol protocol) Set the HTTP message protocol version.
T	protocol(java.lang.String protocolString) Set the HTTP message protocol version.
T	removeHeader(Header header) Remove the specified header from this builder.
T	removeHeader(java.lang.String header) Remove the specified header from this builder.
void	reset()
T	upgrade(java.lang.String upgrade) Set the HTTP upgrade type.

Methods inherited from class java.lang.Object

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

Field Detail

protocol

protected Protocol protocol

protocolString

protected java.lang.String protocolString

chunked

protected java.lang.Boolean chunked

contentLength

protected java.lang.Long contentLength

contentType

protected java.lang.String contentType

upgrade

protected java.lang.String upgrade

mimeHeaders

protected MimeHeaders mimeHeaders

Constructor Detail

Builder

public Builder()

Method Detail

protocol

public final T protocol(Protocol protocol)

Set the HTTP message protocol version.

Parameters:

protocol - Protocol

protocol

public final T protocol(java.lang.String protocolString)

Set the HTTP message protocol version.

Parameters:

protocolString - protocol version in format "HTTP/1.x".

chunked

public final T chunked(boolean chunked)

Set true, if this HttpPacket content will be transferred in chunking mode, or false if case of fixed-length message.

Parameters:

chunked - true, if this HttpPacket content will be transferred in chunking mode, or false if case of fixed-length message.

contentLength

public final T contentLength(long contentLength)

Set the content-length of this HttpPacket. Applicable only in case of fixed-length HTTP message.

Parameters:

contentLength - the content-length of this HttpPacket. Applicable only in case of fixed-length HTTP message.

contentType

public final T contentType(java.lang.String contentType)

Set the content-type of this HttpPacket.

Parameters:

contentType - the content-type of this HttpPacket.

upgrade

public final T upgrade(java.lang.String upgrade)

Set the HTTP upgrade type.

Parameters:

upgrade - the type of upgrade.

header

public final T header(java.lang.String name,
                      java.lang.String value)

Add the HTTP mime header.

Parameters:

name - the mime header name.

value - the mime header value.

removeHeader

public final T removeHeader(java.lang.String header)

Remove the specified header from this builder. This method is only useful if using the same builder to create multiple objects.

Parameters:

header - the mime header.

Returns:

this

header

public final T header(Header header,
                      java.lang.String value)

Add the HTTP mime header.

Parameters:

header - the mime Header.

value - the mime header value.

removeHeader

public final T removeHeader(Header header)

Remove the specified header from this builder. This method is only useful if using the same builder to create multiple objects.

Parameters:

header - the mime Header.

Returns:

this

maxNumHeaders

public final T maxNumHeaders(int maxHeaders)

Sets the maximum number of headers allowed.

build

public HttpHeader build()

reset

public void reset()

create

protected abstract HttpHeader create()