Package net.officefloor.server.http

Interface HttpResponseHeaders

All Superinterfaces:

java.lang.Iterable<HttpHeader>

All Known Implementing Classes:

ProcessAwareHttpResponseHeaders

public interface HttpResponseHeaders
extends java.lang.Iterable<HttpHeader>

HttpHeader instances for the HttpResponse.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
HttpHeader	addHeader(java.lang.String name, java.lang.String value)	Adds a HttpHeader for the response.
HttpHeader	addHeader(java.lang.String name, HttpHeaderValue value)	Adds a HttpHeader.
HttpHeader	addHeader(HttpHeaderName name, java.lang.String value)	Adds a HttpHeader.
HttpHeader	addHeader(HttpHeaderName name, HttpHeaderValue value)	Adds a HttpHeader.
HttpHeader	getHeader(java.lang.String name)	Obtains the first HttpHeader by the name.
java.lang.Iterable<HttpHeader>	getHeaders(java.lang.String name)	Obtains all the HttpHeader instances by the name.
boolean	removeHeader(HttpHeader header)	Removes the particular HttpHeader from the response.
boolean	removeHeaders(java.lang.String name)	Removes all HttpHeader instances by the name.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

addHeader

HttpHeader addHeader(java.lang.String name,
                     java.lang.String value)
              throws java.lang.IllegalArgumentException

Adds a HttpHeader for the response.

HttpHeader instances are provided on the response in the order they are added.

Parameters:

name - Name of HttpHeader.

value - Value of HttpHeader.

Returns:

Added HttpHeader.

Throws:

java.lang.IllegalArgumentException - Should the HttpHeader be managed by the HttpResponse.

addHeader

HttpHeader addHeader(HttpHeaderName name,
                     java.lang.String value)
              throws java.lang.IllegalArgumentException

Adds a HttpHeader.

Parameters:

name - HttpHeaderName.

value - Value of HttpHeader.

Returns:

Added HttpHeader

Throws:

java.lang.IllegalArgumentException - Should the HttpHeader be managed by the HttpResponse.

addHeader

HttpHeader addHeader(java.lang.String name,
                     HttpHeaderValue value)
              throws java.lang.IllegalArgumentException

Adds a HttpHeader.

Parameters:

name - Name of HttpHeader.

value - HttpHeaderValue.

Returns:

Added HttpHeader.

Throws:

java.lang.IllegalArgumentException - Should the HttpHeader be managed by the HttpResponse.

addHeader

HttpHeader addHeader(HttpHeaderName name,
                     HttpHeaderValue value)
              throws java.lang.IllegalArgumentException

Adds a HttpHeader.

Parameters:

name - HttpHeaderName.

value - HttpHeaderValue.

Returns:

Added HttpHeader.

Throws:

java.lang.IllegalArgumentException - Should the HttpHeader be managed by the HttpResponse.

removeHeader

boolean removeHeader(HttpHeader header)

Removes the particular HttpHeader from the response.

Parameters:

header - HttpHeader to be removed from the response.

Returns:

true if the HttpHeader was removed.

removeHeaders

boolean removeHeaders(java.lang.String name)

Removes all HttpHeader instances by the name.

This method compliments addHeader(String, String) to allow adding a new single HttpHeader instance by name.

Parameters:

name - Name of the HttpHeader instances to remove.

Returns:

true if HttpHeader instances were removed by the name.

getHeader

HttpHeader getHeader(java.lang.String name)

Obtains the first HttpHeader by the name.

Parameters:

name - Name of the HttpHeader.

Returns:

First HttpHeader or null if not HttpHeader.

getHeaders

java.lang.Iterable<HttpHeader> getHeaders(java.lang.String name)

Obtains all the HttpHeader instances by the name.

Parameters:

name - Name of the HttpHeader instances.

Returns:

All HttpHeader instances by the name.