|
SunONE Application Server v8.0 PE | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.servlet.ServletResponseWrapper javax.servlet.http.HttpServletResponseWrapper com.sun.appserv.web.cache.filter.CachingResponseWrapper
a wrapper to HttpServletResponse to cache the outbound headers and content
and
,
HttpServletResponse
Field Summary |
Constructor Summary | |
CachingResponseWrapper(HttpServletResponse response)
Constructs a response adaptor wrapping the given response. |
Method Summary | |
void |
addCookie(Cookie cookie)
The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object. |
void |
addDateHeader(java.lang.String name,
long value)
Add the specified date header to the specified value. |
void |
addHeader(java.lang.String name,
java.lang.String value)
Add the specified header to the specified value. |
void |
addIntHeader(java.lang.String name,
int value)
Add the specified integer header to the specified value. |
HttpCacheEntry |
cacheResponse()
called by doFilter to cache the response that was just sent out |
void |
clear()
clear the contents of this wrapper |
java.lang.Long |
getExpiresDateHeader()
return the Expires: date header value |
ServletOutputStream |
getOutputStream()
Return the servlet output stream associated with this Response. |
java.io.PrintWriter |
getWriter()
Return the writer associated with this Response. |
boolean |
isError()
has the response been set to error |
void |
sendError(int status)
Send an error response with the specified status and a default message. |
void |
sendError(int status,
java.lang.String message)
Send an error response with the specified status and message. |
void |
setContentLength(int len)
Set the content length (in bytes) for this Response. |
void |
setContentType(java.lang.String type)
Set the content type for this Response. |
void |
setDateHeader(java.lang.String name,
long value)
Set the specified date header to the specified value. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Set the specified header to the specified value. |
void |
setIntHeader(java.lang.String name,
int value)
Set the specified integer header to the specified value. |
void |
setLocale(java.util.Locale locale)
Set the Locale that is appropriate for this response, including setting the appropriate character encoding. |
void |
setStatus(int sc)
Set the HTTP status to be returned with this response. |
Methods inherited from class javax.servlet.http.HttpServletResponseWrapper |
containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendRedirect, setStatus |
Methods inherited from class javax.servlet.ServletResponseWrapper |
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setResponse |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.ServletResponse |
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding |
Constructor Detail |
public CachingResponseWrapper(HttpServletResponse response)
java.lang.IllegalArgumentException
- if the response is nullMethod Detail |
public ServletOutputStream getOutputStream() throws java.io.IOException
getOutputStream
in interface ServletResponse
getOutputStream
in class ServletResponseWrapper
java.lang.IllegalStateException
- if getWriter
has
already been called for this response
java.io.IOException
- if an input/output error occurspublic java.io.PrintWriter getWriter() throws java.io.IOException
getWriter
in interface ServletResponse
getWriter
in class ServletResponseWrapper
java.lang.IllegalStateException
- if getOutputStream
has
already been called for this response
java.io.IOException
- if an input/output error occurspublic void setContentLength(int len)
setContentLength
in interface ServletResponse
setContentLength
in class ServletResponseWrapper
public void setContentType(java.lang.String type)
setContentType
in interface ServletResponse
setContentType
in class ServletResponseWrapper
type
- The new content typepublic void setLocale(java.util.Locale locale)
setLocale
in interface ServletResponse
setLocale
in class ServletResponseWrapper
locale
- The new localepublic void addCookie(Cookie cookie)
addCookie
in interface HttpServletResponse
addCookie
in class HttpServletResponseWrapper
public void setHeader(java.lang.String name, java.lang.String value)
setHeader
in interface HttpServletResponse
setHeader
in class HttpServletResponseWrapper
name
- Name of the header to setvalue
- Value to be setpublic void setIntHeader(java.lang.String name, int value)
setIntHeader
in interface HttpServletResponse
setIntHeader
in class HttpServletResponseWrapper
name
- Name of the header to setvalue
- Integer value to be setpublic void addHeader(java.lang.String name, java.lang.String value)
addHeader
in interface HttpServletResponse
addHeader
in class HttpServletResponseWrapper
name
- Name of the header to setvalue
- Value to be setpublic void addIntHeader(java.lang.String name, int value)
addIntHeader
in interface HttpServletResponse
addIntHeader
in class HttpServletResponseWrapper
name
- Name of the header to setvalue
- Integer value to be setpublic void setDateHeader(java.lang.String name, long value)
setDateHeader
in interface HttpServletResponse
setDateHeader
in class HttpServletResponseWrapper
name
- Name of the header to setvalue
- Date value to be setpublic void addDateHeader(java.lang.String name, long value)
addDateHeader
in interface HttpServletResponse
addDateHeader
in class HttpServletResponseWrapper
name
- Name of the header to setvalue
- Date value to be setpublic void setStatus(int sc)
setStatus
in interface HttpServletResponse
setStatus
in class HttpServletResponseWrapper
public void sendError(int status) throws java.io.IOException
sendError
in interface HttpServletResponse
sendError
in class HttpServletResponseWrapper
status
- HTTP status code to send
java.lang.IllegalStateException
- if this response has
already been committed
java.io.IOException
- if an input/output error occurspublic void sendError(int status, java.lang.String message) throws java.io.IOException
sendError
in interface HttpServletResponse
sendError
in class HttpServletResponseWrapper
status
- HTTP status code to sendmessage
- Corresponding message to send
java.lang.IllegalStateException
- if this response has
already been committed
java.io.IOException
- if an input/output error occurspublic boolean isError()
public java.lang.Long getExpiresDateHeader()
public HttpCacheEntry cacheResponse() throws java.io.IOException
java.io.IOException
public void clear()
|
SunONE Application Server v8.0 PE | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved.