ContentCachingResponseWrapper (Spring Framework 5.2.9.RELEASE API)

java.lang.ObjectSE
- javax.servlet.ServletResponseWrapperEE
- - javax.servlet.http.HttpServletResponseWrapperEE
  - - org.springframework.web.util.ContentCachingResponseWrapper

実装されているすべてのインターフェース:
HttpServletResponseEE, ServletResponseEE
```
public class ContentCachingResponseWrapper
extends HttpServletResponseWrapperEE
```
出力ストリームとライターに書き込まれたすべてのコンテンツをキャッシュし、このコンテンツを byte array を介して取得できるようにする HttpServletResponseEE ラッパー。
使用済み ShallowEtagHeaderFilter による。注: Spring Framework 5.0 以降、このラッパーは Servlet 3.1 API に基づいて構築されています。
導入:
4.1.3
作成者:
Juergen Hoeller
関連事項:
ContentCachingRequestWrapper

フィールドのサマリー
- インターフェース javax.servlet.http.HttpServletResponseEE から継承されたフィールド
  SC_ACCEPTEDEE, SC_BAD_GATEWAYEE, SC_BAD_REQUESTEE, SC_CONFLICTEE, SC_CONTINUEEE, SC_CREATEDEE, SC_EXPECTATION_FAILEDEE, SC_FORBIDDENEE, SC_FOUNDEE, SC_GATEWAY_TIMEOUTEE, SC_GONEEE, SC_HTTP_VERSION_NOT_SUPPORTEDEE, SC_INTERNAL_SERVER_ERROREE, SC_LENGTH_REQUIREDEE, SC_METHOD_NOT_ALLOWEDEE, SC_MOVED_PERMANENTLYEE, SC_MOVED_TEMPORARILYEE, SC_MULTIPLE_CHOICESEE, SC_NO_CONTENTEE, SC_NON_AUTHORITATIVE_INFORMATIONEE, SC_NOT_ACCEPTABLEEE, SC_NOT_FOUNDEE, SC_NOT_IMPLEMENTEDEE, SC_NOT_MODIFIEDEE, SC_OKEE, SC_PARTIAL_CONTENTEE, SC_PAYMENT_REQUIREDEE, SC_PRECONDITION_FAILEDEE, SC_PROXY_AUTHENTICATION_REQUIREDEE, SC_REQUEST_ENTITY_TOO_LARGEEE, SC_REQUEST_TIMEOUTEE, SC_REQUEST_URI_TOO_LONGEE, SC_REQUESTED_RANGE_NOT_SATISFIABLEEE, SC_RESET_CONTENTEE, SC_SEE_OTHEREE, SC_SERVICE_UNAVAILABLEEE, SC_SWITCHING_PROTOCOLSEE, SC_TEMPORARY_REDIRECTEE, SC_UNAUTHORIZEDEE, SC_UNSUPPORTED_MEDIA_TYPEEE, SC_USE_PROXYEE

コンストラクターの概要

コンストラクター
コンストラクターと説明
`ContentCachingResponseWrapper(HttpServletResponseEE response)` 指定されたサーブレットレスポンスに対して新しい ContentCachingResponseWrapper を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`copyBodyToResponse()` キャッシュされた完全な本文コンテンツをレスポンスにコピーします。
`protected void`	`copyBodyToResponse(boolean complete)` キャッシュされた本文コンテンツをレスポンスにコピーします。
`void`	`flushBuffer()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで flushBuffer() を呼び出すことです。
`byte[]`	`getContentAsByteArray()` キャッシュされたレスポンスコンテンツをバイト配列として返します。
`InputStreamSE`	`getContentInputStream()` キャッシュされたコンテンツに `InputStream`SE を返します。
`int`	`getContentSize()` キャッシュされたコンテンツの現在のサイズを返します。
`ServletOutputStreamEE`	`getOutputStream()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getOutputStream() を返すことです。
`int`	`getStatusCode()` 使用すべきではありません。 5.2 現在、`HttpServletResponse.getStatus()`EE を推奨
`PrintWriterSE`	`getWriter()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getWriter() を返すことです。
`void`	`reset()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで reset() を呼び出すことです。
`void`	`resetBuffer()` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで resetBuffer() を呼び出すことです。
`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`	`setBufferSize(int size)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setBufferSize(int size) を呼び出すことです。
`void`	`setContentLength(int len)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentLength(int len) を呼び出すことです。
`void`	`setContentLengthLong(long len)` このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentLengthLong(long len) を呼び出すことです。

