クラス MockHttpServletRequest

メソッドの詳細

• getServletContext

  public ServletContextEE getServletContext()

  このリクエストが関連付けられている ServletContext を返します。(何らかの理由で、標準の HttpServletRequest インターフェースでは使用できません。)

  次で指定:

  インターフェース ServletRequestEE の getServletContextEE 

• isActive

  public boolean isActive()

  このリクエストがまだアクティブである（つまり、まだ完了していない）かどうかを返します。

• close

  public void close()

  このリクエストを完了済みとしてマークし、その状態を維持します。

• invalidate

  public void invalidate()

  このリクエストを無効にして、その状態をクリアします。

• checkActive

  protected void checkActive() throws IllegalStateExceptionSE

  このリクエストがまだアクティブである（つまり、まだ完了していない）かどうかを確認し、アクティブでない場合は IllegalStateException をスローします。

  例外:

  IllegalStateExceptionSE

• getAttribute

  @Nullable public ObjectSE getAttribute(StringSE name)

  次で指定:

  インターフェース ServletRequestEE の getAttributeEE 

• getAttributeNames

  public EnumerationSE<StringSE> getAttributeNames()

  次で指定:

  インターフェース ServletRequestEE の getAttributeNamesEE 

• getCharacterEncoding

  @Nullable public StringSE getCharacterEncoding()

  次で指定:

  インターフェース ServletRequestEE の getCharacterEncodingEE 

• setCharacterEncoding

  public void setCharacterEncoding(@Nullable StringSE characterEncoding)

  次で指定:

  インターフェース ServletRequestEE の setCharacterEncodingEE 

• setContent

  public void setContent(@Nullable byte[] content)

  リクエスト本文のコンテンツをバイト配列として設定します。

  指定されたバイト配列が XML や JSON などのテキストを表す場合、character encoding も通常設定する必要があります。

  関連事項:

  • setCharacterEncoding(String)
  • getContentAsByteArray()
  • getContentAsString()

• getContentAsByteArray

  @Nullable public byte[] getContentAsByteArray()

  リクエスト本文のコンテンツをバイト配列として取得します。

  戻り値:

  バイト配列としてのコンテンツ (潜在的に null)

  導入:

  5.0

  関連事項:

  • setContent(byte[])
  • getContentAsString()

• getContentAsString

  @Nullable public StringSE getContentAsString() throws IllegalStateExceptionSE, UnsupportedEncodingExceptionSE

  構成された文字エンコードを使用して、String としてリクエスト本文のコンテンツを取得します。

  戻り値:

  String としてのコンテンツ、潜在的に null

  例外:

  IllegalStateExceptionSE - 文字エンコーディングが設定されていない場合

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

  導入:

  5.0

  関連事項:

  • setContent(byte[])
  • setCharacterEncoding(String)
  • getContentAsByteArray()

• getContentLength

  public int getContentLength()

  次で指定:

  インターフェース ServletRequestEE の getContentLengthEE 

• getContentLengthLong

  public long getContentLengthLong()

  次で指定:

  インターフェース ServletRequestEE の getContentLengthLongEE 

• setContentType

  public void setContentType(@Nullable StringSE contentType)

• getContentType

  @Nullable public StringSE getContentType()

  次で指定:

  インターフェース ServletRequestEE の getContentTypeEE 

• getInputStream

  public ServletInputStreamEE getInputStream()

  次で指定:

  インターフェース ServletRequestEE の getInputStreamEE 

• setParameter

  public void setParameter(StringSE name, StringSE value)

  指定された HTTP パラメーターに単一の値を設定します。

  指定されたパラメーター名にすでに 1 つ以上の値が登録されている場合、置き換えられます。

• setParameter

  public void setParameter(StringSE name, StringSE... values)

  指定された HTTP パラメーターの値の配列を設定します。

  指定されたパラメーター名にすでに 1 つ以上の値が登録されている場合、置き換えられます。

• setParameters

  public void setParameters(MapSE<StringSE,?> params)

  指定されたパラメーター名の既存の値を置き換えて、指定されたすべてのパラメーターを設定します。既存の値を置き換えずに追加するには、addParameters(java.util.Map) を使用します。

• addParameter

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

  指定された HTTP パラメーターに単一の値を追加します。

  指定されたパラメーター名にすでに 1 つ以上の値が登録されている場合、指定された値はリストの最後に追加されます。

