org.springframework.mock.web
Class MockMultipartHttpServletRequest

java.lang.Object
  org.springframework.mock.web.MockHttpServletRequest
      org.springframework.mock.web.MockMultipartHttpServletRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest, MultipartHttpServletRequest

public class MockMultipartHttpServletRequest
extends MockHttpServletRequest
implements MultipartHttpServletRequest

Mock implementation of the MultipartHttpServletRequest interface.

Useful for testing application controllers that access multipart uploads. The MockMultipartFile can be used to populate these mock requests with files.

Since:

2.0

Author:

Juergen Hoeller, Eric Crampton

See Also:

MockMultipartFile

Field Summary

Fields inherited from class org.springframework.mock.web.MockHttpServletRequest

DEFAULT_PROTOCOL, DEFAULT_REMOTE_ADDR, DEFAULT_REMOTE_HOST, DEFAULT_SERVER_ADDR, DEFAULT_SERVER_NAME, DEFAULT_SERVER_PORT

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

MockMultipartHttpServletRequest()

Method Summary

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	getFileMap() Return a Map of the multipart files contained in this request.
Iterator	getFileNames() Return an Iterator of String objects containing the parameter names of the multipart files contained in this request.

Methods inherited from class org.springframework.mock.web.MockHttpServletRequest

addHeader, addParameter, addParameter, addPreferredLocale, addRole, addUserRole, checkActive, clearAttributes, close, getAttribute, getAttributeNames, getAuthType, getCharacterEncoding, getContentLength, getContentType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getInputStream, getIntHeader, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getMethod, getParameter, getParameterMap, getParameterNames, getParameterValues, getPathInfo, getPathTranslated, getProtocol, getQueryString, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequestDispatcher, getRequestedSessionId, getRequestURI, getRequestURL, getScheme, getServerName, getServerPort, getServletPath, getSession, getSession, getUserPrincipal, invalidate, isActive, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isSecure, isUserInRole, removeAttribute, removeParameter, setAttribute, setAuthType, setCharacterEncoding, setContent, setContentType, setContextPath, setCookies, setLocalAddr, setLocalName, setLocalPort, setMethod, setParameter, setParameter, setPathInfo, setProtocol, setQueryString, setRemoteAddr, setRemoteHost, setRemotePort, setRemoteUser, setRequestedSessionIdFromCookie, setRequestedSessionIdFromURL, setRequestedSessionIdValid, setRequestURI, setScheme, setSecure, setServerName, setServerPort, setServletPath, setSession, setUserPrincipal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.http.HttpServletRequest

getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole

Methods inherited from interface javax.servlet.ServletRequest

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

Constructor Detail

MockMultipartHttpServletRequest

public MockMultipartHttpServletRequest()

Method Detail

addFile

public void addFile(MultipartFile file)

Add a file to this request. The parameter name from the multipart form is taken from the MultipartFile.getName().

Parameters:

file - multipart file to be added

getFileNames

public Iterator getFileNames()

Description copied from interface: MultipartHttpServletRequest

Return an Iterator 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.

Specified by:

getFileNames in interface MultipartHttpServletRequest

Returns:

the names of the files

getFile

public MultipartFile getFile(String name)

Description copied from interface: MultipartHttpServletRequest

Return the contents plus description of an uploaded file in this request, or null if it does not exist.

Specified by:

getFile in interface MultipartHttpServletRequest

Parameters:

name - a String specifying the parameter name of the multipart file

Returns:

the uploaded content in the form of a MultipartFile object

getFileMap

public Map getFileMap()

Description copied from interface: MultipartHttpServletRequest

Return a Map of the multipart files contained in this request.

Specified by:

getFileMap in interface MultipartHttpServletRequest

Returns:

a map containing the parameter names as keys, and the MultipartFile objects as values

See Also:

MultipartFile