|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Response
API agnostic wrapper for generating a response. Bridges the gaps between the Servlet API and the Portlet API.
The Response service is a shadow of the current thread's response object.
Method Summary | |
---|---|
void |
disableCompression()
Invoked to indicate that the response content is either already compressed, or is not compressable. |
java.lang.String |
encodeRedirectURL(java.lang.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). |
java.lang.String |
encodeURL(java.lang.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). |
java.io.OutputStream |
getOutputStream(java.lang.String contentType)
Returns an OutputStream to which byte-oriented output may be sent. |
java.io.PrintWriter |
getPrintWriter(java.lang.String contentType)
Returns a PrintWriter object to which output may be sent. |
boolean |
isCommitted()
Returns true if the response has already been sent, either as a redirect or as a stream of content. |
void |
sendError(int sc,
java.lang.String message)
Sends an error response to the client using the specified status. |
void |
sendRedirect(Link link)
Sends a redirect to a link. |
void |
sendRedirect(java.lang.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(java.lang.String name,
long date)
Sets a response header with the given name and date-value. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Sets a response header with the given name and value. |
void |
setIntHeader(java.lang.String name,
int value)
Sets a response header with the given name and integer value. |
void |
setStatus(int sc)
Sets the status code for this response. |
Method Detail |
---|
java.io.PrintWriter getPrintWriter(java.lang.String contentType) throws java.io.IOException
contentType
- the MIME content type for the output, typically "text/html"
java.io.IOException
java.io.OutputStream getOutputStream(java.lang.String contentType) throws java.io.IOException
contentType
- the MIME content type for the output, often "application/octet-stream" or "text/plain" or one
of several others
java.io.IOException
void sendRedirect(java.lang.String URL) throws java.io.IOException
URL
- full or partial (relative) URL to send to the client
java.io.IOException
encodeRedirectURL(String)
void sendRedirect(Link link) throws java.io.IOException
link
- link to redirect to.
java.io.IOException
void setStatus(int sc)
sendError
method should be used instead.
sc
- the status codevoid sendError(int sc, java.lang.String message) throws java.io.IOException
sc
- the error status codemessage
- the descriptive message
java.io.IOException
- If an input or output exception occurs
java.lang.IllegalStateException
- If the response was committedvoid setContentLength(int length)
length
- the length of the contentvoid setDateHeader(java.lang.String name, long date)
name
- the name of the header to setdate
- the assigned date valuevoid setHeader(java.lang.String name, java.lang.String value)
name
- the name of the header to setvalue
- the assigned valuevoid setIntHeader(java.lang.String name, int value)
name
- the name of the header to setvalue
- the assigned integer valuejava.lang.String encodeURL(java.lang.String URL)
URL
-
java.lang.String encodeRedirectURL(java.lang.String URL)
URL
-
boolean isCommitted()
void disableCompression()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |