Package net.officefloor.server.http.impl

Class ProcessAwareHttpResponse<B>

java.lang.Object

net.officefloor.server.http.impl.ProcessAwareHttpResponse<B>

All Implemented Interfaces:

HttpExternalResponse, HttpResponse, CloseHandler

public class ProcessAwareHttpResponse<B>
extends Object
implements HttpResponse, HttpExternalResponse, CloseHandler

Serializable HttpResponse.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ProcessAwareHttpResponse(ProcessAwareServerHttpConnectionManagedObject<B> serverHttpConnection, HttpVersion version, ManagedObjectContext managedObjectContext)	Instantiate.

Method Summary

Modifier and Type	Method	Description
void	close()	Handles the close.
void	externalSend()	Flags that HttpResponse is externally sent.
void	flushResponseToHttpResponseWriter(Throwable escalation)	Flushes the HttpResponse to the HttpResponseWriter.
Charset	getContentCharset()	Obtains the Charset for the content.
String	getContentType()	Obtains the Content-Type.
HttpResponseCookies	getCookies()	Obtains the HttpResponseCookies.
ServerOutputStream	getEntity()	Obtains the ServerOutputStream to write the entity of the response.
ServerWriter	getEntityWriter()	Obtains the ServerWriter to write the entity of the response.
HttpEscalationHandler	getEscalationHandler()	Obtains the HttpEscalationHandler.
HttpResponseHeaders	getHeaders()	Obtains the HttpResponseHeaders.
HttpStatus	getStatus()	Obtains the HttpStatus.
HttpVersion	getVersion()	Obtains the HttpVersion.
boolean	isClosed()	Indicates if closed.
void	reset()	Resets the HttpResponse by clearing HttpHeader instances and the entity.
void	send()	Sends this HttpResponse.
void	setContentType(String contentType, Charset charset)	Specifies the Content-Type and optionally the Charset.
void	setContentType(HttpHeaderValue contentTypeAndCharsetValue, Charset charset)	Provides means to use HttpHeaderValue to specify both the Content-Type and charset for more efficiency.
void	setEscalationHandler(HttpEscalationHandler escalationHandler)	Sets the HttpEscalationHandler for the response.
void	setStatus(HttpStatus status)	Specifies the HttpStatus.
void	setVersion(HttpVersion version)	Override the HttpVersion.

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessAwareHttpResponse

public ProcessAwareHttpResponse(ProcessAwareServerHttpConnectionManagedObject<B> serverHttpConnection,
 HttpVersion version,
 ManagedObjectContext managedObjectContext)

Instantiate.

Parameters:

serverHttpConnection - ServerHttpConnection.

version - HttpVersion.

managedObjectContext - ManagedObjectContext.

Method Details

flushResponseToHttpResponseWriter

public void flushResponseToHttpResponseWriter(Throwable escalation)
                                       throws IOException

Flushes the HttpResponse to the HttpResponseWriter.

Parameters:

escalation - Possible escalation in servicing. Will be null if successful.

Throws:

IOException - If fails to flush HttpResponse to the HttpResponseWriter.

getVersion

public HttpVersion getVersion()

Description copied from interface: HttpResponse

Obtains the HttpVersion.

Specified by:

getVersion in interface HttpResponse

Returns:

HttpVersion.

setVersion

public void setVersion(HttpVersion version)

Description copied from interface: HttpResponse

Override the HttpVersion.

This defaults to value on HttpRequest.

Specified by:

setVersion in interface HttpResponse

Parameters:

version - HttpVersion.

getStatus

public HttpStatus getStatus()

Description copied from interface: HttpResponse

Obtains the HttpStatus.

This is the current status. The status may changed based on particular HTTP rules (e.g. 200 becoming 204 due to no entity) or there being a failure in processing the message.

Specified by:

getStatus in interface HttpResponse

Returns:

Current HttpStatus.

setStatus

public void setStatus(HttpStatus status)

Description copied from interface: HttpResponse

Specifies the HttpStatus.

This defaults to HttpStatus.OK assuming the request was processed successfully.

Specified by:

setStatus in interface HttpResponse

Parameters:

status - HttpStatus.

getHeaders

public HttpResponseHeaders getHeaders()

Description copied from interface: HttpResponse

Obtains the HttpResponseHeaders.

Specified by:

getHeaders in interface HttpResponse

Returns:

HttpResponseHeaders.

getCookies

public HttpResponseCookies getCookies()

Description copied from interface: HttpResponse

Obtains the HttpResponseCookies.

Specified by:

getCookies in interface HttpResponse

Returns:

HttpResponseCookies.

setContentType

