org.apache.tapestry.web
Class ServletWebResponse

java.lang.Object
  org.apache.tapestry.web.ServletWebResponse

All Implemented Interfaces:

WebResponse

public class ServletWebResponse
extends Object
implements WebResponse

Adapts HttpServletResponse as WebResponse.

Since:

4.0

Author:

Howard M. Lewis Ship

Constructor Summary

ServletWebResponse(HttpServletResponse response)

Method Summary

String	encodeURL(String url) Encodes a URL, which adds information to the URL needed to ensure that the request triggered by the URL will be associated with the current session (if any).
String	getNamespace() Returns a value to be prefixed or suffixed with any client-side JavaScript elements (variables and function names) to ensure that they are unique with the context of the entire page.
OutputStream	getOutputStream(ContentType contentType) Returns a output stream to which output should be sent.
PrintWriter	getPrintWriter(ContentType contentType) Returns a PrintWriter to which output should be sent.
void	reset() Resets any buffered content.
void	sendError(int statusCode, String message) Sends an error response.
void	setContentLength(int length) Sets the response content length header.
void	setDateHeader(String name, long date) Sets a response header as a date.
void	setHeader(String name, String value) Sets a response header as a string.
void	setIntHeader(String name, int value) Sets a response header with the given name and integer value.
void	setStatus(int status) Sets the status code for this response.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletWebResponse

public ServletWebResponse(HttpServletResponse response)

Method Detail

getOutputStream

public OutputStream getOutputStream(ContentType contentType)

Description copied from interface: WebResponse

Returns a output stream to which output should be sent. This method should only be invoked once on a response.

Specified by:

getOutputStream in interface WebResponse

Parameters:

contentType - The encoding type that this outputstream will write content as.

Returns:

the output stream, configured for the given type.

getPrintWriter

public PrintWriter getPrintWriter(ContentType contentType)
                           throws IOException

Description copied from interface: WebResponse

Returns a PrintWriter to which output should be sent. This method should be invoked once on a response. A second call is expected to be so that an exception page can be rendered, and the underlying request data is reset.

Specified by:

getPrintWriter in interface WebResponse

Parameters:

contentType - The type of content encoding the writer is for.

Returns:

A new PrintWriter instance.

Throws:

IOException - On io error.

encodeURL

public String encodeURL(String url)

Description copied from interface: WebResponse

Encodes a URL, which adds information to the URL needed to ensure that the request triggered by the URL will be associated with the current session (if any). In most cases, the string is returned unchanged.

Specified by:

encodeURL in interface WebResponse

Parameters:

url - The URL to encode.

Returns:

The url encoded.

reset

public void reset()

Description copied from interface: WebResponse

Resets any buffered content. This may be used after an error to radically change what the output will be.

Specified by:

reset in interface WebResponse

setContentLength

public void setContentLength(int length)

Description copied from interface: WebResponse

Sets the response content length header.

Specified by:

setContentLength in interface WebResponse

Parameters:

length - The total content length this response will write.

getNamespace

public String getNamespace()

Description copied from interface: WebResponse

Returns a value to be prefixed or suffixed with any client-side JavaScript elements (variables and function names) to ensure that they are unique with the context of the entire page. For servlets, this is the empty string.

Specified by:

getNamespace in interface WebResponse

Returns:

The namespace that this requests resources should be pre-pended with.

setDateHeader

public void setDateHeader(String name,
                          long date)

Description copied from interface: WebResponse

Sets a response header as a date.

Specified by:

setDateHeader in interface WebResponse

Parameters:

name - the name of the header to set

date - the date value to set, in milliseconds since the epoch

setStatus

public void setStatus(int status)

Description copied from interface: WebResponse

Sets the status code for this response.

Specified by:

setStatus in interface WebResponse

Parameters:

status - The HTTP status code to set on the return header.

setHeader

public void setHeader(String name,
                      String value)

Description copied from interface: WebResponse

Sets a response header as a string.

Specified by:

setHeader in interface WebResponse

Parameters:

name - the name of the header to set

value - the value for the named header

setIntHeader

public void setIntHeader(String name,
                         int value)

Description copied from interface: WebResponse

Sets a response header with the given name and integer value.

Specified by:

setIntHeader in interface WebResponse

Parameters:

name - the name of the header to set

value - the value for the named header

sendError

public void sendError(int statusCode,
                      String message)
               throws IOException

Description copied from interface: WebResponse

Sends an error response.

Specified by:

sendError in interface WebResponse

Parameters:

statusCode - The error status code to set on the header.

message - The message to give as the reason for error.

Throws:

IOException - on io error.