パッケージ 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
- 関連事項:
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)
このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで encodeRedirectURL(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
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 から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, 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)
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)
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