• addParameter

  public void addParameter(StringSE name, StringSE... values)

  指定された HTTP パラメーターの値の配列を追加します。

  指定されたパラメーター名にすでに 1 つ以上の値が登録されている場合、指定された値はリストの最後に追加されます。

• addParameters

  public void addParameters(MapSE<StringSE,?> params)

  既存の値を 置き換えずに、提供されたすべてのパラメーターを 追加します。既存の値を置き換えるには、setParameters(java.util.Map) を使用します。

• removeParameter

  public void removeParameter(StringSE name)

  指定された HTTP パラメーターの登録済みの値がある場合は削除します。

• removeAllParameters

  public void removeAllParameters()

  既存のパラメーターをすべて削除します。

• getParameter

  @Nullable public StringSE getParameter(StringSE name)

  次で指定:

  インターフェース ServletRequestEE の getParameterEE 

• getParameterNames

  public EnumerationSE<StringSE> getParameterNames()

  次で指定:

  インターフェース ServletRequestEE の getParameterNamesEE 

• getParameterValues

  @Nullable public StringSE[] getParameterValues(StringSE name)

  次で指定:

  インターフェース ServletRequestEE の getParameterValuesEE 

• getParameterMap

  public MapSE<StringSE,StringSE[]> getParameterMap()

  次で指定:

  インターフェース ServletRequestEE の getParameterMapEE 

• setProtocol

  public void setProtocol(StringSE protocol)

• getProtocol

  public StringSE getProtocol()

  次で指定:

  インターフェース ServletRequestEE の getProtocolEE 

• setScheme

  public void setScheme(StringSE scheme)

• getScheme

  public StringSE getScheme()

  次で指定:

  インターフェース ServletRequestEE の getSchemeEE 

• setServerName

  public void setServerName(StringSE serverName)

• getServerName

  public StringSE getServerName()

  次で指定:

  インターフェース ServletRequestEE の getServerNameEE 

• setServerPort

  public void setServerPort(int serverPort)

• getServerPort

  public int getServerPort()

  次で指定:

  インターフェース ServletRequestEE の getServerPortEE 

• getReader

  public BufferedReaderSE getReader() throws UnsupportedEncodingExceptionSE

  次で指定:

  インターフェース ServletRequestEE の getReaderEE 

  例外:

  UnsupportedEncodingExceptionSE

• setRemoteAddr

  public void setRemoteAddr(StringSE remoteAddr)

• getRemoteAddr

  public StringSE getRemoteAddr()

  次で指定:

  インターフェース ServletRequestEE の getRemoteAddrEE 

• setRemoteHost

  public void setRemoteHost(StringSE remoteHost)

• getRemoteHost

  public StringSE getRemoteHost()

  次で指定:

  インターフェース ServletRequestEE の getRemoteHostEE 

• setAttribute

  public void setAttribute(StringSE name, @Nullable ObjectSE value)

  次で指定:

  インターフェース ServletRequestEE の setAttributeEE 

• removeAttribute

  public void removeAttribute(StringSE name)

  次で指定:

  インターフェース ServletRequestEE の removeAttributeEE 

• clearAttributes

  public void clearAttributes()

  このリクエストのすべての属性をクリアします。

• addPreferredLocale

  public void addPreferredLocale(LocaleSE locale)

  既存のロケールの前に、新しい優先ロケールを追加します。

  関連事項:

  • setPreferredLocales(java.util.List<java.util.Locale>)

• setPreferredLocales

  public void setPreferredLocales(ListSE<LocaleSE> locales)

  優先ロケールのリストを降順で設定し、既存のロケールを効果的に置き換えます。

  導入:

  3.2

  関連事項:

  • addPreferredLocale(java.util.Locale)

• getLocale

  public LocaleSE getLocale()

  このモックリクエストで設定された最初の優先ロケールを返SEします。

  明示的に構成されたロケールがない場合、このリクエストによってモックされたサーバーのデフォルトの優先 LocaleSE は Locale.ENGLISHSE です。

  サーブレット仕様とは対照的に、このモック実装では、Accept-Language ヘッダーを介して指定されたロケールは考慮されません。

  次で指定:

  インターフェース ServletRequestEE の getLocaleEE 

  関連事項:

  • ServletRequest.getLocale()EE
  • addPreferredLocale(Locale)
  • setPreferredLocales(List)

• getLocales

  public EnumerationSE<LocaleSE> getLocales()

  このモックリクエストで設定された優先ロケールのSE列挙SEを返します。

  明示的に構成されたロケールがない場合、このリクエストによってモックされたサーバーのデフォルトの優先 LocaleSE は Locale.ENGLISHSE です。

  サーブレット仕様とは対照的に、このモック実装では、Accept-Language ヘッダーを介して指定されたロケールは考慮されません。

  次で指定:

  インターフェース ServletRequestEE の getLocalesEE 

  関連事項:

  • ServletRequest.getLocales()EE
  • addPreferredLocale(Locale)
  • setPreferredLocales(List)

• setSecure

  public void setSecure(boolean secure)

  HTTPS などのセキュアチャネルを使用してモックリクエストが行われたかどうかを示すブール secure フラグを設定します。

  関連事項:

  • isSecure()
  • getScheme()
  • setScheme(String)

• isSecure

  public boolean isSecure()

  secure フラグが true に設定されている場合、または scheme が https の場合、true を返します。

  次で指定:

  インターフェース ServletRequestEE の isSecureEE 

  関連事項:

  • ServletRequest.isSecure()EE

• getRequestDispatcher

  public RequestDispatcherEE getRequestDispatcher(StringSE path)

  次で指定:

  インターフェース ServletRequestEE の getRequestDispatcherEE 

• setRemotePort

  public void setRemotePort(int remotePort)

• getRemotePort

  public int getRemotePort()

  次で指定:

  インターフェース ServletRequestEE の getRemotePortEE 

• setLocalName

  public void setLocalName(StringSE localName)

• getLocalName

  public StringSE getLocalName()

  次で指定:

  インターフェース ServletRequestEE の getLocalNameEE 

• setLocalAddr

  public void setLocalAddr(StringSE localAddr)

• getLocalAddr

  public StringSE getLocalAddr()

  次で指定:

  インターフェース ServletRequestEE の getLocalAddrEE 

• setLocalPort

  public void setLocalPort(int localPort)

• getLocalPort

  public int getLocalPort()

  次で指定:

  インターフェース ServletRequestEE の getLocalPortEE 

• startAsync

  public AsyncContextEE startAsync()

  次で指定:

  インターフェース ServletRequestEE の startAsyncEE 

• startAsync

  public AsyncContextEE startAsync(ServletRequestEE request, @Nullable ServletResponseEE response)

  次で指定:

  インターフェース ServletRequestEE の startAsyncEE 

• setAsyncStarted

  public void setAsyncStarted(boolean asyncStarted)

• isAsyncStarted

  public boolean isAsyncStarted()

  次で指定:

  インターフェース ServletRequestEE の isAsyncStartedEE 

• setAsyncSupported

  public void setAsyncSupported(boolean asyncSupported)

• isAsyncSupported

  public boolean isAsyncSupported()

  次で指定:

  インターフェース ServletRequestEE の isAsyncSupportedEE 

• setAsyncContext

  public void setAsyncContext(@Nullable MockAsyncContext asyncContext)

• getAsyncContext

  @Nullable public AsyncContextEE getAsyncContext()

  次で指定:

  インターフェース ServletRequestEE の getAsyncContextEE 

• setDispatcherType

  public void setDispatcherType(DispatcherTypeEE dispatcherType)

• getDispatcherType

  public DispatcherTypeEE getDispatcherType()

  次で指定:

  インターフェース ServletRequestEE の getDispatcherTypeEE 

• getRequestId

  public StringSE getRequestId()

  次で指定:

  インターフェース ServletRequestEE の getRequestIdEE 

• getProtocolRequestId

  public StringSE getProtocolRequestId()

  次で指定:

  インターフェース ServletRequestEE の getProtocolRequestIdEE 

• getServletConnection

  public ServletConnectionEE getServletConnection()

  次で指定:

  インターフェース ServletRequestEE の getServletConnectionEE 

• setAuthType

  public void setAuthType(@Nullable StringSE authType)

• getAuthType

  @Nullable public StringSE getAuthType()

  次で指定:

  インターフェース HttpServletRequestEE の getAuthTypeEE 

• setCookies

  public void setCookies(@Nullable CookieEE... cookies)

• getCookies

  @Nullable public CookieEE[] getCookies()

  次で指定:

  インターフェース HttpServletRequestEE の getCookiesEE 

• addHeader

  public void addHeader(StringSE name, ObjectSE value)

  指定された名前の HTTP ヘッダーエントリを追加します。

  このメソッドは任意の Object をパラメーターとして取ることができますが、以下の型を使用することをお勧めします。

  • toString() を使用して変換される文字列または任意のオブジェクト。getHeader(java.lang.String) を参照してください。
  • 日付ヘッダーの文字列、数値、日付。getDateHeader(java.lang.String) を参照してください。
  • 整数ヘッダーの文字列または数値。getIntHeader(java.lang.String) を参照してください。
  • String[] または Collection<String> （複数の値の場合）。getHeaders(java.lang.String) を参照してください。

  関連事項:

  • getHeaderNames()
  • getHeaders(java.lang.String)
  • getHeader(java.lang.String)
  • getDateHeader(java.lang.String)

• removeHeader

  public void removeHeader(StringSE name)

  指定された HTTP ヘッダーの登録済みエントリがある場合は削除します。

  導入:

  4.3.20

• getDateHeader

  public long getDateHeader(StringSE name)

  指定された name を持つ日付ヘッダーの長いタイムスタンプを返します。

  内部値表現が文字列である場合、このメソッドは、サポートされている日付形式を使用して日付として解析しようとします。

  • 「EEE、dd MMM yyyy HH:mm:ss zzz」
  • 「EEE、dd-MMM-yy HH:mm:ss zzz」
  • "EEE MMM dd HH:mm:ss yyyy"

  次で指定:

  インターフェース HttpServletRequestEE の getDateHeaderEE 

  パラメーター:

  name - ヘッダー名

  関連事項:

  • RFC 7231 のセクション 7.1.1.1

• getHeader

  @Nullable public StringSE getHeader(StringSE name)

  次で指定:

  インターフェース HttpServletRequestEE の getHeaderEE 

• getHeaders

  public EnumerationSE<StringSE> getHeaders(StringSE name)

  次で指定:

  インターフェース HttpServletRequestEE の getHeadersEE 

• getHeaderNames

  public EnumerationSE<StringSE> getHeaderNames()

  次で指定:

  インターフェース HttpServletRequestEE の getHeaderNamesEE 

• getIntHeader

  public int getIntHeader(StringSE name)

  次で指定:

  インターフェース HttpServletRequestEE の getIntHeaderEE 

• setMethod

  public void setMethod(@Nullable StringSE method)

• getMethod

  @Nullable public StringSE getMethod()

  次で指定:

  インターフェース HttpServletRequestEE の getMethodEE 

• setPathInfo

  public void setPathInfo(@Nullable StringSE pathInfo)

• getPathInfo

  @Nullable public StringSE getPathInfo()

  次で指定:

  インターフェース HttpServletRequestEE の getPathInfoEE 

• getPathTranslated

  @Nullable public StringSE getPathTranslated()

  次で指定:

  インターフェース HttpServletRequestEE の getPathTranslatedEE 

• setContextPath

  public void setContextPath(StringSE contextPath)

• getContextPath

  public StringSE getContextPath()

  次で指定:

  インターフェース HttpServletRequestEE の getContextPathEE 

• setQueryString

  public void setQueryString(@Nullable StringSE queryString)

• getQueryString

  @Nullable public StringSE getQueryString()

  次で指定:

  インターフェース HttpServletRequestEE の getQueryStringEE 

• setRemoteUser

  public void setRemoteUser(@Nullable StringSE remoteUser)

• getRemoteUser

  @Nullable public StringSE getRemoteUser()

  次で指定:

  インターフェース HttpServletRequestEE の getRemoteUserEE 

• addUserRole

  public void addUserRole(StringSE role)

• isUserInRole

  public boolean isUserInRole(StringSE role)

  次で指定:

  インターフェース HttpServletRequestEE の isUserInRoleEE 

• setUserPrincipal

  public void setUserPrincipal(@Nullable PrincipalSE userPrincipal)

• getUserPrincipal

  @Nullable public PrincipalSE getUserPrincipal()

  次で指定:

  インターフェース HttpServletRequestEE の getUserPrincipalEE 

• setRequestedSessionId

  public void setRequestedSessionId(@Nullable StringSE requestedSessionId)

• getRequestedSessionId

  @Nullable public StringSE getRequestedSessionId()

  次で指定:

  インターフェース HttpServletRequestEE の getRequestedSessionIdEE 

