javax.servlet.http
类 HttpServletResponseWrapper

java.lang.Object
  继承者 javax.servlet.ServletResponseWrapper
      继承者 javax.servlet.http.HttpServletResponseWrapper
所有已实现的接口:
HttpServletResponse, ServletResponse
直接已知子类:
CompressedResponseWrapper, FormAuthenticator.FormResponse, ServletResponseWrapperInclude

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.

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

字段摘要
 
从接口 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)
          已过时。 As of version 2.1, use encodeRedirectURL(String url) instead
 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)
          已过时。 As of version 2.1, use encodeURL(String url) instead
 String encodeURL(String url)
          The default behavior of this method is to call encodeURL(String url) on the wrapped response object.
 String getHeader(String name)
          The default behaviour of this method is to call HttpServletResponse.getHeader(java.lang.String) on the wrapped response object.
 Collection<String> getHeaderNames()
          The default behaviour of this method is to call HttpServletResponse.getHeaderNames() on the wrapped response object.
 Collection<String> getHeaders(String name)
          The default behaviour of this method is to call HttpServletResponse.getHeaders(java.lang.String) on the wrapped response object.
 int getStatus()
          The default behaviour of this method is to call HttpServletResponse.getStatus() 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)
          已过时。 As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String)
 
从类 javax.servlet.ServletResponseWrapper 继承的方法
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
从接口 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.

指定者:
接口 HttpServletResponse 中的 addCookie
参数:
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.

指定者:
接口 HttpServletResponse 中的 containsHeader
参数:
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.

指定者:
接口 HttpServletResponse 中的 encodeURL
参数:
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.

指定者:
接口 HttpServletResponse 中的 encodeRedirectURL
参数:
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)
已过时。 As of version 2.1, use encodeURL(String url) instead

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

指定者:
接口 HttpServletResponse 中的 encodeUrl
参数:
url - the url to be encoded.
返回:
the encoded URL if encoding is needed; the unchanged URL otherwise.

encodeRedirectUrl

public String encodeRedirectUrl(String url)
已过时。 As of version 2.1, use encodeRedirectURL(String url) instead

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

指定者:
接口 HttpServletResponse 中的 encodeRedirectUrl
参数:
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.

指定者:
接口 HttpServletResponse 中的 sendError
参数:
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.

指定者:
接口 HttpServletResponse 中的 sendError
参数:
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.

指定者:
接口 HttpServletResponse 中的 sendRedirect
参数:
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.

指定者:
接口 HttpServletResponse 中的 setDateHeader
参数:
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.

指定者:
接口 HttpServletResponse 中的 addDateHeader
参数:
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.

指定者:
接口 HttpServletResponse 中的 setHeader
参数:
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.

指定者:
接口 HttpServletResponse 中的 addHeader
参数:
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.

指定者:
接口 HttpServletResponse 中的 setIntHeader
参数:
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.

指定者:
接口 HttpServletResponse 中的 addIntHeader
参数:
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.

指定者:
接口 HttpServletResponse 中的 setStatus
参数:
sc - the status code
另请参见:
HttpServletResponse.sendError(int, java.lang.String)

setStatus

public void setStatus(int sc,
                      String sm)
已过时。 As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String)

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

指定者:
接口 HttpServletResponse 中的 setStatus
参数:
sc - the status code
sm - the status message

getStatus

public int getStatus()
The default behaviour of this method is to call HttpServletResponse.getStatus() on the wrapped response object.

指定者:
接口 HttpServletResponse 中的 getStatus
返回:
the current status code of the wrapped response

getHeader

public String getHeader(String name)
The default behaviour of this method is to call HttpServletResponse.getHeader(java.lang.String) on the wrapped response object.

指定者:
接口 HttpServletResponse 中的 getHeader
参数:
name - the name of the response header whose value to return
返回:
the value of the response header with the given name, or null if no header with the given name has been set on the wrapped response
从以下版本开始:
Servlet 3.0

getHeaders

public Collection<String> getHeaders(String name)
The default behaviour of this method is to call HttpServletResponse.getHeaders(java.lang.String) on the wrapped response object.

Any changes to the returned Collection must not affect this HttpServletResponseWrapper.

指定者:
接口 HttpServletResponse 中的 getHeaders
参数:
name - the name of the response header whose values to return
返回:
a (possibly empty) Collection of the values of the response header with the given name
从以下版本开始:
Servlet 3.0

getHeaderNames

public Collection<String> getHeaderNames()
The default behaviour of this method is to call HttpServletResponse.getHeaderNames() on the wrapped response object.

Any changes to the returned Collection must not affect this HttpServletResponseWrapper.

指定者:
接口 HttpServletResponse 中的 getHeaderNames
返回:
a (possibly empty) Collection of the names of the response headers
从以下版本开始:
Servlet 3.0


Copyright © 2013. All Rights Reserved.