MockMultipartHttpServletRequest (Spring Framework API)

java.lang.ObjectSE
- org.springframework.mock.web.MockHttpServletRequest
- - org.springframework.mock.web.MockMultipartHttpServletRequest

実装されたすべてのインターフェース:
HttpServletRequestEE, ServletRequestEE, MultipartHttpServletRequest, MultipartRequest
```
public class MockMultipartHttpServletRequest
extends MockHttpServletRequest
implements MultipartHttpServletRequest
```
MultipartHttpServletRequest インターフェースのモック実装。
Spring 5.0 以降、このモックのセットは Servlet 4.0 ベースラインに基づいて設計されています。
マルチパートアップロードにアクセスするアプリケーションコントローラーのテストに役立ちます。MockMultipartFile を使用して、これらのモックリクエストにファイルを取り込むことができます。
導入:
2.0
作成者:
Juergen Hoeller, Eric Crampton, Arjen Poutsma
関連事項:
MockMultipartFile

フィールドサマリー
- クラス org.springframework.mock.web.MockHttpServletRequest から継承されたフィールド
  DEFAULT_PROTOCOL, DEFAULT_REMOTE_ADDR, DEFAULT_REMOTE_HOST, DEFAULT_SCHEME, DEFAULT_SERVER_ADDR, DEFAULT_SERVER_NAME, DEFAULT_SERVER_PORT
- インターフェース javax.servlet.http.HttpServletRequestEE から継承されたフィールド
  BASIC_AUTHEE, CLIENT_CERT_AUTHEE, DIGEST_AUTHEE, FORM_AUTHEE

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

コンストラクター
コンストラクターと説明
`MockMultipartHttpServletRequest()` デフォルトの `MockServletContext` で新しい `MockMultipartHttpServletRequest` を作成します。
`MockMultipartHttpServletRequest(ServletContextEE servletContext)` 提供された `ServletContext`EE で新しい `MockMultipartHttpServletRequest` を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addFile(MultipartFile file)` このリクエストにファイルを追加します。
`MultipartFile`	`getFile(StringSE name)` このリクエストでアップロードされたファイルの内容と説明を返すか、存在しない場合は `null` を返します。
`MapSE<StringSE, MultipartFile>`	`getFileMap()` このリクエストに含まれるマルチパートファイルの `Map`SE を返します。
`IteratorSE<StringSE>`	`getFileNames()` このリクエストに含まれるマルチパートファイルのパラメーター名を含む String オブジェクトの `Iterator`SE を返します。
`ListSE<MultipartFile>`	`getFiles(StringSE name)` このリクエストでアップロードされたファイルの内容と説明を返すか、存在しない場合は空のリストを返します。
`MultiValueMap<StringSE, MultipartFile>`	`getMultiFileMap()` このリクエストに含まれるマルチパートファイルの `MultiValueMap` を返します。
`StringSE`	`getMultipartContentType(StringSE paramOrFileName)` 指定されたリクエストパーツのコンテンツ型を決定します。
`HttpHeaders`	`getMultipartHeaders(StringSE paramOrFileName)` マルチパートリクエストの指定された部分のヘッダーを返します。
`HttpHeaders`	`getRequestHeaders()` このリクエストのヘッダーを便利な HttpHeaders インスタンスとして返します。
`HttpMethod`	`getRequestMethod()` このリクエストのメソッドを便利な HttpMethod インスタンスとして返します。

クラス org.springframework.mock.web.MockHttpServletRequest から継承されたメソッド
addHeader, addParameter, addParameter, addParameters, addPart, addPreferredLocale, addUserRole, authenticate, changeSessionId, checkActive, clearAttributes, close, getAsyncContext, getAttribute, getAttributeNames, getAuthType, getCharacterEncoding, getContentAsByteArray, getContentAsString, getContentLength, getContentLengthLong, getContentType, getContextPath, getCookies, getDateHeader, getDispatcherType, getHeader, getHeaderNames, getHeaders, getInputStream, getIntHeader, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getMethod, getParameter, getParameterMap, getParameterNames, getParameterValues, getPart, getParts, getPathInfo, getPathTranslated, getProtocol, getQueryString, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequestDispatcher, getRequestedSessionId, getRequestURI, getRequestURL, getScheme, getServerName, getServerPort, getServletContext, getServletPath, getSession, getSession, getUserPrincipal, invalidate, isActive, isAsyncStarted, isAsyncSupported, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isSecure, isUserInRole, login, logout, removeAllParameters, removeAttribute, removeHeader, removeParameter, setAsyncContext, setAsyncStarted, setAsyncSupported, setAttribute, setAuthType, setCharacterEncoding, setContent, setContentType, setContextPath, setCookies, setDispatcherType, setLocalAddr, setLocalName, setLocalPort, setMethod, setParameter, setParameter, setParameters, setPathInfo, setPreferredLocales, setProtocol, setQueryString, setRemoteAddr, setRemoteHost, setRemotePort, setRemoteUser, setRequestedSessionId, setRequestedSessionIdFromCookie, setRequestedSessionIdFromURL, setRequestedSessionIdValid, setRequestURI, setScheme, setSecure, setServerName, setServerPort, setServletPath, setSession, setUserPrincipal, startAsync, startAsync, upgrade

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

- コンストラクターの詳細
  - MockMultipartHttpServletRequest
```
public MockMultipartHttpServletRequest()
```
    デフォルトの MockServletContext で新しい MockMultipartHttpServletRequest を作成します。
    関連事項:
    MockMultipartHttpServletRequest(ServletContext)
  - MockMultipartHttpServletRequest
```
public MockMultipartHttpServletRequest(@Nullable
                                       ServletContextEE servletContext)
