MockHttpServletResponse (Spring Framework 5.1.8.RELEASE API)

java.lang.ObjectSE
- org.springframework.mock.web.MockHttpServletResponse

実装されたすべてのインターフェース:
HttpServletResponseEE, ServletResponseEE
```
public class MockHttpServletResponse
extends ObjectSE
implements HttpServletResponseEE
```
HttpServletResponseEE インターフェースのモック実装。
Spring Framework 5.0 以降、このモックのセットは Servlet 4.0 ベースラインに基づいて設計されています。
導入:
1.0.2
作成者:
Juergen Hoeller, Rod Johnson, Brian Clozel, Vedran Pavic

フィールドサマリー
- インターフェース 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

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
MockHttpServletResponse()

コンストラクター
コンストラクターと説明
`MockHttpServletResponse()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`addCookie(CookieEE cookie)` 指定した Cookie をレスポンスに追加します。
`void`	`addDateHeader(StringSE name, long value)` 指定された名前と日付値を持つレスポンスヘッダーを追加します。
`void`	`addHeader(StringSE name, StringSE value)` 指定された名前と値でレスポンスヘッダーを追加します。
`void`	`addIncludedUrl(StringSE includedUrl)`
`void`	`addIntHeader(StringSE name, int value)` 指定された名前と整数値を持つレスポンスヘッダーを追加します。
`boolean`	`containsHeader(StringSE name)` 名前付きレスポンスヘッダーがすでに設定されているかどうかを示すブール値を返します。
`StringSE`	`encodeRedirectUrl(StringSE url)` 使用すべきではありません。
`StringSE`	`encodeRedirectURL(StringSE url)` デフォルトの実装は `encodeURL(java.lang.String)` に委譲し、指定された URL 文字列をそのまま返します。
`StringSE`	`encodeUrl(StringSE url)` 使用すべきではありません。
`StringSE`	`encodeURL(StringSE url)` デフォルトの実装は、指定された URL 文字列をそのまま返します。
`void`	`flushBuffer()` バッファ内のコンテンツを強制的にクライアントに書き込みます。
`int`	`getBufferSize()` レスポンスに使用される実際のバッファサイズを返します。
`StringSE`	`getCharacterEncoding()` このレスポンスで送信される本文に使用される文字エンコード（MIME 文字セット）の名前を返します。
`byte[]`	`getContentAsByteArray()`
`StringSE`	`getContentAsString()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`StringSE`	`getContentType()` このレスポンスで送信される MIME 本文に使用されるコンテンツ型を返します。
`CookieEE`	`getCookie(StringSE name)`
`CookieEE[]`	`getCookies()`
`long`	`getDateHeader(StringSE name)`
`StringSE`	`getErrorMessage()`
`StringSE`	`getForwardedUrl()`
`StringSE`	`getHeader(StringSE name)` 指定されたヘッダーのプライマリ値を String として返します（存在する場合）。
`CollectionSE<StringSE>`	`getHeaderNames()` 指定されたすべてのヘッダーの名前を文字列のセットとして返します。
`ListSE<StringSE>`	`getHeaders(StringSE name)` 指定されたヘッダーのすべての値を文字列のリストとして返します。
`ObjectSE`	`getHeaderValue(StringSE name)` 存在する場合、指定されたヘッダーのプライマリ値を返します。
`ListSE<ObjectSE>`	`getHeaderValues(StringSE name)` 指定されたヘッダーのすべての値を値オブジェクトのリストとして返します。
`StringSE`	`getIncludedUrl()`
`ListSE<StringSE>`	`getIncludedUrls()`
`LocaleSE`	`getLocale()` `ServletResponse.setLocale(java.util.Locale)`EE メソッドを使用して、このレスポンスに指定されたロケールを返します。
`ServletOutputStreamEE`	`getOutputStream()` レスポンスにバイナリデータを書き込むのに適した `ServletOutputStream`EE を返します。
`StringSE`	`getRedirectedUrl()`
`int`	`getStatus()` このレスポンスの現在のステータスコードを取得します。
`PrintWriterSE`	`getWriter()` クライアントに文字テキストを送信できる `PrintWriter` オブジェクトを返します。
`boolean`	`isCharset()` 文字エンコーディングが設定されているかどうかを返します。
`boolean`	`isCommitted()` レスポンスがコミットされたかどうかを示すブール値を返します。
`boolean`	`isOutputStreamAccessAllowed()` `getOutputStream()` アクセスが許可されているかどうかを返します。
`boolean`	`isWriterAccessAllowed()` `getOutputStream()` アクセスが許可されているかどうかを返します。
`void`	`reset()` バッファーに存在するすべてのデータとステータスコード、ヘッダーをクリアします。
`void`	`resetBuffer()` ヘッダーまたはステータスコードをクリアせずに、レスポンスの基になるバッファのコンテンツをクリアします。
`void`	`sendError(int status)` 指定されたステータスコードを使用してエラーレスポンスをクライアントに送信し、バッファをクリアします。
`void`	`sendError(int status, StringSE errorMessage)` 指定されたステータスを使用してエラーレスポンスをクライアントに送信し、バッファをクリアします。
`void`	`sendRedirect(StringSE url)` 指定されたリダイレクトロケーション URL を使用して一時的なリダイレクトレスポンスをクライアントに送信し、バッファーをクリアします。
`void`	`setBufferSize(int bufferSize)` レスポンスの本文の優先バッファサイズを設定します。
`void`	`setCharacterEncoding(StringSE characterEncoding)` クライアントに送信されるレスポンスの文字エンコード（MIME 文字セット）を、たとえば UTF-8 に設定します。
`void`	`setCommitted(boolean committed)`
`void`	`setContentLength(int contentLength)` レスポンス内のコンテンツ本文の長さを設定します。HTTP サーブレットでは、このメソッドは HTTP Content-Length ヘッダーを設定します。
`void`	`setContentLengthLong(long contentLength)` レスポンス内のコンテンツ本文の長さを設定します。HTTP サーブレットでは、このメソッドは HTTP Content-Length ヘッダーを設定します。
`void`	`setContentType(StringSE contentType)` レスポンスがまだコミットされていない場合、クライアントに送信されるレスポンスのコンテンツ型を設定します。
`void`	`setDateHeader(StringSE name, long value)` 指定された名前と日付値でレスポンスヘッダーを設定します。
`void`	`setForwardedUrl(StringSE forwardedUrl)`
`void`	`setHeader(StringSE name, StringSE value)` 指定された名前と値でレスポンスヘッダーを設定します。
`void`	`setIncludedUrl(StringSE includedUrl)`
`void`	`setIntHeader(StringSE name, int value)` 指定された名前と整数値でレスポンスヘッダーを設定します。
`void`	`setLocale(LocaleSE locale)` レスポンスがまだコミットされていない場合、レスポンスのロケールを設定します。
`void`	`setOutputStreamAccessAllowed(boolean outputStreamAccessAllowed)` `getOutputStream()` アクセスを許可するかどうかを設定します。
`void`	`setStatus(int status)` このレスポンスのステータスコードを設定します。
`void`	`setStatus(int status, StringSE errorMessage)` 使用すべきではありません。
`void`	`setWriterAccessAllowed(boolean writerAccessAllowed)` `getWriter()` アクセスを許可するかどうかを設定します。

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

インターフェース javax.servlet.http.HttpServletResponseEE から継承されたメソッド
getTrailerFieldsEE, setTrailerFieldsEE

- コンストラクターの詳細
  - MockHttpServletResponse
```
public MockHttpServletResponse()
```
- メソッドの詳細
  - setOutputStreamAccessAllowed
```
public void setOutputStreamAccessAllowed(boolean outputStreamAccessAllowed)
```
    getOutputStream() アクセスを許可するかどうかを設定します。
    デフォルトは true です。
  - isOutputStreamAccessAllowed
```
public boolean isOutputStreamAccessAllowed()
```
    getOutputStream() アクセスが許可されているかどうかを返します。
  - setWriterAccessAllowed
```
public void setWriterAccessAllowed(boolean writerAccessAllowed)
```
    getWriter() アクセスを許可するかどうかを設定します。
    デフォルトは true です。
  - isWriterAccessAllowed
```
public boolean isWriterAccessAllowed()
```
    getOutputStream() アクセスが許可されているかどうかを返します。
  - isCharset
```
public boolean isCharset()
```
    文字エンコーディングが設定されているかどうかを返します。
    false の場合、getCharacterEncoding() はデフォルトのエンコーディング値を返します。
  - setCharacterEncoding
```
public void setCharacterEncoding(StringSE characterEncoding)
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    クライアントに送信されるレスポンスの文字エンコード（MIME 文字セット）を、たとえば UTF-8 に設定します。レスポンス文字エンコードが ServletContext.setResponseCharacterEncoding(java.lang.String)EE、デプロイ記述子、setContentType() または setLocale() メソッドを使用してすでに設定されている場合、このメソッドで設定された値はそれらの値をオーバーライドします。text/html の String で ServletResponse.setContentType(java.lang.String)EE を呼び出し、UTF-8 の String でこのメソッドを呼び出すことは、text/html; charset=UTF-8 の String で setContentType を呼び出すことと同等です。
    このメソッドを繰り返し呼び出して、文字エンコーディングを変更できます。getWriter が呼び出された後、またはレスポンスがコミットされた後に呼び出された場合、このメソッドは効果がありません。
    プロトコルがその方法を提供する場合、コンテナーは、サーブレットレスポンスのライターに使用される文字エンコーディングをクライアントに伝える必要があります。HTTP の場合、文字エンコードは、テキストメディア型の Content-Type ヘッダーの一部として通信されます。サーブレットがコンテンツ型を指定しない場合、文字エンコードは HTTP ヘッダーを介して通信できないことに注意してください。ただし、サーブレットレスポンスのライターを介して書き込まれたテキストのエンコードには引き続き使用されます。
    次で指定:
    インターフェース ServletResponseEE の setCharacterEncodingEE
    パラメーター:
    characterEncoding - IANA 文字セットで定義された文字セットのみを指定する文字列 (http://www.iana.org/assignments/character-sets)
    関連事項:
    ServletResponse.setContentType(java.lang.String)EE, ServletResponse.setLocale(java.util.Locale)EE
  - getCharacterEncoding
```
@Nullable
public StringSE getCharacterEncoding()
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    このレスポンスで送信された本文に使用される文字エンコーディング（MIME 文字セット）の名前を返します。リクエストごと、Web アプリケーションごと（ServletContext.setResponseCharacterEncoding(java.lang.String)EE、デプロイ記述子を使用）、コンテナーごと（そのコンテナーにデプロイされたすべての Web アプリケーションについて、ベンダー固有の構成を使用）の優先度の降順で、レスポンス文字エンコードを指定する次のメソッドが参照されます。結果を生成するこれらのメソッドの最初の 1 つが返されます。リクエストごとに、setCharacterEncoding および setContentType メソッドを使用して明示的に、または setLocale（java.util.Locale）メソッドを使用して暗黙的にレスポンスの文字セットを指定できます。明示的な指定は、暗黙的な指定よりも優先されます。getWriter が呼び出された後、またはレスポンスがコミットされた後にこれらのメソッドを呼び出しても、文字エンコーディングには影響しません。文字エンコードが指定されていない場合、ISO-8859-1 が返されます。
    文字エンコードと MIME の詳細については、RFC 2047（http://www.ietf.org/rfc/rfc2047.txt) を参照してください。
    次で指定:
    インターフェース ServletResponseEE の getCharacterEncodingEE
    戻り値:
    文字エンコードの名前を指定する String、たとえば UTF-8
  - getOutputStream
```
public ServletOutputStreamEE getOutputStream()
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    レスポンスにバイナリデータを書き込むのに適した ServletOutputStreamEE を返します。サーブレットコンテナーはバイナリデータをエンコードしません。
    ServletOutputStream で flush() を呼び出すと、レスポンスがコミットされます。ServletResponse.reset()EE が呼び出された場合を除き、このメソッドまたは ServletResponse.getWriter()EE のいずれかを呼び出して、両方ではなく本体を書き込むことができます。
    次で指定:
    インターフェース ServletResponseEE の getOutputStreamEE
    戻り値:
    バイナリデータを書き込むための ServletOutputStreamEE
    関連事項:
    ServletResponse.getWriter()EE, ServletResponse.reset()EE
  - getWriter
```
public PrintWriterSE getWriter()
                      throws UnsupportedEncodingExceptionSE
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    クライアントに文字テキストを送信できる PrintWriter オブジェクトを返します。PrintWriter は、ServletResponse.getCharacterEncoding()EE によって返される文字エンコードを使用します。getCharacterEncoding に従って、レスポンスの文字エンコードが指定されていない場合（つまり、メソッドはデフォルト値 ISO-8859-1 を返すだけ）、getWriter はそれを ISO-8859-1 に更新します。
    PrintWriter で flush() を呼び出すと、レスポンスがコミットされます。
    ServletResponse.reset()EE が呼び出された場合を除き、このメソッドまたは ServletResponse.getOutputStream()EE のいずれかを呼び出して、両方ではなく本体を書き込むことができます。
    次で指定:
    インターフェース ServletResponseEE の getWriterEE
    戻り値:
    クライアントに文字データを返すことができる PrintWriter オブジェクト
    例外:
    UnsupportedEncodingExceptionSE - getCharacterEncoding によって返された文字エンコードを使用できない場合
    関連事項:
    ServletResponse.getOutputStream()EE, ServletResponse.setCharacterEncoding(java.lang.String)EE, ServletResponse.reset()EE
  - getContentAsByteArray
```
public byte[] getContentAsByteArray()
```
  - getContentAsString
```
public StringSE getContentAsString()
                          throws UnsupportedEncodingExceptionSE
```
    例外:
    UnsupportedEncodingExceptionSE
  - setContentLength
```
public void setContentLength(int contentLength)
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    レスポンス内のコンテンツ本文の長さを設定します。HTTP サーブレットでは、このメソッドは HTTP Content-Length ヘッダーを設定します。
    次で指定:
    インターフェース ServletResponseEE の setContentLengthEE
    パラメーター:
    contentLength - クライアントに返されるコンテンツの長さを指定する整数。Content-Length ヘッダーを設定します
  - getContentLength
```
public int getContentLength()
```
  - setContentLengthLong
```
public void setContentLengthLong(long contentLength)
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    レスポンス内のコンテンツ本文の長さを設定します。HTTP サーブレットでは、このメソッドは HTTP Content-Length ヘッダーを設定します。
    次で指定:
    インターフェース ServletResponseEE の setContentLengthLongEE
    パラメーター:
    contentLength - クライアントに返されるコンテンツの長さを指定する long; Content-Length ヘッダーを設定します
  - getContentLengthLong
```
public long getContentLengthLong()
```
  - setContentType
```
public void setContentType(@Nullable
                           StringSE contentType)
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    レスポンスがまだコミットされていない場合、クライアントに送信されるレスポンスのコンテンツ型を設定します。指定されたコンテンツ型には、text/html;charset=UTF-8 などの文字エンコーディング仕様が含まれる場合があります。getWriter が呼び出される前にこのメソッドが呼び出された場合、レスポンスの文字エンコードは指定されたコンテンツ型からのみ設定されます。
    このメソッドは、コンテンツ型と文字エンコーディングを変更するために繰り返し呼び出される場合があります。このメソッドは、レスポンスがコミットされた後に呼び出されても効果がありません。getWriter が呼び出された後、またはレスポンスがコミットされた後に呼び出された場合、レスポンスの文字エンコードは設定されません。
    プロトコルがそうする方法を提供する場合、コンテナーはサーブレットレスポンスのライターに使用されるコンテンツ型と文字エンコーディングをクライアントに通信する必要があります。HTTP の場合、Content-Type ヘッダーが使用されます。
    次で指定:
    インターフェース ServletResponseEE の setContentTypeEE
    パラメーター:
    contentType - コンテンツの MIME 型を指定する String
    関連事項:
    ServletResponse.setLocale(java.util.Locale)EE, ServletResponse.setCharacterEncoding(java.lang.String)EE, ServletResponse.getOutputStream()EE, ServletResponse.getWriter()EE
  - getContentType
```
@Nullable
public StringSE getContentType()
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    このレスポンスで送信される MIME 本文に使用されるコンテンツ型を返します。レスポンスをコミットする前に、ServletResponse.setContentType(java.lang.String)EE を使用して適切なコンテンツ型を指定する必要があります。コンテンツ型が指定されていない場合、このメソッドは null を返します。コンテンツ型が指定されており、ServletResponse.getCharacterEncoding()EE または ServletResponse.getWriter()EE に従って文字エンコードが明示的または暗黙的に指定されている場合、charset パラメーターは返される文字列に含まれます。文字エンコードが指定されていない場合、charset パラメーターは省略されます。
    次で指定:
    インターフェース ServletResponseEE の getContentTypeEE
    戻り値:
    text/html; charset=UTF-8 などのコンテンツ型を指定する String または null
  - setBufferSize
```
public void setBufferSize(int bufferSize)
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    レスポンスの本文の優先バッファサイズを設定します。サーブレットコンテナーは、少なくともリクエストされたサイズと同じ大きさのバッファを使用します。使用される実際のバッファサイズは、getBufferSize を使用して見つけることができます。
    バッファを大きくすると、実際に何かが送信される前により多くのコンテンツを書き込むことができるため、サーブレットに適切なステータスコードとヘッダーを設定する時間をより多く提供できます。バッファを小さくすると、サーバーのメモリ負荷が減少し、クライアントがデータをより早く受信できるようになります。
    このメソッドは、レスポンス本文のコンテンツが書き込まれる前に呼び出す必要があります。コンテンツが書き込まれた場合、またはレスポンスオブジェクトがコミットされた場合、このメソッドは IllegalStateException をスローします。
    次で指定:
    インターフェース ServletResponseEE の setBufferSizeEE
    パラメーター:
    bufferSize - 優先バッファサイズ
    関連事項:
    ServletResponse.getBufferSize()EE, ServletResponse.flushBuffer()EE, ServletResponse.isCommitted()EE, ServletResponse.reset()EE
  - getBufferSize
```
public int getBufferSize()
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    レスポンスに使用される実際のバッファサイズを返します。バッファリングが使用されていない場合、このメソッドは 0 を返します。
    次で指定:
    インターフェース ServletResponseEE の getBufferSizeEE
    戻り値:
    使用される実際のバッファサイズ
    関連事項:
    ServletResponse.setBufferSize(int)EE, ServletResponse.flushBuffer()EE, ServletResponse.isCommitted()EE, ServletResponse.reset()EE
  - flushBuffer
```
public void flushBuffer()
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    バッファ内のコンテンツを強制的にクライアントに書き込みます。このメソッドを呼び出すと、レスポンスが自動的にコミットされます。つまり、ステータスコードとヘッダーが書き込まれます。
    次で指定:
    インターフェース ServletResponseEE の flushBufferEE
    関連事項:
    ServletResponse.setBufferSize(int)EE, ServletResponse.getBufferSize()EE, ServletResponse.isCommitted()EE, ServletResponse.reset()EE
  - resetBuffer
```
public void resetBuffer()
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    ヘッダーまたはステータスコードをクリアせずに、レスポンスの基になるバッファのコンテンツをクリアします。レスポンスがコミットされている場合、このメソッドは IllegalStateException をスローします。
    次で指定:
    インターフェース ServletResponseEE の resetBufferEE
    関連事項:
    ServletResponse.setBufferSize(int)EE, ServletResponse.getBufferSize()EE, ServletResponse.isCommitted()EE, ServletResponse.reset()EE
  - setCommitted
```
public void setCommitted(boolean committed)
```
  - isCommitted
```
public boolean isCommitted()
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    レスポンスがコミットされたかどうかを示すブール値を返します。コミットされたレスポンスには、すでにステータスコードとヘッダーが書き込まれています。
    次で指定:
    インターフェース ServletResponseEE の isCommittedEE
    戻り値:
    レスポンスがコミットされたかどうかを示すブール値
    関連事項:
    ServletResponse.setBufferSize(int)EE, ServletResponse.getBufferSize()EE, ServletResponse.flushBuffer()EE, ServletResponse.reset()EE
  - reset
```
public void reset()
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    バッファーに存在するすべてのデータとステータスコード、ヘッダーをクリアします。ServletResponse.getWriter()EE または ServletResponse.getOutputStream()EE の呼び出し状態もクリアされます。たとえば、ServletResponse.getWriter()EE、ServletResponse.reset()EE、ServletResponse.getOutputStream()EE を呼び出すことは正当です。このメソッドの前に ServletResponse.getWriter()EE または ServletResponse.getOutputStream()EE が呼び出された場合、対応する返された Writer または OutputStream が停止し、古いオブジェクトを使用する動作は未定義になります。レスポンスがコミットされている場合、このメソッドは IllegalStateException をスローします。
    次で指定:
    インターフェース ServletResponseEE の resetEE
    関連事項:
    ServletResponse.setBufferSize(int)EE, ServletResponse.getBufferSize()EE, ServletResponse.flushBuffer()EE, ServletResponse.isCommitted()EE
  - setLocale
```
public void setLocale(LocaleSE locale)
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    レスポンスがまだコミットされていない場合、レスポンスのロケールを設定します。また、ServletResponse.setContentType(java.lang.String)EE または ServletResponse.setCharacterEncoding(java.lang.String)EE を使用して文字エンコーディングが明示的に設定されておらず、getWriter がまだ呼び出されておらず、レスポンスがまだコミットされていない場合、ロケールのレスポンスに適切に文字エンコーディングを設定します。デプロイ記述子に locale-encoding-mapping-list 要素が含まれ、その要素が指定されたロケールのマッピングを提供する場合、そのマッピングが使用されます。それ以外の場合、ロケールから文字エンコーディングへのマッピングはコンテナーに依存します。
    このメソッドは、ロケールと文字エンコーディングを変更するために繰り返し呼び出される場合があります。レスポンスがコミットされた後に呼び出された場合、メソッドは効果がありません。ServletResponse.setContentType(java.lang.String)EE が文字セット指定で呼び出された後、ServletResponse.setCharacterEncoding(java.lang.String)EE が呼び出された後、getWriter が呼び出された後、レスポンスがコミットされた後に呼び出された場合、レスポンスの文字エンコードは設定されません。
    プロトコルがその方法を提供する場合、コンテナーは、サーブレットレスポンスのライタに使用されるロケールと文字エンコーディングをクライアントに伝える必要があります。HTTP の場合、ロケールは、Content-Language ヘッダー、テキストメディア型の Content-Type ヘッダーの一部としての文字エンコードを介して通信されます。サーブレットがコンテンツ型を指定しない場合、文字エンコードは HTTP ヘッダーを介して通信できないことに注意してください。ただし、サーブレットレスポンスのライターを介して書き込まれたテキストのエンコードには引き続き使用されます。
    次で指定:
    インターフェース ServletResponseEE の setLocaleEE
    パラメーター:
    locale - レスポンスのロケール
    関連事項:
    ServletResponse.getLocale()EE, ServletResponse.setContentType(java.lang.String)EE, ServletResponse.setCharacterEncoding(java.lang.String)EE
  - getLocale
```
public LocaleSE getLocale()
```
    インターフェースからコピーされた説明: javax.servlet.ServletResponseEE
    ServletResponse.setLocale(java.util.Locale)EE メソッドを使用して、このレスポンスに指定されたロケールを返します。レスポンスのコミット後に setLocale を呼び出しても効果はありません。ロケールが指定されていない場合、コンテナーのデフォルトのロケールが返されます。
    次で指定:
    インターフェース ServletResponseEE の getLocaleEE
    戻り値:
    このレスポンスのロケール。
    関連事項:
    ServletResponse.setLocale(java.util.Locale)EE
  - addCookie
```
public void addCookie(CookieEE cookie)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定した Cookie をレスポンスに追加します。このメソッドを複数回呼び出して、複数の Cookie を設定できます。
    次で指定:
    インターフェース HttpServletResponseEE の addCookieEE
    パラメーター:
    cookie - Cookie をクライアントに返す
  - getCookies
```
public CookieEE[] getCookies()
```
  - getCookie
```
@Nullable
public CookieEE getCookie(StringSE name)
```
  - containsHeader
```
public boolean containsHeader(StringSE name)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    名前付きレスポンスヘッダーがすでに設定されているかどうかを示すブール値を返します。
    次で指定:
    インターフェース HttpServletResponseEE の containsHeaderEE
    パラメーター:
    name - ヘッダー名
    戻り値:
    名前付きレスポンスヘッダーがすでに設定されている場合は true。それ以外の場合は false
  - getHeaderNames
```
public CollectionSE<StringSE> getHeaderNames()
```
    指定されたすべてのヘッダーの名前を文字列のセットとして返します。
    Servlet 3.0 以降、このメソッドは HttpServletResponse でも定義されます。
    次で指定:
    インターフェース HttpServletResponseEE の getHeaderNamesEE
    戻り値:
    ヘッダー名 Strings の Set、ない場合は空の Set
  - getHeader
```
@Nullable
public StringSE getHeader(StringSE name)
```
    存在する場合、指定されたヘッダーのプライマリ値を文字列として返します。複数の値の場合、最初の値を返します。
    Servlet 3.0 以降、このメソッドは HttpServletResponse でも定義されています。Spring 3.1 以降、Servlet 3.0 との互換性のために文字列化された値を返します。生のオブジェクトアクセスには getHeaderValue(String) の使用を検討してください。
    次で指定:
    インターフェース HttpServletResponseEE の getHeaderEE
    パラメーター:
    name - ヘッダーの名前
    戻り値:
    関連するヘッダー値、ない場合は null
  - getHeaders
```
public ListSE<StringSE> getHeaders(StringSE name)
```
    指定されたヘッダーのすべての値を文字列のリストとして返します。
    Servlet 3.0 以降、このメソッドは HttpServletResponse でも定義されています。Spring 3.1 以降、Servlet 3.0 との互換性のために文字列化された値のリストを返します。生のオブジェクトアクセスには getHeaderValues(String) の使用を検討してください。
    次で指定:
    インターフェース HttpServletResponseEE の getHeadersEE
    パラメーター:
    name - ヘッダーの名前
    戻り値:
    関連するヘッダー値、ない場合は空のリスト
  - getHeaderValue
```
@Nullable
public ObjectSE getHeaderValue(StringSE name)
```
    存在する場合、指定されたヘッダーのプライマリ値を返します。
    複数の値の場合、最初の値を返します。
    パラメーター:
    name - ヘッダーの名前
    戻り値:
    関連するヘッダー値、ない場合は null
  - getHeaderValues
```
public ListSE<ObjectSE> getHeaderValues(StringSE name)
```
    指定されたヘッダーのすべての値を値オブジェクトのリストとして返します。
    パラメーター:
    name - ヘッダーの名前
    戻り値:
    関連するヘッダー値、ない場合は空のリスト
  - encodeURL
```
public StringSE encodeURL(StringSE url)
```
    デフォルトの実装は、指定された URL 文字列をそのまま返します。
    サブクラスでオーバーライドでき、セッション ID などを追加します。
    次で指定:
    インターフェース HttpServletResponseEE の encodeURLEE
    パラメーター:
    url - エンコードされる URL。
    戻り値:
    エンコードが必要な場合はエンコードされた URL。それ以外の場合は未変更の URL。
  - encodeRedirectURL
```
public StringSE encodeRedirectURL(StringSE url)
```
    デフォルトの実装は encodeURL(java.lang.String) に委譲し、指定された URL 文字列をそのまま返します。
    サブクラスでオーバーライドでき、リダイレクト固有の方法でセッション ID などを追加できます。一般的な URL エンコーディングルールについては、代わりに一般的な encodeURL(java.lang.String) メソッドをオーバーライドし、一般的な URL だけでなくリダイレクト URL にも適用します。
    次で指定:
    インターフェース HttpServletResponseEE の encodeRedirectURLEE
    パラメーター:
    url - エンコードされる URL。
    戻り値:
    エンコードが必要な場合はエンコードされた URL。それ以外の場合は未変更の URL。
    関連事項:
    HttpServletResponse.sendRedirect(java.lang.String)EE, HttpServletResponse.encodeUrl(java.lang.String)EE
  - encodeUrl
```
@DeprecatedSE
public StringSE encodeUrl(StringSE url)
```
    使用すべきではありません。
    次で指定:
    インターフェース HttpServletResponseEE の encodeUrlEE
    パラメーター:
    url - エンコードされる URL。
    戻り値:
    エンコードが必要な場合はエンコードされた URL。それ以外の場合は未変更の URL。
  - encodeRedirectUrl
```
@DeprecatedSE
public StringSE encodeRedirectUrl(StringSE url)
```
    使用すべきではありません。
    次で指定:
    インターフェース HttpServletResponseEE の encodeRedirectUrlEE
    パラメーター:
    url - エンコードされる URL。
    戻り値:
    エンコードが必要な場合はエンコードされた URL。それ以外の場合は未変更の URL。
  - sendError
```
public void sendError(int status,
                      StringSE errorMessage)
               throws IOExceptionSE
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定されたステータスを使用してクライアントにエラーレスポンスを送信し、バッファをクリアします。サーバーはデフォルトで、指定されたメッセージを含む HTML 形式のサーバーエラーページのように見えるレスポンスを作成し、コンテンツ型を "text/html" に設定します。呼び出し元は、現在のレスポンスのエンコードとコンテンツ型に関して安全であることを確認するために、メッセージをエスケープまたは再エンコードする責任を負いません。安全性のこの側面は、メッセージを含むエラーページを生成するため、コンテナーの責任です。サーバーは Cookie を保持し、エラーページを有効なレスポンスとして提供するために必要なヘッダーをクリアまたは更新する場合があります。
    渡されたステータスコードに対応する Web アプリケーションのエラーページ宣言が行われた場合、提案された msg パラメーターよりも優先して返され、msg パラメーターは無視されます。
    レスポンスがすでにコミットされている場合、このメソッドは IllegalStateException をスローします。このメソッドを使用した後、レスポンスはコミットされたと見なされるべきであり、書き込まれるべきではありません。
    次で指定:
    インターフェース HttpServletResponseEE の sendErrorEE
    パラメーター:
    status - エラー状態コード
    errorMessage - 説明的なメッセージ
    例外:
    IOExceptionSE - 入力または出力の例外が発生した場合
  - sendError
```
public void sendError(int status)
               throws IOExceptionSE
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定されたステータスコードを使用してエラーレスポンスをクライアントに送信し、バッファをクリアします。サーバーは Cookie を保持し、エラーページを有効なレスポンスとして提供するために必要なヘッダーをクリアまたは更新する場合があります。渡されたステータスコードに対応する Web アプリケーションのエラーページ宣言が行われた場合、エラーページが返されます。
    レスポンスがすでにコミットされている場合、このメソッドは IllegalStateException をスローします。このメソッドを使用した後、レスポンスはコミットされたと見なされるべきであり、書き込まれるべきではありません。
    次で指定:
    インターフェース HttpServletResponseEE の sendErrorEE
    パラメーター:
    status - エラー状態コード
    例外:
    IOExceptionSE - 入力または出力の例外が発生した場合
  - sendRedirect
```
public void sendRedirect(StringSE url)
                  throws IOExceptionSE
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定されたリダイレクトロケーション URL を使用して一時的なリダイレクトレスポンスをクライアントに送信し、バッファーをクリアします。バッファは、このメソッドによって設定されたデータに置き換えられます。このメソッドを呼び出すと、ステータスコードが HttpServletResponse.SC_FOUNDEE 302（Found）に設定されます。このメソッドは相対 URL を受け入れることができます。サーブレットコンテナーは、レスポンスをクライアントに送信する前に相対 URL を絶対 URL に変換する必要があります。場所が先頭に "/" のない相対的な場所である場合、コンテナーは現在のリクエスト URI に相対的であると解釈します。ロケーションが先頭に "/" を付けた相対位置である場合、コンテナーはサーブレットコンテナールートに対する相対位置として解釈します。場所が 2 つの先頭 "/" で相対的な場合、コンテナーはそれをネットワークパス参照として解釈します（RFC 3986: ユニフォームリソース識別子 (URI): 汎用構文のセクション 4.2「相対参照」を参照）。
    レスポンスがすでにコミットされている場合、このメソッドは IllegalStateException をスローします。このメソッドを使用した後、レスポンスはコミットされたと見なされるべきであり、書き込まれるべきではありません。
    次で指定:
    インターフェース HttpServletResponseEE の sendRedirectEE
    パラメーター:
    url - リダイレクト場所の URL
    例外:
    IOExceptionSE - 入力または出力の例外が発生した場合
  - getRedirectedUrl
```
@Nullable
public StringSE getRedirectedUrl()
```
  - setDateHeader
```
public void setDateHeader(StringSE name,
                          long value)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定された名前と日付値でレスポンスヘッダーを設定します。日付は、エポックからのミリ秒で指定されます。ヘッダーがすでに設定されている場合、新しい値は以前の値を上書きします。containsHeader メソッドは、値を設定する前にヘッダーの存在をテストするために使用できます。
    次で指定:
    インターフェース HttpServletResponseEE の setDateHeaderEE
    パラメーター:
    name - 設定するヘッダーの名前
    value - 割り当てられた日付値
    関連事項:
    HttpServletResponse.containsHeader(java.lang.String)EE, HttpServletResponse.addDateHeader(java.lang.String, long)EE
  - addDateHeader
```
public void addDateHeader(StringSE name,
                          long value)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定された名前と日付値を持つレスポンスヘッダーを追加します。日付は、エポックからのミリ秒で指定されます。このメソッドにより、レスポンスヘッダーに複数の値を設定できます。
    次で指定:
    インターフェース HttpServletResponseEE の addDateHeaderEE
    パラメーター:
    name - 設定するヘッダーの名前
    value - 追加の日付値
    関連事項:
    HttpServletResponse.setDateHeader(java.lang.String, long)EE
  - getDateHeader
```
public long getDateHeader(StringSE name)
```
  - setHeader
```
public void setHeader(StringSE name,
                      StringSE value)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定された名前と値でレスポンスヘッダーを設定します。ヘッダーがすでに設定されている場合、新しい値は以前の値を上書きします。containsHeader メソッドは、値を設定する前にヘッダーの存在をテストするために使用できます。
    次で指定:
    インターフェース HttpServletResponseEE の setHeaderEE
    パラメーター:
    name - ヘッダーの名前
    value - ヘッダー値にオクテット文字列が含まれる場合、RFC 2047 に従ってエンコードする必要があります (http://www.ietf.org/rfc/rfc2047.txt)
    関連事項:
    HttpServletResponse.containsHeader(java.lang.String)EE, HttpServletResponse.addHeader(java.lang.String, java.lang.String)EE
  - addHeader
```
public void addHeader(StringSE name,
                      StringSE value)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定された名前と値でレスポンスヘッダーを追加します。このメソッドにより、レスポンスヘッダーに複数の値を設定できます。
    次で指定:
    インターフェース HttpServletResponseEE の addHeaderEE
    パラメーター:
    name - ヘッダーの名前
    value - 追加のヘッダー値オクテット文字列を含む場合、RFC 2047 に従ってエンコードする必要があります (http://www.ietf.org/rfc/rfc2047.txt)
    関連事項:
    HttpServletResponse.setHeader(java.lang.String, java.lang.String)EE
  - setIntHeader
```
public void setIntHeader(StringSE name,
                         int value)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定された名前と整数値でレスポンスヘッダーを設定します。ヘッダーがすでに設定されている場合、新しい値は以前の値を上書きします。containsHeader メソッドは、値を設定する前にヘッダーの存在をテストするために使用できます。
    次で指定:
    インターフェース HttpServletResponseEE の setIntHeaderEE
    パラメーター:
    name - ヘッダーの名前
    value - 割り当てられた整数値
    関連事項:
    HttpServletResponse.containsHeader(java.lang.String)EE, HttpServletResponse.addIntHeader(java.lang.String, int)EE
  - addIntHeader
```
public void addIntHeader(StringSE name,
                         int value)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    指定された名前と整数値を持つレスポンスヘッダーを追加します。このメソッドにより、レスポンスヘッダーに複数の値を設定できます。
    次で指定:
    インターフェース HttpServletResponseEE の addIntHeaderEE
    パラメーター:
    name - ヘッダーの名前
    value - 割り当てられた整数値
    関連事項:
    HttpServletResponse.setIntHeader(java.lang.String, int)EE
  - setStatus
```
public void setStatus(int status)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    このレスポンスのステータスコードを設定します。
    このメソッドは、エラーがない場合（たとえば、SC_OK または SC_MOVED_TEMPORARILY ステータスコード）に戻りステータスコードを設定するために使用されます。
    このメソッドを使用してエラーコードを設定すると、コンテナーのエラーページメカニズムはトリガーされません。エラーが発生し、呼び出し元が Web アプリケーションで定義されたエラーページを呼び出す場合は、代わりに HttpServletResponse.sendError(int, java.lang.String)EE を使用する必要があります。
    このメソッドは、Cookie およびその他のレスポンスヘッダーを保持します。
    有効なステータスコードは、2XX、3XX、4XX、5XX の範囲のものです。他のステータスコードは、コンテナー固有として扱われます。
    次で指定:
    インターフェース HttpServletResponseEE の setStatusEE
    パラメーター:
    status - ステータスコード
    関連事項:
    HttpServletResponse.sendError(int, java.lang.String)EE
  - setStatus
```
@DeprecatedSE
public void setStatus(int status,
                                  StringSE errorMessage)
```
    使用すべきではありません。
    次で指定:
    インターフェース HttpServletResponseEE の setStatusEE
    パラメーター:
    status - ステータスコード
    errorMessage - ステータスメッセージ
  - getStatus
```
public int getStatus()
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpServletResponseEE
    このレスポンスの現在のステータスコードを取得します。
    次で指定:
    インターフェース HttpServletResponseEE の getStatusEE
    戻り値:
    このレスポンスの現在のステータスコード
  - getErrorMessage
```
@Nullable
public StringSE getErrorMessage()
```
  - setForwardedUrl
```
public void setForwardedUrl(@Nullable
                            StringSE forwardedUrl)
```
  - getForwardedUrl
```
@Nullable
public StringSE getForwardedUrl()
```
  - setIncludedUrl
```
public void setIncludedUrl(@Nullable
                           StringSE includedUrl)
```
  - getIncludedUrl
```
@Nullable
public StringSE getIncludedUrl()
```
  - addIncludedUrl
```
public void addIncludedUrl(StringSE includedUrl)
```
  - getIncludedUrls
```
public ListSE<StringSE> getIncludedUrls()
```

クラス MockHttpServletResponse

フィールドサマリー

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

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

メソッドのサマリー

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

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

コンストラクターの詳細

MockHttpServletResponse

メソッドの詳細

setOutputStreamAccessAllowed

isOutputStreamAccessAllowed

setWriterAccessAllowed

isWriterAccessAllowed

isCharset

setCharacterEncoding

getCharacterEncoding

getOutputStream

getWriter

getContentAsByteArray

getContentAsString

setContentLength

getContentLength

setContentLengthLong

getContentLengthLong

setContentType

getContentType

setBufferSize

getBufferSize

flushBuffer

resetBuffer

setCommitted

isCommitted

reset

setLocale

getLocale

addCookie

getCookies

getCookie

containsHeader

getHeaderNames

getHeader

getHeaders

getHeaderValue

getHeaderValues

encodeURL

encodeRedirectURL

encodeUrl

encodeRedirectUrl

sendError

sendError

sendRedirect

getRedirectedUrl

setDateHeader

addDateHeader

getDateHeader

setHeader

addHeader

setIntHeader

addIntHeader

setStatus

setStatus

getStatus

getErrorMessage

setForwardedUrl

getForwardedUrl

setIncludedUrl

getIncludedUrl

addIncludedUrl

getIncludedUrls