HttpServletResponseWrapper (Java Servlet 4.0)

java.lang.Object
- javax.servlet.ServletResponseWrapper
- - javax.servlet.http.HttpServletResponseWrapper

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

HttpServletResponse, ServletResponse
```
public class HttpServletResponseWrapper
extends ServletResponseWrapper
implements HttpServletResponse
```
サーブレットにレスポンスを適合させたい開発者がサブクラス化できるHttpServletResponseインターフェースの便利な実装を提供します。このクラスはWrapperもしくはDecoratorパターンを実装します。メソッドはデフォルトでラップされたリクエストオブジェクトを呼び出します。

作成者:

Various

導入されたバージョン:

Servlet 2.3

関連項目:

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)` 指定されたレスポンスオブジェクトをラップするレスポンスアダプタを作成します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`void`	`addCookie(Cookie cookie)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのaddCookie(Cookie cookie)を呼び出すことです。
`void`	`addDateHeader(String name, long date)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのaddDateHeader(String name, long date)を呼び出すことです。
`void`	`addHeader(String name, String value)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのaddHeader(String name, String value)を返すことです。
`void`	`addIntHeader(String name, int value)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのaddIntHeader(String name, int value)を呼び出すことです。
`boolean`	`containsHeader(String name)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのcontainsHeader(String name)を呼び出すことです。
`String`	`encodeRedirectUrl(String url)` 非推奨です。 Version 2.1からは代わりに `encodeRedirectURL(String url)`を使用してください
`String`	`encodeRedirectURL(String url)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのencodeRedirectURL(String url)を返すことです。
`String`	`encodeUrl(String url)` 非推奨です。 Version 2.1からは代わりに`encodeURL(String url)`を使用してください
`String`	`encodeURL(String url)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのencodeURL(String url)を呼び出すことです。
`String`	`getHeader(String name)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトの`HttpServletResponse.getHeader(java.lang.String)`を呼び出すことです。
`Collection<String>`	`getHeaderNames()` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトの`HttpServletResponse.getHeaderNames()`を呼び出すことです。
`Collection<String>`	`getHeaders(String name)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトの`HttpServletResponse.getHeaders(java.lang.String)` を呼び出すことです。
`int`	`getStatus()` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトの`HttpServletResponse.getStatus()`を呼び出すことです。
`Supplier<Map<String,String>>`	`getTrailerFields()` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトの`HttpServletResponse.getTrailerFields()`を呼び出すことです。
`void`	`sendError(int sc)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsendError(int sc)を呼び出すことです。
`void`	`sendError(int sc, String msg)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsendError(int sc, String msg)を呼び出すことです。
`void`	`sendRedirect(String location)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsendRedirect(String location)を返すことです。
`void`	`setDateHeader(String name, long date)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetDateHeader(String name, long date)を呼び出すことです。
`void`	`setHeader(String name, String value)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetHeader(String name, String value)を返すことです。
`void`	`setIntHeader(String name, int value)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetIntHeader(String name, int value)を呼び出すことです。
`void`	`setStatus(int sc)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetStatus(int sc)を呼び出すことです。
`void`	`setStatus(int sc, String sm)` 非推奨です。 Version 2.1 からメッセージパラメータのあいまいな意味のために非推奨になりました。ステータスコードを設定するためには`setStatus(int)`を使用してください。エラーと一緒に説明文を送るためには`sendError(int, String)`を使用してください。
`void`	`setTrailerFields(Supplier<Map<String,String>> supplier)` このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトの`HttpServletResponse.setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String, java.lang.String>>)`を呼び出すことです。

クラスから継承されたメソッド javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, 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, setContentLengthLong, setContentType, setLocale

- コンストラクタの詳細
  - HttpServletResponseWrapper
```
public HttpServletResponseWrapper(HttpServletResponse response)
```
    指定されたレスポンスオブジェクトをラップするレスポンスアダプタを作成します。
    
    パラメータ:
    
    response - ラップされるHttpServletResponse
    
    例外:
    
    IllegalArgumentException - responseがnull
- メソッドの詳細
  - addCookie
```
public void addCookie(Cookie cookie)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのaddCookie(Cookie cookie)を呼び出すことです。
    
    定義:
    
    addCookie インタフェース内 HttpServletResponse
    
    パラメータ:
    
    cookie - クライアントに返されるCookie
  - containsHeader
```
public boolean containsHeader(String name)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのcontainsHeader(String name)を呼び出すことです。
    
    定義:
    
    containsHeader インタフェース内 HttpServletResponse
    
    パラメータ:
    
    name - ヘッダー名
    
    戻り値:
    
    名前つきレスポンスヘッダーがすでに設定されている場合はtrue、そうでない場合はfalse
  - encodeURL
```
public String encodeURL(String url)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのencodeURL(String url)を呼び出すことです。
    
    定義:
    
    encodeURL インタフェース内 HttpServletResponse
    
    パラメータ:
    
    url - エンコードされるURL
    
    戻り値:
    
    エンコードが必要な場合はエンコードされたURL、そうでない場合は変更されていないURL
  - encodeRedirectURL
