HttpServletResponseWrapper (Jakarta EE Platform API)

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
関連事項:
HttpServletResponse

フィールドのサマリー
- インターフェース jakarta.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(StringSE name, long date)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して addDateHeader(String name, long date) を呼び出すことです。
`void`	`addHeader(StringSE name, StringSE value)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに addHeader(String name, String value) を返すことです。
`void`	`addIntHeader(StringSE name, int value)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して addIntHeader(String name, int value) を呼び出すことです。
`boolean`	`containsHeader(StringSE name)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで containsHeader(String name) を呼び出すことです。
`StringSE`	`encodeRedirectUrl(StringSE url)` 使用すべきではありません。バージョン 2.1 では、代わりに `encodeRedirectURL(String url)` を使用します
`StringSE`	`encodeRedirectURL(StringSE url)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで encodeRedirectURL（String url）を返すことです。
`StringSE`	`encodeUrl(StringSE url)` 使用すべきではありません。バージョン 2.1 では、代わりに `encodeURL(String url)` を使用します
`StringSE`	`encodeURL(StringSE url)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで encodeURL（String url）を呼び出すことです。
`StringSE`	`getHeader(StringSE name)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで `HttpServletResponse.getHeader(java.lang.String)` を呼び出すことです。
`CollectionSE<StringSE>`	`getHeaderNames()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで `HttpServletResponse.getHeaderNames()` を呼び出すことです。
`CollectionSE<StringSE>`	`getHeaders(StringSE name)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで `HttpServletResponse.getHeaders(java.lang.String)` を呼び出すことです。
`int`	`getStatus()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで `HttpServletResponse.getStatus()` を呼び出すことです。
`SupplierSE<MapSE<StringSE, StringSE>>`	`getTrailerFields()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで `HttpServletResponse.getTrailerFields()` を呼び出すことです。
`void`	`sendError(int sc)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して sendError(int sc) を呼び出すことです。
`void`	`sendError(int sc, StringSE msg)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して sendError(int sc, String msg) を呼び出すことです。
`void`	`sendRedirect(StringSE location)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに sendRedirect(String location) を返すことです。
`void`	`setDateHeader(StringSE name, long date)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setDateHeader(String name, long date) を呼び出すことです。
`void`	`setHeader(StringSE name, StringSE value)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに setHeader(String name, String value) を返すことです。
`void`	`setIntHeader(StringSE name, int value)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setIntHeader(String name, int value) を呼び出すことです。
`void`	`setStatus(int sc)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setStatus(int sc) を呼び出すことです。
`void`	`setStatus(int sc, StringSE sm)` 使用すべきではありません。バージョン 2.1 では、メッセージパラメーターの意味があいまいです。ステータスコードを設定するには `setStatus(int)` を使用し、説明付きのエラーを送信するには `sendError(int, String)` を使用します
`void`	`setTrailerFields(SupplierSE<MapSE<StringSE, StringSE>> supplier)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで `HttpServletResponse.setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String, java.lang.String>>)` を呼び出すことです。

クラス jakarta.servlet.ServletResponseWrapper から継承されたメソッド
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース jakarta.servlet.ServletResponse から継承されたメソッド
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

- コンストラクターの詳細
  - 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。
    関連事項:
    HttpServletResponse.sendRedirect(java.lang.String), HttpServletResponse.encodeUrl(java.lang.String)
  - encodeUrl
```
@DeprecatedSE
public StringSE encodeUrl(StringSE url)
```
    非推奨。バージョン 2.1 以降では、代わりに encodeURL(String url) を使用してください。
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで encodeUrl(String url) を呼び出すことです。
    次で指定:
    インターフェース HttpServletResponse の encodeUrl
    パラメーター:
    url - エンコードされる URL。
    戻り値:
    エンコードが必要な場合はエンコードされた URL。それ以外の場合は未変更の URL。
  - encodeRedirectUrl
```
@DeprecatedSE
public StringSE encodeRedirectUrl(StringSE url)
```
    非推奨。バージョン 2.1 以降では、代わりに encodeRedirectURL(String 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 - 入力または出力の例外が発生した場合
  - setDateHeader
```
public void setDateHeader(StringSE 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(StringSE name,
                          long date)
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して addDateHeader(String name, long date) を呼び出すことです。
    次で指定:
    インターフェース HttpServletResponse の addDateHeader
    パラメーター:
    name - 設定するヘッダーの名前
    date - 追加の日付値
    関連事項:
    HttpServletResponse.setDateHeader(java.lang.String, long)
  - 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)
    関連事項:
    HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addHeader(java.lang.String, java.lang.String)
  - 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)
    関連事項:
    HttpServletResponse.setHeader(java.lang.String, java.lang.String)
  - setIntHeader
```
public void setIntHeader(StringSE 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(StringSE 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
```
@DeprecatedSE
public void setStatus(int sc,
                                  StringSE sm)
```
    非推奨です。バージョン 2.1 では、メッセージパラメーターの意味があいまいなため。ステータスコードを設定するには setStatus(int) を使用し、説明付きのエラーを送信するには sendError(int, String) を使用します。
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setStatus(int sc, String sm) を呼び出すことです。
    次で指定:
    インターフェース HttpServletResponse の setStatus
    パラメーター:
    sc - ステータスコード
    sm - ステータスメッセージ
  - getStatus
```
public int getStatus()
```
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで HttpServletResponse.getStatus() を呼び出すことです。
    次で指定:
    インターフェース HttpServletResponse の getStatus
    戻り値:
    ラップされたレスポンスの現在のステータスコード
  - 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

クラス HttpServletResponseWrapper

フィールドのサマリー

インターフェース jakarta.servlet.http.HttpServletResponse から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス jakarta.servlet.ServletResponseWrapper から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース jakarta.servlet.ServletResponse から継承されたメソッド

コンストラクターの詳細

HttpServletResponseWrapper

メソッドの詳細

addCookie

containsHeader

encodeURL

encodeRedirectURL

encodeUrl

encodeRedirectUrl

sendError

sendError

sendRedirect

setDateHeader

addDateHeader

setHeader

addHeader

setIntHeader

addIntHeader

setStatus

setStatus

getStatus

getHeader

getHeaders

getHeaderNames

setTrailerFields

getTrailerFields