```
    提供された ServletContextEE で新しい MockMultipartHttpServletRequest を作成します。
    パラメーター:
    servletContext - リクエストが実行される ServletContext (デフォルトの MockServletContext を使用する null の場合があります)
- メソッドの詳細
  - addFile
```
public void addFile(MultipartFile file)
```
    このリクエストにファイルを追加します。マルチパート形式のパラメーター名は、MultipartFile.getName() から取得されます。
    パラメーター:
    file - 追加するマルチパートファイル
  - getFileNames
```
public IteratorSE<StringSE> getFileNames()
```
    インターフェースからコピーされた説明: MultipartRequest
    このリクエストに含まれるマルチパートファイルのパラメーター名を含む String オブジェクトの IteratorSE を返します。これらはフォームのフィールド名であり（通常のパラメーターと同様）、元のファイル名ではありません。
    次で指定:
    インターフェース MultipartRequest の getFileNames
    戻り値:
    ファイルの名前
  - getFile
```
public MultipartFile getFile(StringSE name)
```
    インターフェースからコピーされた説明: MultipartRequest
    このリクエストでアップロードされたファイルの内容と説明を返すか、存在しない場合は null を返します。
    次で指定:
    インターフェース MultipartRequest の getFile
    パラメーター:
    name - マルチパートファイルのパラメーター名を指定する文字列
    戻り値:
    MultipartFile オブジェクトの形式でアップロードされたコンテンツ
  - getFiles
```
public ListSE<MultipartFile> getFiles(StringSE name)
```
    インターフェースからコピーされた説明: MultipartRequest
    このリクエストでアップロードされたファイルの内容と説明を返すか、存在しない場合は空のリストを返します。
    次で指定:
    インターフェース MultipartRequest の getFiles
    パラメーター:
    name - マルチパートファイルのパラメーター名を指定する文字列
    戻り値:
    MultipartFile リストの形式でアップロードされたコンテンツ
  - getFileMap
```
public MapSE<StringSE,MultipartFile> getFileMap()
```
    インターフェースからコピーされた説明: MultipartRequest
    このリクエストに含まれるマルチパートファイルの MapSE を返します。
    次で指定:
    インターフェース MultipartRequest の getFileMap
    戻り値:
    パラメーター名をキーとして、MultipartFile オブジェクトを値として含むマップ
  - getMultiFileMap
```
public MultiValueMap<StringSE,MultipartFile> getMultiFileMap()
```
    インターフェースからコピーされた説明: MultipartRequest
    このリクエストに含まれるマルチパートファイルの MultiValueMap を返します。
    次で指定:
    インターフェース MultipartRequest の getMultiFileMap
    戻り値:
    キーとしてパラメーター名を含むマップ、および値として MultipartFile オブジェクトのリスト
  - getMultipartContentType
```
public StringSE getMultipartContentType(StringSE paramOrFileName)
```
    インターフェースからコピーされた説明: MultipartRequest
    指定されたリクエストパーツのコンテンツ型を決定します。
    次で指定:
    インターフェース MultipartRequest の getMultipartContentType
    パラメーター:
    paramOrFileName - パーツの名前
    戻り値:
    関連するコンテンツ型、または定義されていない場合は null
  - getRequestMethod
```
public HttpMethod getRequestMethod()
```
    インターフェースからコピーされた説明: MultipartHttpServletRequest
    このリクエストのメソッドを便利な HttpMethod インスタンスとして返します。
    次で指定:
    インターフェース MultipartHttpServletRequest の getRequestMethod
  - getRequestHeaders
```
public HttpHeaders getRequestHeaders()
```
    インターフェースからコピーされた説明: MultipartHttpServletRequest
    このリクエストのヘッダーを便利な HttpHeaders インスタンスとして返します。
    次で指定:
    インターフェース MultipartHttpServletRequest の getRequestHeaders
  - getMultipartHeaders
```
public HttpHeaders getMultipartHeaders(StringSE paramOrFileName)
```
    インターフェースからコピーされた説明: MultipartHttpServletRequest
    マルチパートリクエストの指定された部分のヘッダーを返します。
    基盤となる実装がパーツヘッダーへのアクセスをサポートしている場合、すべてのヘッダーが返されます。それ以外の場合、たとえばファイルのアップロードの場合、返されるヘッダーは、可能な場合は "Content-Type" を公開する場合があります。
    次で指定:
    インターフェース MultipartHttpServletRequest の getMultipartHeaders

クラス MockMultipartHttpServletRequest

フィールドサマリー

クラス org.springframework.mock.web.MockHttpServletRequest から継承されたフィールド

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

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

メソッドのサマリー

クラス org.springframework.mock.web.MockHttpServletRequest から継承されたメソッド

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

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

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

コンストラクターの詳細

MockMultipartHttpServletRequest

MockMultipartHttpServletRequest

メソッドの詳細

addFile

getFileNames

getFile

getFiles

getFileMap

getMultiFileMap

getMultipartContentType

getRequestMethod

getRequestHeaders

getMultipartHeaders