クラス javax.servlet.http.HttpServletResponseWrapperEE から継承されたメソッド
addCookieEE, addDateHeaderEE, addHeaderEE, addIntHeaderEE, containsHeaderEE, encodeRedirectUrlEE, encodeRedirectURLEE, encodeUrlEE, encodeURLEE, getHeaderEE, getHeaderNamesEE, getHeadersEE, getStatusEE, getTrailerFieldsEE, setDateHeaderEE, setHeaderEE, setIntHeaderEE, setStatusEE, setStatusEE, setTrailerFieldsEE

クラス javax.servlet.ServletResponseWrapperEE から継承されたメソッド
getBufferSizeEE, getCharacterEncodingEE, getContentTypeEE, getLocaleEE, getResponseEE, isCommittedEE, isWrapperForEE, isWrapperForEE, setCharacterEncodingEE, setContentTypeEE, setLocaleEE, setResponseEE

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

インターフェース javax.servlet.ServletResponseEE から継承されたメソッド
getBufferSizeEE, getCharacterEncodingEE, getContentTypeEE, getLocaleEE, isCommittedEE, setCharacterEncodingEE, setContentTypeEE, setLocaleEE

- コンストラクターの詳細
  - ContentCachingResponseWrapper
```
public ContentCachingResponseWrapper(HttpServletResponseEE response)
```
    指定されたサーブレットレスポンスに対して新しい ContentCachingResponseWrapper を作成します。
    パラメーター:
    response - 元のサーブレットレスポンス
- メソッドの詳細
  - sendError
```
public void sendError(int sc)
               throws IOExceptionSE
```
    クラスからコピーされた説明: javax.servlet.http.HttpServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して sendError(int sc) を呼び出すことです。
    次で指定:
    インターフェース HttpServletResponseEE の sendErrorEE
    オーバーライド:
    クラス HttpServletResponseWrapperEE の sendErrorEE
    パラメーター:
    sc - エラー状態コード
    例外:
    IOExceptionSE - 入力または出力の例外が発生した場合
  - sendError
```
public void sendError(int sc,
                      StringSE msg)
               throws IOExceptionSE
```
    クラスからコピーされた説明: javax.servlet.http.HttpServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して sendError(int sc, String msg) を呼び出すことです。
    次で指定:
    インターフェース HttpServletResponseEE の sendErrorEE
    オーバーライド:
    クラス HttpServletResponseWrapperEE の sendErrorEE
    パラメーター:
    sc - エラー状態コード
    msg - 説明的なメッセージ
    例外:
    IOExceptionSE - 入力または出力の例外が発生した場合
  - sendRedirect
```
public void sendRedirect(StringSE location)
                  throws IOExceptionSE
```
    クラスからコピーされた説明: javax.servlet.http.HttpServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに sendRedirect(String location) を返すことです。
    次で指定:
    インターフェース HttpServletResponseEE の sendRedirectEE
    オーバーライド:
    クラス HttpServletResponseWrapperEE の sendRedirectEE
    パラメーター:
    location - リダイレクト場所の URL
    例外:
    IOExceptionSE - 入力または出力の例外が発生した場合
  - getOutputStream
```
public ServletOutputStreamEE getOutputStream()
                                    throws IOExceptionSE
```
    クラスからコピーされた説明: javax.servlet.ServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getOutputStream() を返すことです。
    次で指定:
    インターフェース ServletResponseEE の getOutputStreamEE
    オーバーライド:
    クラス ServletResponseWrapperEE の getOutputStreamEE
    戻り値:
    バイナリデータを書き込むための ServletOutputStreamEE
    例外:
    IOExceptionSE - 入力または出力の例外が発生した場合
    関連事項:
    ServletResponse.getWriter()EE, ServletResponse.reset()EE
  - getWriter
```
public PrintWriterSE getWriter()
                      throws IOExceptionSE
```
    クラスからコピーされた説明: javax.servlet.ServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで getWriter() を返すことです。
    次で指定:
    インターフェース ServletResponseEE の getWriterEE
    オーバーライド:
    クラス ServletResponseWrapperEE の getWriterEE
    戻り値:
    クライアントに文字データを返すことができる PrintWriter オブジェクト
    例外:
    UnsupportedEncodingExceptionSE - getCharacterEncoding によって返された文字エンコードを使用できない場合
    IOExceptionSE - 入力または出力の例外が発生した場合
    関連事項:
    ServletResponse.getOutputStream()EE, ServletResponse.setCharacterEncoding(java.lang.String)EE, ServletResponse.reset()EE
  - flushBuffer