• setUriTemplate

  public void setUriTemplate(@Nullable StringSE uriTemplate)

  リクエストを準備するために使用された元の URI テンプレートを設定します (存在する場合)。

  パラメーター:

  uriTemplate - リクエストを設定するために使用された URI テンプレート（存在する場合）

  導入:

  6.2

• getUriTemplate

  @Nullable public StringSE getUriTemplate()

  リクエストの準備に使用された元の URI テンプレートがあれば、それを返します。

  導入:

  6.2

• setRequestURI

  public void setRequestURI(@Nullable StringSE requestURI)

• getRequestURI

  @Nullable public StringSE getRequestURI()

  次で指定:

  インターフェース HttpServletRequestEE の getRequestURIEE 

• getRequestURL

  public StringBufferSE getRequestURL()

  次で指定:

  インターフェース HttpServletRequestEE の getRequestURLEE 

• setServletPath

  public void setServletPath(StringSE servletPath)

• getServletPath

  public StringSE getServletPath()

  次で指定:

  インターフェース HttpServletRequestEE の getServletPathEE 

• setSession

  public void setSession(HttpSessionEE session)

• getSession

  @Nullable public HttpSessionEE getSession(boolean create)

  次で指定:

  インターフェース HttpServletRequestEE の getSessionEE 

• getSession

  @Nullable public HttpSessionEE getSession()

  次で指定:

  インターフェース HttpServletRequestEE の getSessionEE 

• changeSessionId

  public StringSE changeSessionId()

  この（Servlet 3.1+）メソッドの実装は、セッションがモックセッションの場合、MockHttpSession.changeSessionId() を呼び出します。それ以外の場合は、単に現在のセッション ID を返します。

  次で指定:

  インターフェース HttpServletRequestEE の changeSessionIdEE 

  導入:

  4.0.3

• setRequestedSessionIdValid

  public void setRequestedSessionIdValid(boolean requestedSessionIdValid)

• isRequestedSessionIdValid

  public boolean isRequestedSessionIdValid()

  次で指定:

  インターフェース HttpServletRequestEE の isRequestedSessionIdValidEE 

• setRequestedSessionIdFromCookie

  public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)

• isRequestedSessionIdFromCookie

  public boolean isRequestedSessionIdFromCookie()

  次で指定:

  インターフェース HttpServletRequestEE の isRequestedSessionIdFromCookieEE 

• setRequestedSessionIdFromURL

  public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)

• isRequestedSessionIdFromURL

  public boolean isRequestedSessionIdFromURL()

  次で指定:

  インターフェース HttpServletRequestEE の isRequestedSessionIdFromURLEE 

• authenticate

  public boolean authenticate(HttpServletResponseEE response) throws IOExceptionSE, ServletExceptionEE

  次で指定:

  インターフェース HttpServletRequestEE の authenticateEE 

  例外:

  IOExceptionSE

  ServletExceptionEE

• login

  public void login(StringSE username, StringSE password) throws ServletExceptionEE

  次で指定:

  インターフェース HttpServletRequestEE の loginEE 

  例外:

  ServletExceptionEE

• logout

  public void logout() throws ServletExceptionEE

  次で指定:

  インターフェース HttpServletRequestEE の logoutEE 

  例外:

  ServletExceptionEE

• addPart

  public void addPart(PartEE part)

• getPart

  @Nullable public PartEE getPart(StringSE name) throws IOExceptionSE, ServletExceptionEE

  次で指定:

  インターフェース HttpServletRequestEE の getPartEE 

  例外:

  IOExceptionSE

  ServletExceptionEE

• getParts

  public CollectionSE<PartEE> getParts() throws IOExceptionSE, ServletExceptionEE

  次で指定:

  インターフェース HttpServletRequestEE の getPartsEE 

  例外:

  IOExceptionSE

  ServletExceptionEE

• setHttpServletMapping

  public void setHttpServletMapping(@Nullable HttpServletMappingEE httpServletMapping)

• getHttpServletMapping

  public HttpServletMappingEE getHttpServletMapping()

  次で指定:

  インターフェース HttpServletRequestEE の getHttpServletMappingEE 

• upgrade

  public <T extends HttpUpgradeHandlerEE> T upgrade(ClassSE<T> handlerClass) throws IOExceptionSE, ServletExceptionEE

  次で指定:

  インターフェース HttpServletRequestEE の upgradeEE 

  例外:

  IOExceptionSE

  ServletExceptionEE