パッケージ jakarta.servlet.http

クラス HttpServletResponseWrapper

java.lang.ObjectSE
jakarta.servlet.ServletResponseWrapper
jakarta.servlet.http.HttpServletResponseWrapper
実装されているすべてのインターフェース:
HttpServletResponse, ServletResponse
public class HttpServletResponseWrapper extends ServletResponseWrapper implements HttpServletResponse
サーブレットからのレスポンスを適応させたい開発者がサブクラス化できる、HttpServletResponse インターフェースの便利な実装を提供します。このクラスは、Wrapper または Decorator パターンを実装します。メソッドは、ラップされたレスポンスオブジェクトへの呼び出しをデフォルトで実行します。
導入:
Servlet 2.3
作成者:
Various
関連事項:

  • コンストラクターの詳細

    • HttpServletResponseWrapper

      public HttpServletResponseWrapper(HttpServletResponse response)
      指定されたレスポンスをラップするレスポンスアダプターを構築します。
      パラメーター:
      response - ラップされる HttpServletResponse。
      例外:
      IllegalArgumentExceptionSE - レスポンスが null の場合

  • メソッドの詳細

    • addCookie

      public void addCookie(Cookie cookie)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで addCookie(Cookie cookie) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の addCookie 
      パラメーター:
      cookie - Cookie をクライアントに返す

    • containsHeader

      public boolean containsHeader(StringSE name)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで containsHeader(String name) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の containsHeader 
      パラメーター:
      name - ヘッダー名
      戻り値:
      名前付きレスポンスヘッダーがすでに設定されている場合は true。それ以外の場合は false 

    • encodeURL

      public StringSE encodeURL(StringSE url)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで encodeURL（String url）を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の encodeURL 
      パラメーター:
      url - エンコードされる URL。
      戻り値:
      エンコードが必要な場合はエンコードされた URL。それ以外の場合は未変更の URL。

    • encodeRedirectURL

      public StringSE encodeRedirectURL(StringSE url)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで encodeRedirectURL（String url）を返すことです。
      次で指定:
      インターフェース HttpServletResponse の encodeRedirectURL 
      パラメーター:
      url - エンコードされる URL。
      戻り値:
      エンコードが必要な場合はエンコードされた URL。それ以外の場合は未変更の URL。
      関連事項:

    • sendError

      public void sendError(int sc, StringSE msg) throws IOExceptionSE
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して sendError(int sc, String msg) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の sendError 
      パラメーター:
      sc - エラー状態コード
      msg - 説明的なメッセージ
      例外:
      IOExceptionSE - 入力または出力の例外が発生した場合

    • sendError

      public void sendError(int sc) throws IOExceptionSE
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して sendError(int sc) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の sendError 
      パラメーター:
      sc - エラー状態コード
      例外:
      IOExceptionSE - 入力または出力の例外が発生した場合

    • sendRedirect

      public void sendRedirect(StringSE location) throws IOExceptionSE
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに sendRedirect(String location) を返すことです。
      次で指定:
      インターフェース HttpServletResponse の sendRedirect 
      パラメーター:
      location - リダイレクト場所の URL (絶対的または相対的である可能性があります)
      例外:
      IOExceptionSE - 入力または出力の例外が発生した場合
      関連事項:

    • sendRedirect

      public void sendRedirect(StringSE location, int sc) throws IOExceptionSE
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに sendRedirect(String location, int sc) を返すことです。
      次で指定:
      インターフェース HttpServletResponse の sendRedirect 
      パラメーター:
      location - リダイレクト場所の URL (絶対的または相対的である可能性があります)
      sc - リダイレクトに使用するステータスコード
      例外:
      IOExceptionSE - 入力または出力の例外が発生した場合
      導入:
      Servlet 6.1
      関連事項:

    • sendRedirect

      public void sendRedirect(StringSE location, boolean clearBuffer) throws IOExceptionSE
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに sendRedirect(String location, boolean clearBuffer) を返すことです。
      次で指定:
      インターフェース HttpServletResponse の sendRedirect 
      パラメーター:
      location - リダイレクト場所の URL (絶対的または相対的である可能性があります)
      clearBuffer - true の場合、バッファをクリアし、このメソッドで設定されたデータと置き換えます。それ以外の場合は、既存のバッファを保持します。
      例外:
      IOExceptionSE - 入力または出力の例外が発生した場合
      導入:
      Servlet 6.1
      関連事項:

    • sendRedirect

      public void sendRedirect(StringSE location, int sc, boolean clearBuffer) throws IOExceptionSE
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに sendRedirect(String location, int sc, boolean clearBuffer) を返すことです。
      次で指定:
      インターフェース HttpServletResponse の sendRedirect 
      パラメーター:
      location - リダイレクト場所の URL (絶対的または相対的である可能性があります)
      sc - リダイレクトに使用するステータスコード
      clearBuffer - true の場合、バッファをクリアし、このメソッドで設定されたデータと置き換えます。それ以外の場合は、既存のバッファを保持します。
      例外:
      IOExceptionSE - 入力または出力の例外が発生した場合
      導入:
      Servlet 6.1

    • setDateHeader

      public void setDateHeader(StringSE name, long date)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setDateHeader(String name, long date) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の setDateHeader 
      パラメーター:
      name - 設定するヘッダーの名前
      date - 割り当てられた日付値
      関連事項:

    • addDateHeader

      public void addDateHeader(StringSE name, long date)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して addDateHeader(String name, long date) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の addDateHeader 
      パラメーター:
      name - 設定するヘッダーの名前
      date - 追加の日付値
      関連事項:

    • setHeader

      public void setHeader(StringSE name, StringSE value)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに setHeader(String name, String value) を返すことです。
      次で指定:
      インターフェース HttpServletResponse の setHeader 
      パラメーター:
      name - ヘッダーの名前
      value - ヘッダー値にオクテット文字列が含まれる場合、RFC 2047 に従ってエンコードする必要があります (http://www.ietf.org/rfc/rfc2047.txt)
      関連事項:

    • addHeader

      public void addHeader(StringSE name, StringSE value)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに addHeader(String name, String value) を返すことです。
      次で指定:
      インターフェース HttpServletResponse の addHeader 
      パラメーター:
      name - ヘッダーの名前
      value - 追加のヘッダー値オクテット文字列を含む場合、RFC 2047 に従ってエンコードする必要があります (http://www.ietf.org/rfc/rfc2047.txt)
      関連事項:

    • setIntHeader

      public void setIntHeader(StringSE name, int value)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setIntHeader(String name, int value) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の setIntHeader 
      パラメーター:
      name - ヘッダーの名前
      value - 割り当てられた整数値
      関連事項:

    • addIntHeader

      public void addIntHeader(StringSE name, int value)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して addIntHeader(String name, int value) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の addIntHeader 
      パラメーター:
      name - ヘッダーの名前
      value - 割り当てられた整数値
      関連事項:

    • setStatus

      public void setStatus(int sc)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setStatus(int sc) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の setStatus 
      パラメーター:
      sc - ステータスコード
      関連事項:

    • getStatus

      public int getStatus()
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで HttpServletResponse.getStatus() を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の getStatus 
      戻り値:
      ラップされたレスポンスの現在のステータスコード
      導入:
      Servlet 3.0

    • getHeader

      public StringSE getHeader(StringSE name)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで HttpServletResponse.getHeader(java.lang.String) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の getHeader 
      パラメーター:
      name - 値を返すレスポンスヘッダーの名前
      戻り値:
      指定された名前のレスポンスヘッダーの値、または指定された名前のヘッダーがラップされたレスポンスに設定されていない場合は null
      導入:
      Servlet 3.0

    • getHeaders

      public CollectionSE<StringSE> getHeaders(StringSE name)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで HttpServletResponse.getHeaders(java.lang.String) を呼び出すことです。

      返された Collection に対する変更は、この HttpServletResponseWrapper に影響してはなりません。

      次で指定:
      インターフェース HttpServletResponse の getHeaders 
      パラメーター:
      name - 値が返されるレスポンスヘッダーの名前
      戻り値:
      指定された名前を持つレスポンスヘッダーの値の（空の場合もある） Collection 
      導入:
      Servlet 3.0

    • getHeaderNames

      public CollectionSE<StringSE> getHeaderNames()
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで HttpServletResponse.getHeaderNames() を呼び出すことです。

      返された Collection に対する変更は、この HttpServletResponseWrapper に影響してはなりません。

      次で指定:
      インターフェース HttpServletResponse の getHeaderNames 
      戻り値:
      レスポンスヘッダーの名前の（空の場合もある） Collection 
      導入:
      Servlet 3.0

    • setTrailerFields

      public void setTrailerFields(SupplierSE<MapSE<StringSE,StringSE>> supplier)
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで HttpServletResponse.setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String, java.lang.String>>) を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の setTrailerFields 
      パラメーター:
      supplier - トレーラーヘッダー
      導入:
      Servlet 4.0

    • getTrailerFields

      public SupplierSE<MapSE<StringSE,StringSE>> getTrailerFields()
      このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで HttpServletResponse.getTrailerFields() を呼び出すことです。
      次で指定:
      インターフェース HttpServletResponse の getTrailerFields 
      戻り値:
      トレーラーヘッダーのサプライヤー
      導入:
      Servlet 4.0