|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WrappedResponse
A generic response from the server, wrapping a more specific response type, e.g. HttpServletResponse or PortletResponse.
Method Summary | |
---|---|
DeploymentConfiguration |
getDeploymentConfiguration()
Gets the deployment configuration for the context of this response. |
OutputStream |
getOutputStream()
Returns a OutputStream for writing binary data in the
response. |
PrintWriter |
getWriter()
Returns a PrintWriter object that can send character text to
the client. |
void |
sendError(int errorCode,
String message)
Sends an error response to the client using the specified status code and clears the buffer. |
void |
setCacheTime(long milliseconds)
Sets cache time in milliseconds, -1 means no cache at all. |
void |
setContentType(String contentType)
Sets the content type of this response. |
void |
setDateHeader(String name,
long timestamp)
Properly formats a timestamp as a date header. |
void |
setHeader(String name,
String value)
Sets the value of a generic response header. |
void |
setStatus(int statusCode)
Sets the (http) status code for the response. |
Method Detail |
---|
void setStatus(int statusCode)
sendError(int, String)
instead.
statusCode
- the status code to setHttpServletResponse.setStatus(int)
,
ResourceResponse#HTTP_STATUS_CODE
void setContentType(String contentType)
getWriter()
is invoked, the returned
PrintWriter will automatically use the defined charset.
contentType
- a string specifying the MIME type of the contentServletResponse.setContentType(String)
,
MimeResponse#setContentType(String)
void setHeader(String name, String value)
name
- the name of the headervalue
- the header value.HttpServletResponse.setHeader(String, String)
,
PortletResponse#setProperty(String, String)
void setDateHeader(String name, long timestamp)
name
- the name of the headertimestamp
- the number of milliseconds since epochHttpServletResponse.setDateHeader(String, long)
OutputStream getOutputStream() throws IOException
OutputStream
for writing binary data in the
response.
Either this method or getWriter() may be called to write the response, not both.
OutputStream
for writing binary data
IOException
- if an input or output exception occurredgetWriter()
,
ServletResponse.getOutputStream()
,
MimeResponse#getPortletOutputStream()
PrintWriter getWriter() throws IOException
PrintWriter
object that can send character text to
the client. The PrintWriter uses the character encoding defined using
setContentType.
Either this method or getOutputStream() may be called to write the response, not both.
PrintWriter
for writing character text
IOException
- if an input or output exception occurredgetOutputStream()
,
ServletResponse.getWriter()
,
MimeResponse#getWriter()
void setCacheTime(long milliseconds)
milliseconds
- Cache time in millisecondsvoid sendError(int errorCode, String message) throws IOException
errorCode
- the HTTP status codemessage
- a message to accompany the error
IOException
- if an input or output exception occursHttpServletResponse.sendError(int, String)
DeploymentConfiguration getDeploymentConfiguration()
DeploymentConfiguration
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |