javax.servlet.http
クラス HttpServletResponseWrapper

java.lang.Object
  |
  +--javax.servlet.ServletResponseWrapper
        |
        +--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

バージョン:

$Version$

作成者:

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_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, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setContentLength, setContentType, setLocale, setResponse

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェース javax.servlet.ServletResponse から継承したメソッド

flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, 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)

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.

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

関連項目:

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

関連項目:

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

関連項目:

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

関連項目:

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)

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