Mergedoc
Translation

javax.servlet.http
クラス HttpServletResponseWrapper

java.lang.Object
  上位を拡張 javax.servlet.ServletResponseWrapper
      上位を拡張 javax.servlet.http.HttpServletResponseWrapper
すべての実装されたインタフェース:
HttpServletResponse, ServletResponse

public class HttpServletResponseWrapper
extends ServletResponseWrapper
implements HttpServletResponse

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

導入されたバージョン:
v 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)
          指定したレスポンスをラッピングしたレスポンスアダプタを構築します。
 
メソッドの概要
 void addCookie(Cookie cookie)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある addCookie(Cookie cookie) メソッドをそのまま呼び出します。
 void addDateHeader(java.lang.String name, long date)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある addDateHeader(String name, long date) メソッドをそのまま呼び出します。
 void addHeader(java.lang.String name, java.lang.String value)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある addHeader(String name, String value) メソッドをそのまま呼び出します。
 void addIntHeader(java.lang.String name, int value)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある addIntHeader(String name, int value) メソッドをそのまま呼び出します。
 boolean containsHeader(java.lang.String name)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある containsHeader(String name) メソッドをそのまま呼び出します。
 java.lang.String encodeRedirectUrl(java.lang.String url)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある encodeRedirectUrl(String url) メソッドをそのまま呼び出します。
 java.lang.String encodeRedirectURL(java.lang.String url)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある encodeRedirectURL(String url) メソッドをそのまま呼び出します。
 java.lang.String encodeUrl(java.lang.String url)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある encodeUrl(String url) メソッドをそのまま呼び出します。
 java.lang.String encodeURL(java.lang.String url)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある encodeURL(String url) メソッドをそのまま呼び出します。
 void sendError(int sc)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある sendError(int sc) メソッドをそのまま呼び出します。
 void sendError(int sc, java.lang.String msg)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある sendError(int sc, String msg) メソッドをそのまま呼び出します。
 void sendRedirect(java.lang.String location)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある sendRedirect(String location) メソッドをそのまま呼び出します。
 void setDateHeader(java.lang.String name, long date)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある setDateHeader(String name, long date) メソッドをそのまま呼び出します。
 void setHeader(java.lang.String name, java.lang.String value)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある setHeader(String name, String value) メソッドをそのまま呼び出します。
 void setIntHeader(java.lang.String name, int value)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある setIntHeader(String name, int value) メソッドをそのまま呼び出します。
 void setStatus(int sc)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある setStatus(int sc) メソッドをそのまま呼び出します。
 void setStatus(int sc, java.lang.String sm)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある setStatus(int sc, String sm) メソッドをそのまま呼び出します。
 
クラス 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
 
インタフェース javax.servlet.ServletResponse から継承されたメソッド
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale
 

コンストラクタの詳細

HttpServletResponseWrapper

public HttpServletResponseWrapper(HttpServletResponse response)
指定したレスポンスをラッピングしたレスポンスアダプタを構築します。

パラメータ:
response - ラップするレスポンス
例外:
java.lang.IllegalArgumentException - response が null である場合
メソッドの詳細

addCookie

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

定義:
インタフェース HttpServletResponse 内の addCookie
パラメータ:
cookie - クライアントに返す Cookie

containsHeader

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

定義:
インタフェース HttpServletResponse 内の containsHeader
パラメータ:
name - ヘッダ名
戻り値:
指定された名前のレスポンスヘッダが既にセットされていればtrue、そうでなければ false

encodeURL

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

定義:
インタフェース HttpServletResponse 内の encodeURL
パラメータ:
url - エンコードする URL
戻り値:
エンコードが必要である場合、エンコードされた URL。 そうでない場合は与えられたそのままの URL。

encodeRedirectURL

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

定義:
インタフェース HttpServletResponse 内の encodeRedirectURL
パラメータ:
url - エンコードする URL
戻り値:
エンコードが必要である場合、エンコードされた URL。 そうでない場合は与えられたそのままの URL。
関連項目:
HttpServletResponse.sendRedirect(java.lang.String), HttpServletResponse.encodeUrl(java.lang.String)

encodeUrl

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

定義:
インタフェース HttpServletResponse 内の encodeUrl
パラメータ:
url - エンコードする URL
戻り値:
エンコードが必要である場合、エンコードされた URL。 そうでない場合は与えられたそのままの URL。

encodeRedirectUrl

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

定義:
インタフェース HttpServletResponse 内の encodeRedirectUrl
パラメータ:
url - エンコードする URL
戻り値:
エンコードが必要である場合、エンコードされた URL。 そうでない場合は与えられたそのままの URL。

sendError

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

定義:
インタフェース HttpServletResponse 内の sendError
パラメータ:
sc - エラーステータスコード
msg - 説明文
例外:
java.io.IOException - 入出力例外が発生した場合

sendError

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

定義:
インタフェース HttpServletResponse 内の sendError
パラメータ:
sc - エラーステータスコード
例外:
java.io.IOException - 入出力例外が発生した場合

sendRedirect

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

定義:
インタフェース HttpServletResponse 内の sendRedirect
パラメータ:
location - リダイレクト先の URL
例外:
java.io.IOException - 入出力例外が発生した場合

setDateHeader

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

定義:
インタフェース HttpServletResponse 内の setDateHeader
パラメータ:
name - 設定するヘッダの名称
date - 設定する日付の値
関連項目:
HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addDateHeader(java.lang.String, long)

addDateHeader

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

定義:
インタフェース HttpServletResponse 内の addDateHeader
パラメータ:
name - 設定するヘッダの名称
date - 追加する日付の値
関連項目:
HttpServletResponse.setDateHeader(java.lang.String, long)

setHeader

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

定義:
インタフェース HttpServletResponse 内の setHeader
パラメータ:
name - ヘッダの名称
value - ヘッダの値。オクテット文字列が含まれる場合は 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(java.lang.String name,
                      java.lang.String value)
このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある addHeader(String name, String value) メソッドをそのまま呼び出します。

定義:
インタフェース HttpServletResponse 内の addHeader
パラメータ:
name - ヘッダの名称
value - 追加するヘッダの値。オクテット文字列が含まれる場合は RFC 2047 に従いエンコードされるべきです。 (http://www.ietf.org/rfc/rfc2047.txt)
関連項目:
HttpServletResponse.setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(java.lang.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(java.lang.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,
                      java.lang.String sm)
このメソッドにおけるデフォルトの振舞いとして、ラップされたレスポンスオブジェクトにある setStatus(int sc, String sm) メソッドをそのまま呼び出します。

定義:
インタフェース HttpServletResponse 内の setStatus
パラメータ:
sc - ステータスコード
sm - ステータスメッセージ

Mergedoc
Translation

Copyright © 2000- The Apache Software Foundation. All rights Reserved.