```
public String encodeRedirectURL(String url)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのencodeRedirectURL(String url)を返すことです。
    
    定義:
    
    encodeRedirectURL インタフェース内 HttpServletResponse
    
    パラメータ:
    
    url - エンコードされるURL
    
    戻り値:
    
    エンコードが必要な場合はエンコードされたURL、そうでない場合は変更されていないURL
    
    関連項目:
    
    HttpServletResponse.sendRedirect(java.lang.String), HttpServletResponse.encodeUrl(java.lang.String)
  - encodeUrl
```
@Deprecated
public String encodeUrl(String url)
```
    非推奨です。 Version 2.1からは代わりにencodeURL(String url)を使用してください
    
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのencodeUrl(String url)を呼び出すことです。
    
    定義:
    
    encodeUrl インタフェース内 HttpServletResponse
    
    パラメータ:
    
    url - エンコードされるURL
    
    戻り値:
    
    エンコードが必要な場合はエンコードされたURL、そうでない場合は変更されていないURL
  - encodeRedirectUrl
```
@Deprecated
public String encodeRedirectUrl(String url)
```
    非推奨です。 Version 2.1からは代わりに encodeRedirectURL(String url)を使用してください
    
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのencodeRedirectUrl(String url)を返すことです。
    
    定義:
    
    encodeRedirectUrl インタフェース内 HttpServletResponse
    
    パラメータ:
    
    url - エンコードされるURL
    
    戻り値:
    
    エンコードが必要な場合はエンコードされたURL、そうでない場合は変更されていないURL
  - sendError
```
public void sendError(int sc,
                      String msg)
               throws IOException
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsendError(int sc, String msg)を呼び出すことです。
    
    定義:
    
    sendError インタフェース内 HttpServletResponse
    
    パラメータ:
    
    sc - エラーステータスコード
    
    msg - 説明のメッセージ
    
    例外:
    
    IOException - I/Oエラーが発生した
  - sendError
```
public void sendError(int sc)
               throws IOException
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsendError(int sc)を呼び出すことです。
    
    定義:
    
    sendError インタフェース内 HttpServletResponse
    
    パラメータ:
    
    sc - エラーステータスコード
    
    例外:
    
    IOException - I/Oエラーが発生した
  - sendRedirect
```
public void sendRedirect(String location)
                  throws IOException
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsendRedirect(String location)を返すことです。
    
    定義:
    
    sendRedirect インタフェース内 HttpServletResponse
    
    パラメータ:
    
    location - リダイレクト先のURL
    
    例外:
    
    IOException - I/Oエラーが発生した
  - setDateHeader
```
public void setDateHeader(String name,
                          long date)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetDateHeader(String name, long date)を呼び出すことです。
    
    定義:
    
    setDateHeader インタフェース内 HttpServletResponse
    
    パラメータ:
    
    name - ヘッダーに値を設定する名前
    
    date - 割り当てられる日付値
    
    関連項目:
    
    HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addDateHeader(java.lang.String, long)
  - addDateHeader
```
public void addDateHeader(String name,
                          long date)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのaddDateHeader(String name, long date)を呼び出すことです。
    
    定義:
    
    addDateHeader インタフェース内 HttpServletResponse
    
    パラメータ:
    
    name - ヘッダーに値を設定する名前
    
    date - 追加される日付値
    
    関連項目:
    
    HttpServletResponse.setDateHeader(java.lang.String, long)
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetHeader(String name, String value)を返すことです。
    
    定義:
    
    setHeader インタフェース内 HttpServletResponse
    
    パラメータ:
    
    name - ヘッダーの名前
    
    value - ヘッダーに追加する値、8bit文字列(octed string)の場合は RFC2047に従ってエンコードされている必要がある (http://www.ietf.org/rfc/rfc2047.txt)
    
    関連項目:
    
    HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addHeader(java.lang.String, java.lang.String)
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのaddHeader(String name, String value)を返すことです。
    
    定義:
    
    addHeader インタフェース内 HttpServletResponse
    
    パラメータ:
    
    name - ヘッダーの名前
    
    value - ヘッダーに追加する値、8bit文字列(octed string)の場合は RFC2047に従ってエンコードされている必要がある (http://www.ietf.org/rfc/rfc2047.txt)
    
    関連項目:
    
    HttpServletResponse.setHeader(java.lang.String, java.lang.String)
  - setIntHeader
```
public void setIntHeader(String name,
                         int value)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetIntHeader(String name, int value)を呼び出すことです。
    
    定義:
    
    setIntHeader インタフェース内 HttpServletResponse
    
    パラメータ:
    
    name - ヘッダーの名前
    
    value - 割り当てられる整数
    
    関連項目:
    
    HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addIntHeader(java.lang.String, int)
  - addIntHeader
```
public void addIntHeader(String name,
                         int value)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのaddIntHeader(String name, int value)を呼び出すことです。
    
    定義:
    
    addIntHeader インタフェース内 HttpServletResponse
    
    パラメータ:
    
    name - ヘッダーの名前
    
    value - 割り当てられる整数
    
    関連項目:
    
    HttpServletResponse.setIntHeader(java.lang.String, int)
  - setStatus
```
public void setStatus(int sc)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetStatus(int sc)を呼び出すことです。
    
    定義:
    
    setStatus インタフェース内 HttpServletResponse
    
    パラメータ:
    
    sc - ステータスコード
    
    関連項目:
    
    HttpServletResponse.sendError(int, java.lang.String)
  - setStatus
```
@Deprecated
public void setStatus(int sc,
                                  String sm)
```
    非推奨です。 Version 2.1 からメッセージパラメータのあいまいな意味のために非推奨になりました。ステータスコードを設定するためにはsetStatus(int)を使用してください。エラーと一緒に説明文を送るためにはsendError(int, String)を使用してください。
    
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのsetStatus(int sc, String sm)を呼び出すことです。
    
    定義:
    
    setStatus インタフェース内 HttpServletResponse
    
    パラメータ:
    
    sc - ステータスコード
    
    sm - ステータスのメッセージ
  - getStatus
```
public int getStatus()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのHttpServletResponse.getStatus()を呼び出すことです。
    
    定義:
    
    getStatus インタフェース内 HttpServletResponse
    
    戻り値:
    
    このラップされたレスポンスの現在のステータスコード
  - getHeader
```
public String getHeader(String name)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのHttpServletResponse.getHeader(java.lang.String)を呼び出すことです。
    
    定義:
    
    getHeader インタフェース内 HttpServletResponse
    
    パラメータ:
    
    name - 値を返されるレスポンスヘッダーの名前
    
    戻り値:
    
    与えられた名前のレスポンスヘッダーの値、このレスポンスのヘッダーに与えられた名前で値が設定されてない場合はnull
    
    導入されたバージョン:
    
    Servlet 3.0
  - getHeaders
```
public Collection<String> getHeaders(String name)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのHttpServletResponse.getHeaders(java.lang.String) を呼び出すことです。
    Collectionに対するいかなる変更もHttpServletResponseに影響を与えてはいけません。
    
    定義:
    
    getHeaders インタフェース内 HttpServletResponse
    
    パラメータ:
    
    name - 値を返されるレスポンスヘッダーの名前
    
    戻り値:
    
    与えられた名前のレスポンスヘッダーの値の(空の可能性がある)Collection
    
    導入されたバージョン:
    
    Servlet 3.0
  - getHeaderNames
```
public Collection<String> getHeaderNames()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのHttpServletResponse.getHeaderNames()を呼び出すことです。
    Collectionに対するいかなる変更もHttpServletResponseに影響を与えてはいけません。
    
    定義:
    
    getHeaderNames インタフェース内 HttpServletResponse
    
    戻り値:
    
    レスポンスヘッダーの名前の(空の可能性がある)Collection
    
    導入されたバージョン:
    
    Servlet 3.0
  - setTrailerFields
```
public void setTrailerFields(Supplier<Map<String,String>> supplier)
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのHttpServletResponse.setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String, java.lang.String>>)を呼び出すことです。
    
    定義:
    
    setTrailerFields インタフェース内 HttpServletResponse
    
    パラメータ:
    
    supplier - トレイラーヘッダーのサプライヤ
    
    導入されたバージョン:
    
    Servlet 4.0
  - getTrailerFields
```
public Supplier<Map<String,String>> getTrailerFields()
```
    このメソッドのデフォルトの動作はラップされたレスポンスオブジェクトのHttpServletResponse.getTrailerFields()を呼び出すことです。
    
    定義:
    
    getTrailerFields インタフェース内 HttpServletResponse
    
    戻り値:
    
    トレイラーヘッダーのサプライヤ
    
    導入されたバージョン:
    
    Servlet 4.0

Copyright © 1999-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms. Portions Copyright © 1999-2002 The Apache Software Foundation. Portions Copyright © 2017- @megascus. Translated by @megascus.

クラス HttpServletResponseWrapper

フィールドのサマリー

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

コンストラクタのサマリー

メソッドのサマリー

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

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

インタフェースから継承されたメソッド javax.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