net.officefloor.plugin.socket.server.http.conversation.impl

Class HttpResponseImpl

java.lang.Object

net.officefloor.plugin.socket.server.http.conversation.impl.HttpResponseImpl

All Implemented Interfaces:

HttpResponse

public class HttpResponseImpl
extends Object
implements HttpResponse

HttpResponse.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
HttpResponseImpl(HttpConversationImpl conversation, Connection connection, String httpVersion) Initiate.
HttpResponseImpl(HttpConversationImpl conversation, Connection connection, String httpVersion, Serializable momento) Initiate.

Method Summary

Modifier and Type	Method and Description
HttpHeader	addHeader(String name, String value) Adds a HttpHeader for the response.
Charset	getContentCharset() Obtains the Charset for the content.
String	getContentType() Obtains the Content-Type.
ServerOutputStream	getEntity() Obtains the ServerOutputStream to write the entity of the response.
ServerWriter	getEntityWriter() Obtains the ServerWriter to write the entity of the response.
HttpHeader	getHeader(String name) Obtains the first HttpHeader by the name.
HttpHeader[]	getHeaders() Obtains all the HttpHeader instances for the response.
int	getStatus() Obtains the status.
String	getStatusMessage() Obtains the current status message.
String	getVersion() Obtains the HTTP version.
void	removeHeader(HttpHeader header) Removes the particular HttpHeader from the response.
void	removeHeaders(String name) Removes all HttpHeader instances by the name.
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	setStatus(int status) Specifies the status of the response with the default status message.
void	setStatus(int status, String statusMessage) Specifies the status of the response including specifying the status human readable message.
void	setVersion(String version) Allows specifying the HTTP version on the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponseImpl

public HttpResponseImpl(HttpConversationImpl conversation,
                        Connection connection,
                        String httpVersion)

Initiate.

Parameters:

conversation - HttpConversationImpl.

connection - Connection.

httpVersion - HTTP version.

HttpResponseImpl

public HttpResponseImpl(HttpConversationImpl conversation,
                        Connection connection,
                        String httpVersion,
                        Serializable momento)

Initiate.

Parameters:

conversation - HttpConversationImpl.

connection - Connection.

httpVersion - HTTP version.

momento - Momento containing the state for this HttpResponse.

Method Detail

setVersion

public void setVersion(String version)

Description copied from interface: HttpResponse

Allows specifying the HTTP version on the response. Values should be either HTTP/1.0 or HTTP/1.1.

This defaults to value on HttpRequest.

Specified by:

setVersion in interface HttpResponse

Parameters:

version - HTTP version.

getVersion

public String getVersion()

Description copied from interface: HttpResponse

Obtains the HTTP version.

Specified by:

getVersion in interface HttpResponse

Returns:

HTTP version.

setStatus

public void setStatus(int status)

Description copied from interface: HttpResponse

Specifies the status of the response with the default status message.

This defaults to 200 assuming the request was processed successfully.

Specified by:

setStatus in interface HttpResponse

Parameters:

status - Status of the response.

getStatus

public int getStatus()

Description copied from interface: HttpResponse

Obtains the status.

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 status.

setStatus

public void setStatus(int status,
                      String statusMessage)

Description copied from interface: HttpResponse

Specifies the status of the response including specifying the status human readable message.

Specified by:

setStatus in interface HttpResponse

Parameters:

status - Status of the response.

statusMessage - Human readable status message.

See Also:

HttpResponse.setStatus(int)

getStatusMessage

public String getStatusMessage()

Description copied from interface: HttpResponse

Obtains the current status message.

Specified by:

getStatusMessage in interface HttpResponse

Returns:

Current status message.

See Also:

HttpResponse.getStatus()

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.

addHeader

public HttpHeader addHeader(String name,
                            String value)

Description copied from interface: HttpResponse

Adds a HttpHeader for the response.

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

Specified by:

addHeader in interface HttpResponse

Parameters:

name - Name of HttpHeader.

value - Value of HttpHeader.

Returns:

HttpHeader instance added.

getHeader

public HttpHeader getHeader(String name)

Description copied from interface: HttpResponse

Obtains the first HttpHeader by the name.

Specified by:

getHeader in interface HttpResponse

Parameters:

name - Name of the HttpHeader.

Returns:

First HttpHeader by the name.

getHeaders

public HttpHeader[] getHeaders()

Description copied from interface: HttpResponse

Obtains all the HttpHeader instances for the response.

Specified by:

getHeaders in interface HttpResponse

Returns:

All the HttpHeader instances for the response.

removeHeader

public void removeHeader(HttpHeader header)

Description copied from interface: HttpResponse

Removes the particular HttpHeader from the response.

Specified by:

removeHeader in interface HttpResponse

Parameters:

header - HttpHeader to be removed from the response.

removeHeaders

public void removeHeaders(String name)

Description copied from interface: HttpResponse

Removes all HttpHeader instances by the name.

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

Specified by:

removeHeaders in interface HttpResponse

Parameters:

name - Name of the HttpHeader instances to remove.

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()

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.

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.

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()

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.