Package org.springframework.mock.web
Class MockMultipartHttpServletRequest
java.lang.Object
org.springframework.mock.web.MockHttpServletRequest
org.springframework.mock.web.MockMultipartHttpServletRequest
- All Implemented Interfaces:
HttpServletRequest
,ServletRequest
,org.springframework.web.multipart.MultipartHttpServletRequest
,org.springframework.web.multipart.MultipartRequest
public class MockMultipartHttpServletRequest
extends MockHttpServletRequest
implements org.springframework.web.multipart.MultipartHttpServletRequest
Mock implementation of the
MultipartHttpServletRequest
interface.
As of Spring 6.0, this set of mocks is designed on a Servlet 6.0 baseline.
Useful for testing application controllers that access multipart uploads.
MockMultipartFile
can be used to populate these mock requests with files.
- Since:
- 2.0
- Author:
- Juergen Hoeller, Eric Crampton, Arjen Poutsma
- See Also:
-
Field Summary
Fields inherited from class org.springframework.mock.web.MockHttpServletRequest
DEFAULT_PROTOCOL, DEFAULT_REMOTE_ADDR, DEFAULT_REMOTE_HOST, DEFAULT_SCHEME, DEFAULT_SERVER_ADDR, DEFAULT_SERVER_NAME, DEFAULT_SERVER_PORT
Fields inherited from interface jakarta.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
Constructor Summary
ConstructorDescriptionCreate a newMockMultipartHttpServletRequest
with a defaultMockServletContext
.MockMultipartHttpServletRequest
(ServletContext servletContext) Create a newMockMultipartHttpServletRequest
with the suppliedServletContext
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addFile
(org.springframework.web.multipart.MultipartFile file) Add a file to this request.org.springframework.web.multipart.MultipartFile
List<org.springframework.web.multipart.MultipartFile>
org.springframework.util.MultiValueMap<String,
org.springframework.web.multipart.MultipartFile> getMultipartContentType
(String paramOrFileName) org.springframework.http.HttpHeaders
getMultipartHeaders
(String paramOrFileName) org.springframework.http.HttpHeaders
org.springframework.http.HttpMethod
Methods inherited from class 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, getHttpServletMapping, getInputStream, getIntHeader, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getMethod, getParameter, getParameterMap, getParameterNames, getParameterValues, getPart, getParts, getPathInfo, getPathTranslated, getProtocol, getProtocolRequestId, getQueryString, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequestDispatcher, getRequestedSessionId, getRequestId, getRequestURI, getRequestURL, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, getServletPath, getSession, getSession, getUserPrincipal, invalidate, isActive, isAsyncStarted, isAsyncSupported, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isSecure, isUserInRole, login, logout, removeAllParameters, removeAttribute, removeHeader, removeParameter, setAsyncContext, setAsyncStarted, setAsyncSupported, setAttribute, setAuthType, setCharacterEncoding, setContent, setContentType, setContextPath, setCookies, setDispatcherType, setHttpServletMapping, 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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.servlet.http.HttpServletRequest
authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade
Methods inherited from interface jakarta.servlet.ServletRequest
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync
-
Constructor Details
-
MockMultipartHttpServletRequest
public MockMultipartHttpServletRequest()Create a newMockMultipartHttpServletRequest
with a defaultMockServletContext
. -
MockMultipartHttpServletRequest
Create a newMockMultipartHttpServletRequest
with the suppliedServletContext
.- Parameters:
servletContext
- the ServletContext that the request runs in (may benull
to use a defaultMockServletContext
)
-
-
Method Details
-
addFile
public void addFile(org.springframework.web.multipart.MultipartFile file) Add a file to this request. The parameter name from the multipart form is taken from theMultipartFile.getName()
.- Parameters:
file
- multipart file to be added
-
getFileNames
- Specified by:
getFileNames
in interfaceorg.springframework.web.multipart.MultipartRequest
-
getFile
- Specified by:
getFile
in interfaceorg.springframework.web.multipart.MultipartRequest
-
getFiles
- Specified by:
getFiles
in interfaceorg.springframework.web.multipart.MultipartRequest
-
getFileMap
- Specified by:
getFileMap
in interfaceorg.springframework.web.multipart.MultipartRequest
-
getMultiFileMap
public org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile> getMultiFileMap()- Specified by:
getMultiFileMap
in interfaceorg.springframework.web.multipart.MultipartRequest
-
getMultipartContentType
- Specified by:
getMultipartContentType
in interfaceorg.springframework.web.multipart.MultipartRequest
-
getRequestMethod
public org.springframework.http.HttpMethod getRequestMethod()- Specified by:
getRequestMethod
in interfaceorg.springframework.web.multipart.MultipartHttpServletRequest
-
getRequestHeaders
public org.springframework.http.HttpHeaders getRequestHeaders()- Specified by:
getRequestHeaders
in interfaceorg.springframework.web.multipart.MultipartHttpServletRequest
-
getMultipartHeaders
- Specified by:
getMultipartHeaders
in interfaceorg.springframework.web.multipart.MultipartHttpServletRequest
-