public void setContentType(String contentType,
 Charset charset)
                    throws IOException

Description copied from interface: HttpResponse

Specifies the Content-Type and optionally the Charset. The charset parameter will automatically be added to the Content-Type on using the HttpResponse.getEntityWriter().

This must be specified before calling HttpResponse.getEntityWriter().

Specified by:

setContentType in interface HttpResponse

Parameters:

contentType - Content-Type. May be null to unset the Content-Type.

charset - Charset for the Content-Type. This may be null to use the default Charset. Also use null for Content-Types that do not require character encoding (including the default HTTP content encoding).

Throws:

IOException - If attempting to specify after calling HttpResponse.getEntityWriter().

setContentType

public void setContentType(HttpHeaderValue contentTypeAndCharsetValue,
 Charset charset)
                    throws IOException

Description copied from interface: HttpResponse

Provides means to use HttpHeaderValue to specify both the Content-Type and charset for more efficiency.

Note that HttpHeaderValue will require the inclusion of the charset, as the charset will not be appended.

Specified by:

setContentType in interface HttpResponse

Parameters:

contentTypeAndCharsetValue - HttpHeaderValue for the Content-Type and charset.

charset - Charset to configure the ServerWriter.

Throws:

IOException - If attempting to specify after calling HttpResponse.getEntityWriter().

getContentType

public String getContentType()

Description copied from interface: HttpResponse

Obtains the Content-Type.

Specified by:

getContentType in interface HttpResponse

Returns:

Content-Type. May be null if no Content-Type has been specified.

getContentCharset

public Charset getContentCharset()

Description copied from interface: HttpResponse

Obtains the Charset for the content.

If no Charset has been specified, the default Charset will be returned.

Specified by:

getContentCharset in interface HttpResponse

Returns:

Charset.

getEntity

public ServerOutputStream getEntity()
                             throws IOException

Description copied from interface: HttpResponse

Obtains the ServerOutputStream to write the entity of the response.

Only one of HttpResponse.getEntity() or HttpResponse.getEntityWriter() may be called.

Closing the returned ServerOutputStream is similar to calling HttpResponse.send().

Specified by:

getEntity in interface HttpResponse

Returns:

ServerOutputStream to write the entity of the response.

Throws:

IOException - Should HttpResponse.getEntityWriter() already be provided.

See Also:

• HttpResponse.getEntityWriter()
• HttpResponse.send()

getEntityWriter

public ServerWriter getEntityWriter()
                             throws IOException

Description copied from interface: HttpResponse

Obtains the ServerWriter to write the entity of the response.

Only one of HttpResponse.getEntity() or HttpResponse.getEntityWriter() may be called.

Closing the returned ServerOutputStream is similar to calling HttpResponse.send().

Specified by:

getEntityWriter in interface HttpResponse

Returns:

ServerWriter to write the entity of the response.

Throws:

IOException - Should HttpResponse.getEntity() already be provided.

See Also:

• HttpResponse.getEntity()
• HttpResponse.send()

getEscalationHandler

public HttpEscalationHandler getEscalationHandler()

Description copied from interface: HttpResponse

Obtains the HttpEscalationHandler.

Specified by:

getEscalationHandler in interface HttpResponse

Returns:

HttpEscalationHandler or null if no HttpEscalationHandler configured.

setEscalationHandler

public void setEscalationHandler(HttpEscalationHandler escalationHandler)

Description copied from interface: HttpResponse

Sets the HttpEscalationHandler for the response.

Specified by:

setEscalationHandler in interface HttpResponse

Parameters:

escalationHandler - HttpEscalationHandler for the response.

reset

public void reset()
           throws IOException

Description copied from interface: HttpResponse

Resets the HttpResponse by clearing HttpHeader instances and the entity.

Specified by:

reset in interface HttpResponse

Throws:

IOException - If committed to send the HttpResponse.

send

public void send()
          throws IOException

Description copied from interface: HttpResponse

Sends this HttpResponse. After calling this the ServerOutputStream or ServerWriter is closed.

Specified by:

send in interface HttpResponse

Throws:

IOException - If fails to send this HttpResponse.

externalSend

public void externalSend()

Description copied from interface: HttpExternalResponse

Flags that HttpResponse is externally sent.

Specified by:

externalSend in interface HttpExternalResponse

isClosed

public boolean isClosed()

Description copied from interface: CloseHandler

Indicates if closed.

Specified by:

isClosed in interface CloseHandler

Returns:

true if closed.

close

public void close()
           throws IOException

Description copied from interface: CloseHandler

Handles the close.

Specified by:

close in interface CloseHandler

Throws:

IOException - If fails to close.