Package net.officefloor.server.http

Interface HttpResponse

All Known Subinterfaces:

MockHttpResponseBuilder

All Known Implementing Classes:

ProcessAwareHttpResponse

public interface HttpResponse

HttpResponse for the ServerHttpConnection.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
java.nio.charset.Charset	getContentCharset()	Obtains the Charset for the content.
java.lang.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.
void	reset()	Resets the HttpResponse by clearing HttpHeader instances and the entity.
void	send()	Sends this HttpResponse.
void	setContentType(java.lang.String contentType, java.nio.charset.Charset charset)	Specifies the Content-Type and optionally the Charset.
void	setContentType(HttpHeaderValue contentTypeAndCharsetValue, java.nio.charset.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.

Method Detail

getVersion

HttpVersion getVersion()

Obtains the HttpVersion.

Returns:

HttpVersion.

setVersion

void setVersion(HttpVersion version)

Override the HttpVersion.

This defaults to value on HttpRequest.

Parameters:

version - HttpVersion.

getStatus

HttpStatus getStatus()

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.

Returns:

Current HttpStatus.

setStatus

void setStatus(HttpStatus status)

Specifies the HttpStatus.

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

Parameters:

status - HttpStatus.

getHeaders

HttpResponseHeaders getHeaders()

Obtains the HttpResponseHeaders.

Returns:

HttpResponseHeaders.

getCookies

HttpResponseCookies getCookies()

Obtains the HttpResponseCookies.

Returns:

HttpResponseCookies.

setContentType

void setContentType(java.lang.String contentType,
                    java.nio.charset.Charset charset)
             throws java.io.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 (including the default HTTP content encoding).

Throws:

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

setContentType

void setContentType(HttpHeaderValue contentTypeAndCharsetValue,
                    java.nio.charset.Charset charset)
             throws java.io.IOException

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.

Parameters:

contentTypeAndCharsetValue - HttpHeaderValue for the Content-Type and charset.

charset - Charset to configure the ServerWriter.

Throws:

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

getContentType

java.lang.String getContentType()

Obtains the Content-Type.

Returns:

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

getContentCharset

java.nio.charset.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 java.io.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:

java.io.IOException - Should getEntityWriter() already be provided.

See Also:

getEntityWriter(), send()

getEntityWriter

ServerWriter getEntityWriter()
                      throws java.io.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:

java.io.IOException - Should getEntity() already be provided.

See Also:

getEntity(), send()

getEscalationHandler

HttpEscalationHandler getEscalationHandler()

Obtains the HttpEscalationHandler.

Returns:

HttpEscalationHandler or null if no HttpEscalationHandler configured.

setEscalationHandler

void setEscalationHandler(HttpEscalationHandler escalationHandler)

Sets the HttpEscalationHandler for the response.

Parameters:

escalationHandler - HttpEscalationHandler for the response.

reset

void reset()
    throws java.io.IOException

Resets the HttpResponse by clearing HttpHeader instances and the entity.

Throws:

java.io.IOException - If committed to send the HttpResponse.

send

void send()
   throws java.io.IOException

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

Throws:

java.io.IOException - If fails to send this HttpResponse.