javax.servlet.http
クラス HttpServletResponseWrapper

java.lang.Object
  |
  +--javax.servlet.ServletResponseWrapper
        |
        +--javax.servlet.http.HttpServletResponseWrapper

すべての実装インタフェース:

HttpServletResponse, ServletResponse

public class HttpServletResponseWrapper

extends ServletResponseWrapper

implements HttpServletResponse

サーブレットからのレスポンスを改変したい開発者たちの手でサブクラス化による拡張を可能とする、HttpServletResponseインターフェースの簡潔な実装方法を提供します。 このクラスは、Wrapperパターン もしくは Decoratorパターンに基づいて実装されています。各々のメソッドは、ラップされたレスポンス・オブジェクトのメソッドをデフォルトで呼び出します。

導入されたバージョン:

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)
指定したレスポンスをラッピングしたレスポンス・アダプタを構築します。

メソッドの概要

void	addCookie(Cookie cookie) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるaddCookie(Cookie cookie)メソッドをそのまま呼び出します。
void	addDateHeader(String name, long date) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるaddDateHeader(String name, long date)メソッドをそのまま呼び出します。
void	addHeader(String name, String value) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるaddHeader(String name, String value)メソッドをそのまま呼び出します。
void	addIntHeader(String name, int value) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるaddIntHeader(String name, int value)メソッドをそのまま呼び出します。
boolean	containsHeader(String name) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるcontainsHeader(String name)メソッドをそのまま呼び出します。
String	encodeRedirectUrl(String url) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるencodeRedirectUrl(String url)メソッドをそのまま呼び出します。
String	encodeRedirectURL(String url) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるencodeRedirectURL(String url)メソッドをそのまま呼び出します。
String	encodeUrl(String url) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるencodeUrl(String url)メソッドをそのまま呼び出します。
String	encodeURL(String url) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるencodeURL(String url)メソッドをそのまま呼び出します。
void	sendError(int sc) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsendError(int sc)メソッドをそのまま呼び出します。
void	sendError(int sc, String msg) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsendError(int sc, String msg)メソッドをそのまま呼び出します。
void	sendRedirect(String location) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsendRedirect(String location)メソッドをそのまま呼び出します。
void	setDateHeader(String name, long date) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetDateHeader(String name, long date)メソッドをそのまま呼び出します。
void	setHeader(String name, String value) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetHeader(String name, String value)メソッドをそのまま呼び出します。
void	setIntHeader(String name, int value) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetIntHeader(String name, int value)メソッドをそのまま呼び出します。
void	setStatus(int sc) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetStatus(int sc)メソッドをそのまま呼び出します。
void	setStatus(int sc, String sm) このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetStatus(int sc, String sm)メソッドをそのまま呼び出します。

クラス 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)

指定したレスポンスをラッピングしたレスポンス・アダプタを構築します。

例外:

IllegalArgumentException - response が null である場合

メソッドの詳細

addCookie

public void addCookie(Cookie cookie)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるaddCookie(Cookie cookie)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の addCookie

パラメータ:

cookie - クライアントに返すCookie

containsHeader

public boolean containsHeader(String name)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるcontainsHeader(String name)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の containsHeader

パラメータ:

name - ヘッダ名

戻り値:

指定された名前のレスポンスヘッダが既にセットされていれば true、そうでなければfalse

encodeURL

public String encodeURL(String url)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるencodeURL(String url)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の encodeURL

パラメータ:

url - エンコードするURL

戻り値:

エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL

encodeRedirectURL

public String encodeRedirectURL(String url)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるencodeRedirectURL(String url)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の encodeRedirectURL

パラメータ:

url - エンコードするURL

戻り値:

エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL

関連項目:

HttpServletResponse.sendRedirect(java.lang.String), HttpServletResponse.encodeUrl(java.lang.String)

encodeUrl

public String encodeUrl(String url)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるencodeUrl(String url)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の encodeUrl

パラメータ:

url - エンコードするURL

戻り値:

エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL

encodeRedirectUrl

public String encodeRedirectUrl(String url)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるencodeRedirectUrl(String url)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の encodeRedirectUrl

パラメータ:

url - エンコードするURL

戻り値:

エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL

sendError

public void sendError(int sc,
                      String msg)
               throws IOException

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsendError(int sc, String msg)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の sendError

パラメータ:

sc - エラーステータスコード

msg - 説明文

例外:

IOException - 入出力例外が発生した場合

sendError

public void sendError(int sc)
               throws IOException

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsendError(int sc)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の sendError

パラメータ:

sc - エラーステータスコード

例外:

IOException - 入出力例外が発生した場合

sendRedirect

public void sendRedirect(String location)
                  throws IOException

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsendRedirect(String location)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の sendRedirect

パラメータ:

location - リダイレクト先のURL

例外:

IOException - 入出力例外が発生した場合

setDateHeader

public void setDateHeader(String name,
                          long date)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetDateHeader(String name, long date)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の setDateHeader

パラメータ:

name - 設定するヘッダの名称

関連項目:

HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addDateHeader(java.lang.String, long)

addDateHeader

public void addDateHeader(String name,
                          long date)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるaddDateHeader(String name, long date)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の addDateHeader

パラメータ:

name - 設定するヘッダの名称

関連項目:

HttpServletResponse.setDateHeader(java.lang.String, long)

setHeader

public void setHeader(String name,
                      String value)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetHeader(String name, String value)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の setHeader

パラメータ:

name - ヘッダの名称

value - ヘッダの値

関連項目:

HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addHeader(java.lang.String, java.lang.String)

addHeader

public void addHeader(String name,
                      String value)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるaddHeader(String name, String value)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の addHeader

パラメータ:

name - ヘッダの名称

value - 追加するヘッダの値

関連項目:

HttpServletResponse.setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(String name,
                         int value)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetIntHeader(String name, int value)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の setIntHeader

パラメータ:

name - ヘッダの名称

value - 割り当てられる整数値

関連項目:

HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addIntHeader(java.lang.String, int)

addIntHeader

public void addIntHeader(String name,
                         int value)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるaddIntHeader(String name, int value)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の addIntHeader

パラメータ:

name - ヘッダの名称

value - 割り当てられる整数値

関連項目:

HttpServletResponse.setIntHeader(java.lang.String, int)

setStatus

public void setStatus(int sc)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetStatus(int sc)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の setStatus

パラメータ:

sc - ステータスコード

関連項目:

HttpServletResponse.sendError(int, java.lang.String)

setStatus

public void setStatus(int sc,
                      String sm)

このメソッドにおけるデフォルトのふるまいとして、ラップされたレスポンス・オブジェクトにあるsetStatus(int sc, String sm)メソッドをそのまま呼び出します。

定義:

インタフェース HttpServletResponse 内の setStatus

パラメータ:

sc - ステータスコード

sm - ステータスメッセージ