API agnostic wrapper for generating a response. Bridges the gaps between the Servlet API and the Portlet API.
The Response service is a {@linkplain org.apache.tapestry5.ioc.services.PropertyShadowBuilder shadow} of the current
thread's response object.
| Method from org.apache.tapestry5.services.Response Detail: |
|---|
 public String encodeRedirectURL(String URL)
Encodes the URL for use as a redirect, ensuring that a session id is included (if a session exists, and as
necessary depending on the client browser's use of cookies). |
public String encodeURL(String URL) Encodes the URL, ensuring that a session id is included (if a session exists, and as necessary depending on the
client browser's use of cookies). |
public OutputStream getOutputStream(String contentType) throws IOException Returns an OutputStream to which byte-oriented output may be sent. Invoking flush() on the stream will commit the
output. |
public PrintWriter getPrintWriter(String contentType) throws IOException Returns a PrintWriter object to which output may be sent. Invoking flush() on the writer will commit the output. |
public boolean isCommitted() Returns true if the response has already been sent, either as a redirect or as a stream of content. |
public void sendError(int sc,
String message) throws IOException Sends an error response to the client using the specified status. The server defaults to creating the response to
look like an HTML-formatted server error page containing the specified message, setting the content type to
"text/html", leaving cookies and other headers unmodified. If an error-page declaration has been made for the web
application corresponding to the status code passed in, it will be served back in preference to the suggested msg
parameter.
If the response has already been committed, this method throws an IllegalStateException. After using this method,
the response should be considered to be committed and should not be written to. |
public void sendRedirect(String URL) throws IOException Sends a redirect to the client. |
public void sendRedirect(Link link) throws IOException Sends a redirect to a link. |
public void setContentLength(int length) Sets the length of the content body in the response; this method sets the HTTP Content-Length header. |
public void setDateHeader(String name,
long date) Sets a response header with the given name and date-value. The date is specified in terms of milliseconds since
the epoch. If the header had already been set, the new value overwrites the previous one. |
public void setHeader(String name,
String value) Sets a response header with the given name and value. If the header had already been set, the new value
overwrites the previous one. |
public void setIntHeader(String name,
int value) Sets a response header with the given name and integer value. If the header had already been set, the new value
overwrites the previous one. |
public void setStatus(int sc) Sets the status code for this response. This method is used to set the return status code when there is no error
(for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes
to invoke an error-page defined in the web applicaion, the sendError method should be used instead. |