HttpServletResponseWrapper (Java EE 5 SDK)

Java

Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.


javax.servlet.http Class HttpServletResponseWrapper

java.lang.Object
  extended by javax.servlet.ServletResponseWrapper
      extended by javax.servlet.http.HttpServletResponseWrapper
所有已实现的接口:
HttpServletResponse, ServletResponse

public class HttpServletResponseWrapper
extends ServletResponseWrapper
implements HttpServletResponse

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.

从以下版本开始:
v 2.3
作者:
Various
另请参见:
HttpServletResponse

字段摘要
 
Fields inherited from interface javax.servlet.http.HttpServletResponse
SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY
 
构造器摘要
HttpServletResponseWrapper(HttpServletResponse response)
          Constructs a response adaptor wrapping the given response.
 
方法摘要
 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.
 
类方法继承 javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse
 
类方法继承 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
 

构造器详细信息

HttpServletResponseWrapper

public HttpServletResponseWrapper(HttpServletResponse response)
Constructs a response adaptor wrapping the given response.

抛出异常:
IllegalArgumentException - if the response is null

方法详细信息

addCookie

public void addCookie(Cookie cookie)
The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.

规范说明:
addCookie in interface HttpServletResponse
参数:
cookie - the Cookie to return to the client

containsHeader

public boolean containsHeader(String name)
The default behavior of this method is to call containsHeader(String name) on the wrapped response object.

规范说明:
containsHeader in interface HttpServletResponse
参数:
name - the header name
返回:
true if the named response header has already been set; false otherwise

encodeURL

public String encodeURL(String url)
The default behavior of this method is to call encodeURL(String url) on the wrapped response object.

规范说明:
encodeURL in interface HttpServletResponse
参数:
url - the url to be encoded.
返回:
the encoded URL if encoding is needed; the unchanged URL otherwise.

encodeRedirectURL

public String encodeRedirectURL(String url)
The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.

规范说明:
encodeRedirectURL in interface HttpServletResponse
参数:
url - the url to be encoded.
返回:
the encoded URL if encoding is needed; the unchanged URL otherwise.
另请参见:
HttpServletResponse.sendRedirect(java.lang.String), HttpServletResponse.encodeUrl(java.lang.String)

encodeUrl

public String encodeUrl(String url)
The default behavior of this method is to call encodeUrl(String url) on the wrapped response object.

规范说明:
encodeUrl in interface HttpServletResponse
参数:
url - the url to be encoded.
返回:
the encoded URL if encoding is needed; the unchanged URL otherwise.

encodeRedirectUrl

public String encodeRedirectUrl(String url)
The default behavior of this method is to return encodeRedirectUrl(String url) on the wrapped response object.

规范说明:
encodeRedirectUrl in interface HttpServletResponse
参数:
url - the url to be encoded.
返回:
the encoded URL if encoding is needed; the unchanged URL otherwise.

sendError

public void sendError(int sc,
                      String msg)
               throws IOException
The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.

规范说明:
sendError in interface HttpServletResponse
参数:
sc - the error status code
msg - the descriptive message
抛出异常:
IOException - If an input or output exception occurs

sendError

public void sendError(int sc)
               throws IOException
The default behavior of this method is to call sendError(int sc) on the wrapped response object.

规范说明:
sendError in interface HttpServletResponse
参数:
sc - the error status code
抛出异常:
IOException - If an input or output exception occurs

sendRedirect

public void sendRedirect(String location)
                  throws IOException
The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.

规范说明:
sendRedirect in interface HttpServletResponse
参数:
location - the redirect location URL
抛出异常:
IOException - If an input or output exception occurs

setDateHeader

public 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.

规范说明:
setDateHeader in interface HttpServletResponse
参数:
name - the name of the header to set
date - the assigned date value
另请参见:
HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addDateHeader(java.lang.String, long)

addDateHeader

public 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.

规范说明:
addDateHeader in interface HttpServletResponse
参数:
name - the name of the header to set
date - the additional date value
另请参见:
HttpServletResponse.setDateHeader(java.lang.String, long)

setHeader

public 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.

规范说明:
setHeader in interface HttpServletResponse
参数:
name - the name of the header
value - 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)

addHeader

public 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.

规范说明:
addHeader in interface HttpServletResponse
参数:
name - the name of the header
value - 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)

setIntHeader

public 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.

规范说明:
setIntHeader in interface HttpServletResponse
参数:
name - the name of the header
value - the assigned integer value
另请参见:
HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addIntHeader(java.lang.String, int)

addIntHeader

public 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.

规范说明:
addIntHeader in interface HttpServletResponse
参数:
name - the name of the header
value - the assigned integer value
另请参见:
HttpServletResponse.setIntHeader(java.lang.String, int)

setStatus

public void setStatus(int sc)
The default behavior of this method is to call setStatus(int sc) on the wrapped response object.

规范说明:
setStatus in interface HttpServletResponse
参数:
sc - the status code
另请参见:
HttpServletResponse.sendError(int, java.lang.String)

setStatus

public 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.

规范说明:
setStatus in interface HttpServletResponse
参数:
sc - the status code
sm - the status message

Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.


提交错误或意见

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。深圳电信培训中心.徐海蛟老师教学参考.