| org.apache.tapestry.services.Response
All known Subclasses: org.apache.tapestry.internal.services.ResponseImpl, org.apache.tapestry.internal.test.TestableResponseImpl,
| Response | | public interface Response (Code) | | API agnostic wrapper for generating a response. Bridges the gaps between the Servlet API and the
Portlet API.
|
| Method Summary | |
| 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). | | 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). | | OutputStream | getOutputStream(String contentType)
Returns an OutputStream to which byte-oriented output may be sent. | | PrintWriter | getPrintWriter(String contentType)
Returns a PrintWriter object to which output may be sent. | | void | sendError(int sc, String message)
Sends an error response to the client using the specified status. | | void | sendRedirect(String URL)
Sends a redirect to the client. | | void | setContentLength(int length)
Sets the length of the content body in the response; this method sets the HTTP Content-Length
header. | | void | setDateHeader(String name, long date)
Sets a response header with the given name and date-value. | | void | setHeader(String name, String value)
Sets a response header with the given name and value. | | void | setIntHeader(String name, int value)
Sets a response header with the given name and integer value. |
| encodeRedirectURL | | String encodeRedirectURL(String URL)(Code) | | 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).
Parameters:
URL - the same URL or a different one with additional information to track the user session |
| encodeURL | | String encodeURL(String URL)(Code) | | 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).
Parameters:
URL - the same URL or a different one with additional information to track the user session |
| getOutputStream | | OutputStream getOutputStream(String contentType) throws IOException(Code) | | Returns an OutputStream to which byte-oriented output may be sent. Invoking flush() on the
stream will commit the output.
Parameters:
contentType - the MIME content type for the output, often "application/octet-stream" or"text/plain" or one of several others |
| getPrintWriter | | PrintWriter getPrintWriter(String contentType) throws IOException(Code) | | Returns a PrintWriter object to which output may be sent. Invoking flush() on the writer will
commit the output.
Parameters:
contentType - the MIME content type for the output, typically "text/html" |
| sendError | | void sendError(int sc, String message) throws IOException(Code) | | 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.
Parameters:
sc - the error status code
Parameters:
message - the descriptive message
exception:
IOException - If an input or output exception occurs
exception:
IllegalStateException - If the response was committed |
| setContentLength | | void setContentLength(int length)(Code) | | Sets the length of the content body in the response; this method sets the HTTP Content-Length
header.
Parameters:
length - the length of the content |
| setDateHeader | | void setDateHeader(String name, long date)(Code) | | 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.
Parameters:
name - the name of the header to set
Parameters:
date - the assigned date value |
| setHeader | | void setHeader(String name, String value)(Code) | | Sets a response header with the given name and value. If the header had already been set,
the new value overwrites the previous one.
Parameters:
name - the name of the header to set
Parameters:
value - the assigned value |
| setIntHeader | | void setIntHeader(String name, int value)(Code) | | 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.
Parameters:
name - the name of the header to set
Parameters:
value - the assigned integer value |
|
|