クラス 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()

  文字エンコーディングが HttpServletResponse メソッドを通じて明示的に設定されているか、Content-Type の charset パラメーターを通じて設定されているかを判断します。

  false の場合、getCharacterEncoding() はデフォルトの文字エンコードを返します。

• setCharacterEncoding

  public void setCharacterEncoding(@Nullable StringSE characterEncoding)

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の setCharacterEncoding 

• getCharacterEncoding

  public StringSE getCharacterEncoding()

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の getCharacterEncoding 

• getOutputStream

  public jakarta.servlet.ServletOutputStream getOutputStream()

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の getOutputStream 

• getWriter

  public PrintWriterSE getWriter() throws UnsupportedEncodingExceptionSE

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の getWriter 

  例外:

  UnsupportedEncodingExceptionSE

• getContentAsByteArray

  public byte[] getContentAsByteArray()

• getContentAsString

  public StringSE getContentAsString() throws UnsupportedEncodingExceptionSE

  アプリケーションがレスポンスに指定した文字セット（HttpServletResponse メソッドまたは Content-Type の文字セットパラメーター）を使用して、レスポンス本体の内容を String として取得します。文字セットが明示的に定義されていない場合は、デフォルトの文字エンコーディングが使用されます。

  戻り値:

  String としてのコンテンツ

  例外:

  UnsupportedEncodingExceptionSE - 文字エンコードがサポートされていない場合

  関連事項:

  • getContentAsString(Charset)
  • setCharacterEncoding(String)
  • setContentType(String)

• getContentAsString

  public StringSE getContentAsString(CharsetSE fallbackCharset) throws UnsupportedEncodingExceptionSE

  レスポンス本体の内容を String として取得します。文字セットが明示的に定義されていない場合は提供された fallbackCharset を使用し、そうでない場合は HttpServletResponse メソッドまたは Content-Type の charset パラメーターを通じてアプリケーションによってレスポンスに指定された文字セットを使用します。

  戻り値:

  String としてのコンテンツ

  例外:

  UnsupportedEncodingExceptionSE - 文字エンコードがサポートされていない場合

  導入:

  5.2

  関連事項:

  • getContentAsString()
  • setCharacterEncoding(String)
  • setContentType(String)

• setContentLength

  public void setContentLength(int contentLength)

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の setContentLength 

• getContentLength

  public int getContentLength()

  HTTP Content-Length ヘッダーからコンテンツ本文の長さを取得します。

  戻り値:

  Content-Length ヘッダーの値

  関連事項:

  • setContentLength(int)

• setContentLengthLong

  public void setContentLengthLong(long contentLength)

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の setContentLengthLong 

• getContentLengthLong

  public long getContentLengthLong()

• setContentType

  public void setContentType(@Nullable StringSE contentType)

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の setContentType 

• getContentType

  public @Nullable StringSE getContentType()

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の getContentType 

• setBufferSize

  public void setBufferSize(int bufferSize)

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の setBufferSize 

• getBufferSize

  public int getBufferSize()

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の getBufferSize 

• flushBuffer

  public void flushBuffer()

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の flushBuffer 

• resetBuffer

  public void resetBuffer()

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の resetBuffer 

• setCommitted

  public void setCommitted(boolean committed)

• isCommitted

  public boolean isCommitted()

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の isCommitted 

• reset

  public void reset()

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の reset 

• setLocale

  public void setLocale(@Nullable LocaleSE locale)

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の setLocale 

• getLocale

  public LocaleSE getLocale()

  次で指定:

  インターフェース jakarta.servlet.ServletResponse の getLocale 

• addCookie

  public void addCookie(jakarta.servlet.http.Cookie cookie)

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の addCookie 

• getCookies

  public jakarta.servlet.http.Cookie[] getCookies()

• getCookie

  public @Nullable jakarta.servlet.http.Cookie getCookie(StringSE name)

• containsHeader

  public boolean containsHeader(StringSE name)

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の containsHeader 

• getHeaderNames

  public CollectionSE<StringSE> getHeaderNames()

  指定されたすべてのヘッダーの名前を文字列のセットとして返します。

  Servlet 3.0 以降、このメソッドは HttpServletResponse でも定義されています。

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の getHeaderNames 

  戻り値:

  ヘッダー名 Strings の Set、ない場合は空の Set 