```
public void flushBuffer()
                 throws IOExceptionSE
```
    クラスからコピーされた説明: javax.servlet.ServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで flushBuffer() を呼び出すことです。
    次で指定:
    インターフェース ServletResponseEE の flushBufferEE
    オーバーライド:
    クラス ServletResponseWrapperEE の flushBufferEE
    例外:
    IOExceptionSE - バッファをフラッシュする動作を完了できない場合。
    関連事項:
    ServletResponse.setBufferSize(int)EE, ServletResponse.getBufferSize()EE, ServletResponse.isCommitted()EE, ServletResponse.reset()EE
  - setContentLength
```
public void setContentLength(int len)
```
    クラスからコピーされた説明: javax.servlet.ServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentLength(int len) を呼び出すことです。
    次で指定:
    インターフェース ServletResponseEE の setContentLengthEE
    オーバーライド:
    クラス ServletResponseWrapperEE の setContentLengthEE
    パラメーター:
    len - クライアントに返されるコンテンツの長さを指定する整数。Content-Length ヘッダーを設定します
  - setContentLengthLong
```
public void setContentLengthLong(long len)
```
    クラスからコピーされた説明: javax.servlet.ServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setContentLengthLong(long len) を呼び出すことです。
    次で指定:
    インターフェース ServletResponseEE の setContentLengthLongEE
    オーバーライド:
    クラス ServletResponseWrapperEE の setContentLengthLongEE
    パラメーター:
    len - クライアントに返されるコンテンツの長さを指定する long; Content-Length ヘッダーを設定します
  - setBufferSize
```
public void setBufferSize(int size)
```
    クラスからコピーされた説明: javax.servlet.ServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトに対して setBufferSize(int size) を呼び出すことです。
    次で指定:
    インターフェース ServletResponseEE の setBufferSizeEE
    オーバーライド:
    クラス ServletResponseWrapperEE の setBufferSizeEE
    パラメーター:
    size - 優先バッファサイズ
    関連事項:
    ServletResponse.getBufferSize()EE, ServletResponse.flushBuffer()EE, ServletResponse.isCommitted()EE, ServletResponse.reset()EE
  - resetBuffer
```
public void resetBuffer()
```
    クラスからコピーされた説明: javax.servlet.ServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで resetBuffer() を呼び出すことです。
    次で指定:
    インターフェース ServletResponseEE の resetBufferEE
    オーバーライド:
    クラス ServletResponseWrapperEE の resetBufferEE
    関連事項:
    ServletResponse.setBufferSize(int)EE, ServletResponse.getBufferSize()EE, ServletResponse.isCommitted()EE, ServletResponse.reset()EE
  - reset
```
public void reset()
```
    クラスからコピーされた説明: javax.servlet.ServletResponseWrapperEE
    このメソッドのデフォルトの動作は、ラップされたレスポンスオブジェクトで reset() を呼び出すことです。
    次で指定:
    インターフェース ServletResponseEE の resetEE
    オーバーライド:
    クラス ServletResponseWrapperEE の resetEE
    関連事項:
    ServletResponse.setBufferSize(int)EE, ServletResponse.getBufferSize()EE, ServletResponse.flushBuffer()EE, ServletResponse.isCommitted()EE
  - getStatusCode
```
@DeprecatedSE
public int getStatusCode()
```
    非推奨。5.2 から HttpServletResponse.getStatus()EE に変更
    レスポンスで指定されたステータスコードを返します。
  - getContentAsByteArray
```
public byte[] getContentAsByteArray()
```
    キャッシュされたレスポンスコンテンツをバイト配列として返します。
  - getContentInputStream
```
public InputStreamSE getContentInputStream()
```
    キャッシュされたコンテンツに InputStreamSE を返します。
    導入:
    4.2
  - getContentSize
```
public int getContentSize()
```
    キャッシュされたコンテンツの現在のサイズを返します。
    導入:
    4.2
  - copyBodyToResponse
```
public void copyBodyToResponse()
                        throws IOExceptionSE
```
    キャッシュされた完全な本文コンテンツをレスポンスにコピーします。
    例外:
    IOExceptionSE
    導入:
    4.2
  - copyBodyToResponse
```
protected void copyBodyToResponse(boolean complete)
                           throws IOExceptionSE
```
    キャッシュされた本文コンテンツをレスポンスにコピーします。
    パラメーター:
    complete - 完全なキャッシュされた本文コンテンツに対応するコンテンツの長さを設定するかどうか
    例外:
    IOExceptionSE
    導入:
    4.2

クラス ContentCachingResponseWrapper

フィールドのサマリー

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

コンストラクターの詳細

ContentCachingResponseWrapper

メソッドの詳細

sendError

sendError

sendRedirect

getOutputStream

getWriter

flushBuffer

setContentLength

setContentLengthLong

setBufferSize

resetBuffer

reset

getStatusCode

getContentAsByteArray

getContentInputStream

getContentSize

copyBodyToResponse

copyBodyToResponse