|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WebResponse
Controls the response to the client, and specifically allows for creating the output stream (or
print writer) to which content is sent. This is essentially a generic version of
HttpServletResponse
. Some operations may be unsupported in some
implementations (for example, the portlet implementation can't handle any of the setHeader
methods).
Method Summary | |
---|---|
java.lang.String |
encodeURL(java.lang.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). |
java.lang.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. |
java.io.OutputStream |
getOutputStream(ContentType contentType)
Returns a output stream to which output should be sent. |
java.io.PrintWriter |
getPrintWriter(ContentType contentType)
Returns a PrintWriter to which output should be sent. |
void |
reset()
Resets any buffered content. |
void |
sendError(int statusCode,
java.lang.String message)
Sends an error response. |
void |
setContentLength(int contentLength)
|
void |
setDateHeader(java.lang.String name,
long date)
Sets a response header as a date. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Sets a response header as a string. |
void |
setIntHeader(java.lang.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. |
Method Detail |
---|
java.io.OutputStream getOutputStream(ContentType contentType) throws java.io.IOException
java.io.IOException
java.io.PrintWriter getPrintWriter(ContentType contentType) throws java.io.IOException
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.
java.io.IOException
java.lang.String encodeURL(java.lang.String url)
void reset()
void setContentLength(int contentLength)
java.lang.String getNamespace()
void setDateHeader(java.lang.String name, long date)
name
- the name of the header to setdate
- the date value to set, in milliseconds since the epochvoid setHeader(java.lang.String name, java.lang.String value)
name
- the name of the header to setvalue
- the value for the named headervoid setIntHeader(java.lang.String name, int value)
name
- the name of the header to setvalue
- the value for the named headervoid setStatus(int status)
void sendError(int statusCode, java.lang.String message) throws java.io.IOException
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |