net.officefloor.plugin.socket.server.http

Interface HttpResponse

All Known Implementing Classes:

HttpResponseImpl, ServletHttpResponse

public interface HttpResponse

HttpResponse for the ServerHttpConnection.

Author:

Daniel Sagenschneider

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.

Method Detail

setVersion

void setVersion(String version)

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.

Parameters:

version - HTTP version.

getVersion

String getVersion()

Obtains the HTTP version.

Returns:

HTTP version.

setStatus

void setStatus(int status)

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

This defaults to 200 assuming the request was processed successfully.

Parameters:

status - Status of the response.

getStatus

int getStatus()

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.

Returns:

Current status.

setStatus

void setStatus(int status,
               String statusMessage)

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

Parameters:

status - Status of the response.

statusMessage - Human readable status message.

See Also:

setStatus(int)

getStatusMessage

String getStatusMessage()

Obtains the current status message.

Returns:

Current status message.

See Also:

getStatus()

reset

void reset()
    throws IOException

Resets the HttpResponse by clearing HttpHeader instances and the entity.

Throws:

IOException - If committed to send the HttpResponse.

addHeader

HttpHeader addHeader(String name,
                     String value)
              throws 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:

HttpHeader instance added.

Throws:

IllegalArgumentException - Should the HttpHeader be managed by the HttpResponse.

getHeader

HttpHeader getHeader(String name)

Obtains the first HttpHeader by the name.

Parameters:

name - Name of the HttpHeader.

Returns:

First HttpHeader by the name.

getHeaders

HttpHeader[] getHeaders()

Obtains all the HttpHeader instances for the response.

Returns:

All the HttpHeader instances for the response.

removeHeader

void removeHeader(HttpHeader header)

Removes the particular HttpHeader from the response.

Parameters:

header - HttpHeader to be removed from the response.

removeHeaders

void removeHeaders(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.

setContentType

void setContentType(String contentType,
                    Charset charset)
             throws IOException

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

This must be specified before calling getEntityWriter().

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

getContentType

String getContentType()

Obtains the Content-Type.

Returns:

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

getContentCharset

Charset getContentCharset()

Obtains the Charset for the content.

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

Returns:

Charset.

getEntity

ServerOutputStream getEntity()
                      throws IOException

Obtains the ServerOutputStream to write the entity of the response.

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

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

Returns:

ServerOutputStream to write the entity of the response.

Throws:

IOException - Should getEntityWriter() already be provided.

See Also:

getEntityWriter(), send()

getEntityWriter

ServerWriter getEntityWriter()
                      throws IOException

Obtains the ServerWriter to write the entity of the response.

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

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

Returns:

ServerWriter to write the entity of the response.

Throws:

IOException - Should getEntity() already be provided.

See Also:

getEntity(), send()

send

void send()
   throws IOException

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

Throws:

IOException - If fails to send this HttpResponse.