| 
 | J2EE1.4 SDK | |||||||||
| 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(java.lang.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(java.lang.String name,
          java.lang.String value)The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object. | 
|  void | addIntHeader(java.lang.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(java.lang.String name)The default behavior of this method is to call containsHeader(String name) on the wrapped response object. | 
|  java.lang.String | encodeRedirectUrl(java.lang.String url)The default behavior of this method is to return encodeRedirectUrl(String url) on the wrapped response object. | 
|  java.lang.String | encodeRedirectURL(java.lang.String url)The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object. | 
|  java.lang.String | encodeUrl(java.lang.String url)The default behavior of this method is to call encodeUrl(String url) on the wrapped response object. | 
|  java.lang.String | encodeURL(java.lang.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,
          java.lang.String msg)The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object. | 
|  void | sendRedirect(java.lang.String location)The default behavior of this method is to return sendRedirect(String location) on the wrapped response object. | 
|  void | setDateHeader(java.lang.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(java.lang.String name,
          java.lang.String value)The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object. | 
|  void | setIntHeader(java.lang.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,
          java.lang.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)
java.lang.IllegalArgumentException - if the response is null| Method Detail | 
public void addCookie(Cookie cookie)
addCookie in interface HttpServletResponsecookie - the Cookie to return to the clientpublic boolean containsHeader(java.lang.String name)
containsHeader in interface HttpServletResponsename - the header name
true if the named response header 
			has already been set; 
 			false otherwisepublic java.lang.String encodeURL(java.lang.String url)
encodeURL in interface HttpServletResponseurl - the url to be encoded.
public java.lang.String encodeRedirectURL(java.lang.String url)
encodeRedirectURL in interface HttpServletResponseurl - the url to be encoded.
HttpServletResponse.sendRedirect(java.lang.String), 
HttpServletResponse.encodeUrl(java.lang.String)public java.lang.String encodeUrl(java.lang.String url)
encodeUrl in interface HttpServletResponseurl - the url to be encoded.
public java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectUrl in interface HttpServletResponseurl - the url to be encoded.
public void sendError(int sc,
                      java.lang.String msg)
               throws java.io.IOException
sendError in interface HttpServletResponsesc - the error status codemsg - the descriptive message
java.io.IOException - If an input or output exception occurs
public void sendError(int sc)
               throws java.io.IOException
sendError in interface HttpServletResponsesc - the error status code
java.io.IOException - If an input or output exception occurs
public void sendRedirect(java.lang.String location)
                  throws java.io.IOException
sendRedirect in interface HttpServletResponselocation - the redirect location URL
java.io.IOException - If an input or output exception occurs
public void setDateHeader(java.lang.String name,
                          long date)
setDateHeader in interface HttpServletResponsename - the name of the header to setdate - the assigned date valueHttpServletResponse.containsHeader(java.lang.String), 
HttpServletResponse.addDateHeader(java.lang.String, long)
public void addDateHeader(java.lang.String name,
                          long date)
addDateHeader in interface HttpServletResponsename - the name of the header to setdate - the additional date valueHttpServletResponse.setDateHeader(java.lang.String, long)
public void setHeader(java.lang.String name,
                      java.lang.String value)
setHeader in interface HttpServletResponsename - 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(java.lang.String name,
                      java.lang.String value)
addHeader in interface HttpServletResponsename - 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(java.lang.String name,
                         int value)
setIntHeader in interface HttpServletResponsename - the name of the headervalue - the assigned integer valueHttpServletResponse.containsHeader(java.lang.String), 
HttpServletResponse.addIntHeader(java.lang.String, int)
public void addIntHeader(java.lang.String name,
                         int value)
addIntHeader in interface HttpServletResponsename - the name of the headervalue - the assigned integer valueHttpServletResponse.setIntHeader(java.lang.String, int)public void setStatus(int sc)
setStatus in interface HttpServletResponsesc - the status codeHttpServletResponse.sendError(int, java.lang.String)
public void setStatus(int sc,
                      java.lang.String sm)
setStatus in interface HttpServletResponsesc - the status codesm - the status message| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.