パッケージ jakarta.servlet.http

クラス HttpServletResponseWrapper

  • 実装されたすべてのインターフェース:
    HttpServletResponseServletResponse

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

      • HttpServletResponseWrapper

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

      • addCookie

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

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

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

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

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

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

        public void sendRedirect​(StringSE location)
                          throws IOExceptionSE
        このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに sendRedirect(String location) を返すことです。
        次で指定:
        インターフェース HttpServletResponsesendRedirect 
        パラメーター:
        location - リダイレクト場所の URL
        例外:
        IOExceptionSE - 入力または出力の例外が発生した場合
      • addDateHeader

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

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

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

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

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

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

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

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

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

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

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

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