• getHeader

  public @Nullable StringSE getHeader(StringSE name)

  指定されたヘッダーのプライマリ値を String として返します（存在する場合）。

  複数の値の場合、最初の値を返します。

  Servlet 3.0 互換性のために文字列化された値を返します。生のオブジェクトアクセスに getHeaderValue(String) を使用することを検討してください。

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の getHeader 

  パラメーター:

  name - ヘッダーの名前

  戻り値:

  関連するヘッダー値、ない場合は null 

  関連事項:

  • HttpServletResponse.getHeader(String)

• getHeaders

  public ListSE<StringSE> getHeaders(StringSE name)

  指定されたヘッダーのすべての値を文字列のリストとして返します。

  Servlet 3.0 互換性のために文字列化された値のリストを返します。生のオブジェクトアクセスに getHeaderValues(String) を使用することを検討してください。

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の getHeaders 

  パラメーター:

  name - ヘッダーの名前

  戻り値:

  関連するヘッダー値、ない場合は空のリスト

  関連事項:

  • HttpServletResponse.getHeaders(String)

• getHeaderValue

  public @Nullable ObjectSE getHeaderValue(StringSE name)

  存在する場合、指定されたヘッダーのプライマリ値を返します。

  複数の値の場合、最初の値を返します。

  パラメーター:

  name - ヘッダーの名前

  戻り値:

  関連するヘッダー値、ない場合は null 

• getHeaderValues

  public ListSE<ObjectSE> getHeaderValues(StringSE name)

  指定されたヘッダーのすべての値を値オブジェクトのリストとして返します。

  パラメーター:

  name - ヘッダーの名前

  戻り値:

  関連するヘッダー値、ない場合は空のリスト

• encodeURL

  public StringSE encodeURL(StringSE url)

  デフォルトの実装は、指定された URL 文字列をそのまま返します。

  サブクラスでオーバーライドでき、セッション ID などを追加します。

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の encodeURL 

• encodeRedirectURL

  public StringSE encodeRedirectURL(StringSE url)

  デフォルトの実装は encodeURL(String) に委譲し、指定された URL 文字列をそのまま返します。

  サブクラスでオーバーライドでき、リダイレクト固有の方法でセッション ID などを追加できます。一般的な URL エンコーディングルールについては、代わりに一般的な encodeURL(String) メソッドをオーバーライドし、一般的な URL だけでなくリダイレクト URL にも適用します。

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の encodeRedirectURL 

• sendError

  public void sendError(int status, StringSE errorMessage) throws IOExceptionSE

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の sendError 

  例外:

  IOExceptionSE

• sendError

  public void sendError(int status) throws IOExceptionSE

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の sendError 

  例外:

  IOExceptionSE

• sendRedirect

  public void sendRedirect(StringSE url) throws IOExceptionSE

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の sendRedirect 

  例外:

  IOExceptionSE

• sendRedirect

  public void sendRedirect(StringSE url, int sc, boolean clearBuffer) throws IOExceptionSE

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の sendRedirect 

  例外:

  IOExceptionSE

• getRedirectedUrl

  public @Nullable StringSE getRedirectedUrl()

• setDateHeader

  public void setDateHeader(StringSE name, long value)

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の setDateHeader 

• addDateHeader

  public void addDateHeader(StringSE name, long value)

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の addDateHeader 

• getDateHeader

  public long getDateHeader(StringSE name)

• setHeader

  public void setHeader(@Nullable StringSE name, @Nullable StringSE value)

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の setHeader 

• addHeader

  public void addHeader(@Nullable StringSE name, @Nullable StringSE value)

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の addHeader 

• setIntHeader

  public void setIntHeader(StringSE name, int value)

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の setIntHeader 

• addIntHeader

  public void addIntHeader(StringSE name, int value)

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の addIntHeader 

• setStatus

  public void setStatus(int status)

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の setStatus 

• getStatus

  public int getStatus()

  次で指定:

  インターフェース jakarta.servlet.http.HttpServletResponse の getStatus 

• getErrorMessage

  public @Nullable StringSE getErrorMessage()

  HttpServletResponse.sendError(int, String) を呼び出すときに使用されるエラーメッセージを返します。

• sendEarlyHints

  public void sendEarlyHints()

• setForwardedUrl

  public void setForwardedUrl(@Nullable StringSE forwardedUrl)

• getForwardedUrl

  public @Nullable StringSE getForwardedUrl()

• setIncludedUrl

  public void setIncludedUrl(@Nullable StringSE includedUrl)

• getIncludedUrl

  public @Nullable StringSE getIncludedUrl()

• addIncludedUrl

  public void addIncludedUrl(StringSE includedUrl)

• getIncludedUrls

  public ListSE<StringSE> getIncludedUrls()