public class MockMultipartHttpServletRequest extends MockHttpServletRequest implements MultipartHttpServletRequest
MultipartHttpServletRequest interface.
As of Spring 5.0, this set of mocks is designed on a Servlet 4.0 baseline.
Useful for testing application controllers that access multipart uploads.
MockMultipartFile can be used to populate these mock requests with files.
MockMultipartFileDEFAULT_PROTOCOL, DEFAULT_REMOTE_ADDR, DEFAULT_REMOTE_HOST, DEFAULT_SCHEME, DEFAULT_SERVER_ADDR, DEFAULT_SERVER_NAME, DEFAULT_SERVER_PORTBASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH| Constructor and Description |
|---|
MockMultipartHttpServletRequest()
Create a new
MockMultipartHttpServletRequest with a default
MockServletContext. |
MockMultipartHttpServletRequest(ServletContext servletContext)
Create a new
MockMultipartHttpServletRequest with the supplied ServletContext. |
| Modifier and Type | Method and Description |
|---|---|
void |
addFile(MultipartFile file)
Add a file to this request.
|
MultipartFile |
getFile(String name)
Return the contents plus description of an uploaded file in this request,
or
null if it does not exist. |
Map<String,MultipartFile> |
getFileMap()
Return a
Map of the multipart files contained in this request. |
Iterator<String> |
getFileNames()
Return an
Iterator of String objects containing the
parameter names of the multipart files contained in this request. |
List<MultipartFile> |
getFiles(String name)
Return the contents plus description of uploaded files in this request,
or an empty list if it does not exist.
|
MultiValueMap<String,MultipartFile> |
getMultiFileMap()
Return a
MultiValueMap of the multipart files contained in this request. |
String |
getMultipartContentType(String paramOrFileName)
Determine the content type of the specified request part.
|
HttpHeaders |
getMultipartHeaders(String paramOrFileName)
Return the headers for the specified part of the multipart request.
|
HttpHeaders |
getRequestHeaders()
Return this request's headers as a convenient HttpHeaders instance.
|
HttpMethod |
getRequestMethod()
Return this request's method as a convenient HttpMethod instance.
|
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, upgradeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitauthenticate, 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, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgradegetAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsyncpublic MockMultipartHttpServletRequest()
MockMultipartHttpServletRequest with a default
MockServletContext.public MockMultipartHttpServletRequest(@Nullable ServletContext servletContext)
MockMultipartHttpServletRequest with the supplied ServletContext.servletContext - the ServletContext that the request runs in
(may be null to use a default MockServletContext)public void addFile(MultipartFile file)
MultipartFile.getName().file - multipart file to be addedpublic Iterator<String> getFileNames()
MultipartRequestIterator of String objects containing the
parameter names of the multipart files contained in this request. These
are the field names of the form (like with normal parameters), not the
original file names.getFileNames in interface MultipartRequestpublic MultipartFile getFile(String name)
MultipartRequestnull if it does not exist.getFile in interface MultipartRequestname - a String specifying the parameter name of the multipart fileMultipartFile objectpublic List<MultipartFile> getFiles(String name)
MultipartRequestgetFiles in interface MultipartRequestname - a String specifying the parameter name of the multipart fileMultipartFile listpublic Map<String,MultipartFile> getFileMap()
MultipartRequestMap of the multipart files contained in this request.getFileMap in interface MultipartRequestMultipartFile objects as valuespublic MultiValueMap<String,MultipartFile> getMultiFileMap()
MultipartRequestMultiValueMap of the multipart files contained in this request.getMultiFileMap in interface MultipartRequestMultipartFile objects as valuespublic String getMultipartContentType(String paramOrFileName)
MultipartRequestgetMultipartContentType in interface MultipartRequestparamOrFileName - the name of the partnull if not definedpublic HttpMethod getRequestMethod()
MultipartHttpServletRequestgetRequestMethod in interface MultipartHttpServletRequestpublic HttpHeaders getRequestHeaders()
MultipartHttpServletRequestgetRequestHeaders in interface MultipartHttpServletRequestpublic HttpHeaders getMultipartHeaders(String paramOrFileName)
MultipartHttpServletRequestIf the underlying implementation supports access to part headers, then all headers are returned. Otherwise, e.g. for a file upload, the returned headers may expose a 'Content-Type' if available.
getMultipartHeaders in interface MultipartHttpServletRequest