|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.ServletResponseWrapper
javax.servlet.http.HttpServletResponseWrapper
Provides a convenient implementation of the HttpServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped response object.
HttpServletResponse
Field Summary |
Constructor Summary | |
HttpServletResponseWrapper(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(String name,
long date)
The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object. |
void |
addHeader(String name,
String value)
The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object. |
void |
addIntHeader(String name,
int value)
The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object. |
boolean |
containsHeader(String name)
The default behavior of this method is to call containsHeader(String name) on the wrapped response object. |
String |
encodeRedirectUrl(String url)
The default behavior of this method is to return encodeRedirectUrl(String url) on the wrapped response object. |
String |
encodeRedirectURL(String url)
The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object. |
String |
encodeUrl(String url)
The default behavior of this method is to call encodeUrl(String url) on the wrapped response object. |
String |
encodeURL(String url)
The default behavior of this method is to call encodeURL(String url) on the wrapped response object. |
void |
sendError(int sc)
The default behavior of this method is to call sendError(int sc) on the wrapped response object. |
void |
sendError(int sc,
String msg)
The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object. |
void |
sendRedirect(String location)
The default behavior of this method is to return sendRedirect(String location) on the wrapped response object. |
void |
setDateHeader(String name,
long date)
The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object. |
void |
setHeader(String name,
String value)
The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object. |
void |
setIntHeader(String name,
int value)
The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object. |
void |
setStatus(int sc)
The default behavior of this method is to call setStatus(int sc) on the wrapped response object. |
void |
setStatus(int sc,
String sm)
The default behavior of this method is to call setStatus(int sc, String sm) on the wrapped response object. |
Methods inherited from class javax.servlet.ServletResponseWrapper |
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, 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, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale |
Constructor Detail |
public HttpServletResponseWrapper(HttpServletResponse response)
IllegalArgumentException
- if the response is nullMethod Detail |
public void addCookie(Cookie cookie)
addCookie
in interface HttpServletResponse
cookie
- the Cookie to return to the clientpublic boolean containsHeader(String name)
containsHeader
in interface HttpServletResponse
name
- the header name
true
if the named response header
has already been set;
false
otherwisepublic String encodeURL(String url)
encodeURL
in interface HttpServletResponse
url
- the url to be encoded.
public String encodeRedirectURL(String url)
encodeRedirectURL
in interface HttpServletResponse
url
- the url to be encoded.
HttpServletResponse.sendRedirect(java.lang.String)
,
HttpServletResponse.encodeUrl(java.lang.String)
public String encodeUrl(String url)
encodeUrl
in interface HttpServletResponse
url
- the url to be encoded.
public String encodeRedirectUrl(String url)
encodeRedirectUrl
in interface HttpServletResponse
url
- the url to be encoded.
public void sendError(int sc, String msg) throws IOException
sendError
in interface HttpServletResponse
sc
- the error status codemsg
- the descriptive message
IOException
- If an input or output exception occurspublic void sendError(int sc) throws IOException
sendError
in interface HttpServletResponse
sc
- the error status code
IOException
- If an input or output exception occurspublic void sendRedirect(String location) throws IOException
sendRedirect
in interface HttpServletResponse
location
- the redirect location URL
IOException
- If an input or output exception occurspublic void setDateHeader(String name, long date)
setDateHeader
in interface HttpServletResponse
name
- the name of the header to setdate
- the assigned date valueHttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addDateHeader(java.lang.String, long)
public void addDateHeader(String name, long date)
addDateHeader
in interface HttpServletResponse
name
- the name of the header to setdate
- the additional date valueHttpServletResponse.setDateHeader(java.lang.String, long)
public void setHeader(String name, String value)
setHeader
in interface HttpServletResponse
name
- the name of the headervalue
- the header value If it contains octet string,
it should be encoded according to RFC 2047
(http://www.ietf.org/rfc/rfc2047.txt)HttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addHeader(java.lang.String, java.lang.String)
public void addHeader(String name, String value)
addHeader
in interface HttpServletResponse
name
- the name of the headervalue
- the additional header value If it contains
octet string, it should be encoded
according to RFC 2047
(http://www.ietf.org/rfc/rfc2047.txt)HttpServletResponse.setHeader(java.lang.String, java.lang.String)
public void setIntHeader(String name, int value)
setIntHeader
in interface HttpServletResponse
name
- the name of the headervalue
- the assigned integer valueHttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addIntHeader(java.lang.String, int)
public void addIntHeader(String name, int value)
addIntHeader
in interface HttpServletResponse
name
- the name of the headervalue
- the assigned integer valueHttpServletResponse.setIntHeader(java.lang.String, int)
public void setStatus(int sc)
setStatus
in interface HttpServletResponse
sc
- the status codeHttpServletResponse.sendError(int, java.lang.String)
public void setStatus(int sc, String sm)
setStatus
in interface HttpServletResponse
sc
- the status codesm
- the status message
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |