MockHttpServletResponse (Spring Framework API)

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

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

フィールドのサマリー
- インターフェース 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)`
`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()`
`byte[]`	`getContentAsByteArray()`
`StringSE`	`getContentAsString()` アプリケーションによってレスポンスに指定された文字セットを使用して、`HttpServletResponse`EE メソッドまたは `Content-Type` の文字セットパラメーターを介して、レスポンス本文のコンテンツを `String` として取得します。
`StringSE`	`getContentAsString(CharsetSE fallbackCharset)` 文字セットが明示的に定義されていない場合は提供された `fallbackCharset` を使用し、それ以外の場合は `HttpServletResponse`EE メソッドまたは `Content-Type` の文字セットパラメーターを使用してアプリケーションによってレスポンスに指定された文字セットを使用して、レスポンス本文のコンテンツを `String` として取得します。
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`StringSE`	`getContentType()`
`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()`
`ServletOutputStreamEE`	`getOutputStream()`
`StringSE`	`getRedirectedUrl()`
`int`	`getStatus()`
`PrintWriterSE`	`getWriter()`
`boolean`	`isCharset()` 文字エンコードが `HttpServletResponse`EE メソッドを介して明示的に設定されているか、`Content-Type` の `charset` パラメーターを介して明示的に設定されているかを判別します。
`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)`
`void`	`setBufferSize(int bufferSize)`
`void`	`setCharacterEncoding(StringSE characterEncoding)`
`void`	`setCommitted(boolean committed)`
`void`	`setContentLength(int contentLength)`
`void`	`setContentLengthLong(long contentLength)`
`void`	`setContentType(StringSE contentType)`
`void`	`setDateHeader(StringSE name, long value)`
`void`	`setDefaultCharacterEncoding(StringSE characterEncoding)` レスポンスのデフォルトの文字エンコードを設定します。
`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() アクセスが許可されているかどうかを返します。
  - setDefaultCharacterEncoding
```
public void setDefaultCharacterEncoding(StringSE characterEncoding)
```
    レスポンスのデフォルトの文字エンコードを設定します。
    このメソッドが呼び出されない場合、ISO-8859-1 がデフォルトの文字エンコードとして使用されます。
    レスポンスの文字エンコードが setCharacterEncoding(String) または setContentType(String) を介して明示的に設定されていない場合、レスポンスの文字エンコードは指定されたデフォルトの文字エンコードに設定されます。
    パラメーター:
    characterEncoding - デフォルトの文字エンコード
    導入:
    5.3.10
    関連事項:
    setCharacterEncoding(String), setContentType(String)
  - isCharset
```
public boolean isCharset()
```
    文字エンコードが HttpServletResponseEE メソッドを介して明示的に設定されているか、Content-Type の charset パラメーターを介して明示的に設定されているかを判別します。
    false の場合、getCharacterEncoding() はデフォルトの文字エンコードを返します。
  - setCharacterEncoding
```
public void setCharacterEncoding(StringSE characterEncoding)
```
    次で指定:
    インターフェース ServletResponseEE の setCharacterEncodingEE
  - getCharacterEncoding
```
public StringSE getCharacterEncoding()
```
    次で指定:
    インターフェース ServletResponseEE の getCharacterEncodingEE
  - getOutputStream
```
public ServletOutputStreamEE getOutputStream()
```
    次で指定:
    インターフェース ServletResponseEE の getOutputStreamEE
  - getWriter
```
public PrintWriterSE getWriter()
                      throws UnsupportedEncodingExceptionSE
```
    次で指定:
    インターフェース ServletResponseEE の getWriterEE
    例外:
    UnsupportedEncodingExceptionSE
  - getContentAsByteArray
```
public byte[] getContentAsByteArray()
```
  - getContentAsString
```
public StringSE getContentAsString()
                          throws UnsupportedEncodingExceptionSE
```
    HttpServletResponseEE メソッドまたは Content-Type の charset パラメーターのいずれかを介して、アプリケーションによってレスポンスに指定された文字セットを使用して、レスポンス本文のコンテンツを String として取得します。文字セットが明示的に定義されていない場合は、デフォルトの文字エンコードが使用されます。
    戻り値:
    String としてのコンテンツ
    例外:
    UnsupportedEncodingExceptionSE - 文字エンコードがサポートされていない場合
    関連事項:
    getContentAsString(Charset), setCharacterEncoding(String), setContentType(String)
  - getContentAsString
```
public StringSE getContentAsString(CharsetSE fallbackCharset)
                          throws UnsupportedEncodingExceptionSE
```
    文字セットが明示的に定義されていない場合は提供された fallbackCharset を使用し、それ以外の場合は HttpServletResponseEE メソッドまたは Content-Type の文字セットパラメーターを使用してアプリケーションによってレスポンスに指定された文字セットを使用して、レスポンス本文のコンテンツを String として取得します。
    戻り値:
    String としてのコンテンツ
    例外:
    UnsupportedEncodingExceptionSE - 文字エンコードがサポートされていない場合
    導入:
    5.2
    関連事項:
    getContentAsString(), setCharacterEncoding(String), setContentType(String)
  - setContentLength
```
public void setContentLength(int contentLength)
```
    次で指定:
    インターフェース ServletResponseEE の setContentLengthEE
  - getContentLength
```
public int getContentLength()
```
  - setContentLengthLong
```
public void setContentLengthLong(long contentLength)
```
    次で指定:
    インターフェース ServletResponseEE の setContentLengthLongEE
  - getContentLengthLong
```
public long getContentLengthLong()
```
  - setContentType
```
public void setContentType(@Nullable
                           StringSE contentType)
```
    次で指定:
    インターフェース ServletResponseEE の setContentTypeEE
  - getContentType
```
@Nullable
public StringSE getContentType()
```
    次で指定:
    インターフェース ServletResponseEE の getContentTypeEE
  - setBufferSize
```
public void setBufferSize(int bufferSize)
```
    次で指定:
    インターフェース ServletResponseEE の setBufferSizeEE
  - getBufferSize
```
public int getBufferSize()
```
    次で指定:
    インターフェース ServletResponseEE の getBufferSizeEE
  - flushBuffer
```
public void flushBuffer()
```
    次で指定:
    インターフェース ServletResponseEE の flushBufferEE
  - resetBuffer
```
public void resetBuffer()
```
    次で指定:
    インターフェース ServletResponseEE の resetBufferEE
  - setCommitted
```
public void setCommitted(boolean committed)
```
  - isCommitted
```
public boolean isCommitted()
```
    次で指定:
    インターフェース ServletResponseEE の isCommittedEE
  - reset
```
public void reset()
```
    次で指定:
    インターフェース ServletResponseEE の resetEE
  - setLocale
```
public void setLocale(@Nullable
                      LocaleSE locale)
```
    次で指定:
    インターフェース ServletResponseEE の setLocaleEE
  - getLocale
```
public LocaleSE getLocale()
```
    次で指定:
    インターフェース ServletResponseEE の getLocaleEE
  - addCookie
```
public void addCookie(CookieEE cookie)
```
    次で指定:
    インターフェース HttpServletResponseEE の addCookieEE
  - getCookies
```
public CookieEE[] getCookies()
```
  - getCookie
```
@Nullable
public CookieEE getCookie(StringSE name)
```
  - containsHeader
```
public boolean containsHeader(StringSE name)
```
    次で指定:
    インターフェース HttpServletResponseEE の containsHeaderEE
  - getHeaderNames
```
public CollectionSE<StringSE> getHeaderNames()
```
    指定されたすべてのヘッダーの名前を文字列のセットとして返します。
    Servlet 3.0 以降、このメソッドは HttpServletResponseEE でも定義されています。
    次で指定:
    インターフェース HttpServletResponseEE の getHeaderNamesEE
    戻り値:
    ヘッダー名 Strings の Set、ない場合は空の Set
  - getHeader
```
@Nullable
public StringSE getHeader(StringSE name)
```
    存在する場合、指定されたヘッダーのプライマリ値を文字列として返します。複数の値の場合、最初の値を返します。
    Servlet 3.0 の時点で、このメソッドは HttpServletResponseEE でも定義されています。Spring 3.1 では、Servlet 3.0 互換性のために文字列化された値を返します。生のオブジェクトアクセスに getHeaderValue(String) を使用することを検討してください。
    次で指定:
    インターフェース HttpServletResponseEE の getHeaderEE
    パラメーター:
    name - ヘッダーの名前
    戻り値:
    関連するヘッダー値、ない場合は null
  - getHeaders
```
public ListSE<StringSE> getHeaders(StringSE name)
```
    指定されたヘッダーのすべての値を文字列のリストとして返します。
    Servlet 3.0 の時点で、このメソッドは HttpServletResponseEE でも定義されています。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
  - encodeRedirectURL
```
public StringSE encodeRedirectURL(StringSE url)
```
    デフォルトの実装は encodeURL(java.lang.String) に委譲し、指定された URL 文字列をそのまま返します。
    サブクラスでオーバーライドでき、リダイレクト固有の方法でセッション ID などを追加できます。一般的な URL エンコーディングルールについては、代わりに一般的な encodeURL(java.lang.String) メソッドをオーバーライドし、一般的な URL だけでなくリダイレクト URL にも適用します。
    次で指定:
    インターフェース HttpServletResponseEE の encodeRedirectURLEE
  - encodeUrl
```
@DeprecatedSE
public StringSE encodeUrl(StringSE url)
```
    使用すべきではありません。
    次で指定:
    インターフェース HttpServletResponseEE の encodeUrlEE
  - encodeRedirectUrl
```
@DeprecatedSE
public StringSE encodeRedirectUrl(StringSE url)
```
    使用すべきではありません。
    次で指定:
    インターフェース HttpServletResponseEE の encodeRedirectUrlEE
  - sendError
```
public void sendError(int status,
                      StringSE errorMessage)
               throws IOExceptionSE
```
    次で指定:
    インターフェース HttpServletResponseEE の sendErrorEE
    例外:
    IOExceptionSE
  - sendError
```
public void sendError(int status)
               throws IOExceptionSE
```
    次で指定:
    インターフェース HttpServletResponseEE の sendErrorEE
    例外:
    IOExceptionSE
  - sendRedirect
```
public void sendRedirect(StringSE url)
                  throws IOExceptionSE
```
    次で指定:
    インターフェース HttpServletResponseEE の sendRedirectEE
    例外:
    IOExceptionSE
  - getRedirectedUrl
```
@Nullable
public StringSE getRedirectedUrl()
```
  - setDateHeader
```
public void setDateHeader(StringSE name,
                          long value)
```
    次で指定:
    インターフェース HttpServletResponseEE の setDateHeaderEE
  - addDateHeader
```
public void addDateHeader(StringSE name,
                          long value)
```
    次で指定:
    インターフェース HttpServletResponseEE の addDateHeaderEE
  - getDateHeader
```
public long getDateHeader(StringSE name)
```
  - setHeader
```
public void setHeader(StringSE name,
                      @Nullable
                      StringSE value)
```
    次で指定:
    インターフェース HttpServletResponseEE の setHeaderEE
  - addHeader
```
public void addHeader(StringSE name,
                      @Nullable
                      StringSE value)
```
    次で指定:
    インターフェース HttpServletResponseEE の addHeaderEE
  - setIntHeader
```
public void setIntHeader(StringSE name,
                         int value)
```
    次で指定:
    インターフェース HttpServletResponseEE の setIntHeaderEE
  - addIntHeader
```
public void addIntHeader(StringSE name,
                         int value)
```
    次で指定:
    インターフェース HttpServletResponseEE の addIntHeaderEE
  - setStatus
```
public void setStatus(int status)
```
    次で指定:
    インターフェース HttpServletResponseEE の setStatusEE
  - setStatus
```
@DeprecatedSE
public void setStatus(int status,
                                  StringSE errorMessage)
```
    使用すべきではありません。
    次で指定:
    インターフェース HttpServletResponseEE の setStatusEE
  - getStatus
```
public int getStatus()
```
    次で指定:
    インターフェース 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

setDefaultCharacterEncoding

isCharset

setCharacterEncoding

getCharacterEncoding

getOutputStream

getWriter

getContentAsByteArray

getContentAsString

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