Package net.officefloor.server.http.impl

Class ProcessAwareHttpResponseHeaders

java.lang.Object

net.officefloor.server.http.impl.ProcessAwareHttpResponseHeaders

All Implemented Interfaces:

java.lang.Iterable<HttpHeader>, HttpResponseHeaders

public class ProcessAwareHttpResponseHeaders
extends java.lang.Object
implements HttpResponseHeaders

ProcessState aware HttpResponseHeaders.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ProcessAwareHttpResponseHeaders(ManagedObjectContext context)	Instantiate.

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.
WritableHttpHeader	getWritableHttpHeaders()	Obtains the head WritableHttpHeader to the linked list of WritableHttpHeader instances for the HttpResponseWriter.
java.util.Iterator<HttpHeader>	iterator()
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 class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ProcessAwareHttpResponseHeaders

public ProcessAwareHttpResponseHeaders(ManagedObjectContext context)

Instantiate.

Parameters:

context - ManagedObjectContext.

Method Detail

getWritableHttpHeaders

public WritableHttpHeader getWritableHttpHeaders()

Obtains the head WritableHttpHeader to the linked list of WritableHttpHeader instances for the HttpResponseWriter.

Returns:

Head WritableHttpHeader to the linked list of WritableHttpHeader instances for the HttpResponseWriter. May be null.

iterator

public java.util.Iterator<HttpHeader> iterator()

Specified by:

iterator in interface java.lang.Iterable<HttpHeader>

addHeader

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

Description copied from interface: HttpResponseHeaders

Adds a HttpHeader for the response.

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

Specified by:

addHeader in interface HttpResponseHeaders

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

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

Description copied from interface: HttpResponseHeaders

Adds a HttpHeader.

Specified by:

addHeader in interface HttpResponseHeaders

Parameters:

name - HttpHeaderName.

value - Value of HttpHeader.

Returns:

Added HttpHeader

Throws:

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

addHeader

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

Description copied from interface: HttpResponseHeaders

Adds a HttpHeader.

Specified by:

addHeader in interface HttpResponseHeaders

Parameters:

name - Name of HttpHeader.

value - HttpHeaderValue.

Returns:

Added HttpHeader.

Throws:

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

addHeader

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

Description copied from interface: HttpResponseHeaders

Adds a HttpHeader.

Specified by:

addHeader in interface HttpResponseHeaders

Parameters:

name - HttpHeaderName.

value - HttpHeaderValue.

Returns:

Added HttpHeader.

Throws:

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

removeHeader

public boolean removeHeader(HttpHeader header)

Description copied from interface: HttpResponseHeaders

Removes the particular HttpHeader from the response.

Specified by:

removeHeader in interface HttpResponseHeaders

Parameters:

header - HttpHeader to be removed from the response.

Returns:

true if the HttpHeader was removed.

removeHeaders

public boolean removeHeaders(java.lang.String name)

Description copied from interface: HttpResponseHeaders

Removes all HttpHeader instances by the name.

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

Specified by:

removeHeaders in interface HttpResponseHeaders

Parameters:

name - Name of the HttpHeader instances to remove.

Returns:

true if HttpHeader instances were removed by the name.

getHeader

public HttpHeader getHeader(java.lang.String name)

Description copied from interface: HttpResponseHeaders

Obtains the first HttpHeader by the name.

Specified by:

getHeader in interface HttpResponseHeaders

Parameters:

name - Name of the HttpHeader.

Returns:

First HttpHeader or null if not HttpHeader.

getHeaders

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

Description copied from interface: HttpResponseHeaders

Obtains all the HttpHeader instances by the name.

Specified by:

getHeaders in interface HttpResponseHeaders

Parameters:

name - Name of the HttpHeader instances.

Returns:

All HttpHeader instances by the name.