public class CommonsMultipartResolver extends CommonsFileUploadSupport implements MultipartResolver, ServletContextAware
MultipartResolver
implementation
for Jakarta Commons FileUpload
1.2 or above.
Provides "maxUploadSize", "maxInMemorySize" and "defaultEncoding" settings as
bean properties (inherited from CommonsFileUploadSupport
). See corresponding
ServletFileUpload / DiskFileItemFactory properties ("sizeMax", "sizeThreshold",
"headerEncoding") for details in terms of defaults and accepted values.
Saves temporary files to the servlet container's temporary directory. Needs to be initialized either by an application context or via the constructor that takes a ServletContext (for standalone usage).
CommonsMultipartResolver(ServletContext)
,
setResolveLazily(boolean)
,
CommonsPortletMultipartResolver
,
org.apache.commons.fileupload.servlet.ServletFileUpload
,
org.apache.commons.fileupload.disk.DiskFileItemFactory
CommonsFileUploadSupport.MultipartParsingResult
Modifier and Type | Field and Description |
---|---|
private boolean |
resolveLazily |
logger
Constructor and Description |
---|
CommonsMultipartResolver()
Constructor for use as bean.
|
CommonsMultipartResolver(ServletContext servletContext)
Constructor for standalone usage.
|
Modifier and Type | Method and Description |
---|---|
void |
cleanupMultipart(MultipartHttpServletRequest request)
Cleanup any resources used for the multipart handling,
like a storage for the uploaded files.
|
protected java.lang.String |
determineEncoding(HttpServletRequest request)
Determine the encoding for the given request.
|
boolean |
isMultipart(HttpServletRequest request)
Determine if the given request contains multipart content.
|
protected FileUpload |
newFileUpload(FileItemFactory fileItemFactory)
Initialize the underlying
org.apache.commons.fileupload.servlet.ServletFileUpload
instance. |
protected CommonsFileUploadSupport.MultipartParsingResult |
parseRequest(HttpServletRequest request)
Parse the given servlet request, resolving its multipart elements.
|
MultipartHttpServletRequest |
resolveMultipart(HttpServletRequest request)
Parse the given HTTP request into multipart files and parameters,
and wrap the request inside a
MultipartHttpServletRequest object
that provides access to file descriptors and makes contained
parameters accessible via the standard ServletRequest methods. |
void |
setResolveLazily(boolean resolveLazily)
Set whether to resolve the multipart request lazily at the time of
file or parameter access.
|
void |
setServletContext(ServletContext servletContext)
Set the
ServletContext that this object runs in. |
cleanupFileItems, getDefaultEncoding, getFileItemFactory, getFileUpload, isUploadTempDirSpecified, newFileItemFactory, parseFileItems, prepareFileUpload, setDefaultEncoding, setMaxInMemorySize, setMaxUploadSize, setUploadTempDir
public CommonsMultipartResolver()
public CommonsMultipartResolver(ServletContext servletContext)
servletContext
- the ServletContext to usepublic void setResolveLazily(boolean resolveLazily)
Default is "false", resolving the multipart elements immediately, throwing
corresponding exceptions at the time of the resolveMultipart(HttpServletRequest)
call.
Switch this to "true" for lazy multipart parsing, throwing parse exceptions
once the application attempts to obtain multipart files or parameters.
protected FileUpload newFileUpload(FileItemFactory fileItemFactory)
org.apache.commons.fileupload.servlet.ServletFileUpload
instance. Can be overridden to use a custom subclass, e.g. for testing purposes.newFileUpload
in class CommonsFileUploadSupport
fileItemFactory
- the Commons FileItemFactory to usepublic void setServletContext(ServletContext servletContext)
ServletContextAware
ServletContext
that this object runs in.
Invoked after population of normal bean properties but before an init
callback like InitializingBean's afterPropertiesSet
or a
custom init-method. Invoked after ApplicationContextAware's
setApplicationContext
.
setServletContext
in interface ServletContextAware
servletContext
- ServletContext object to be used by this objectInitializingBean.afterPropertiesSet()
,
ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
public boolean isMultipart(HttpServletRequest request)
MultipartResolver
Will typically check for content type "multipart/form-data", but the actually accepted requests might depend on the capabilities of the resolver implementation.
isMultipart
in interface MultipartResolver
request
- the servlet request to be evaluatedpublic MultipartHttpServletRequest resolveMultipart(HttpServletRequest request) throws MultipartException
MultipartResolver
MultipartHttpServletRequest
object
that provides access to file descriptors and makes contained
parameters accessible via the standard ServletRequest methods.resolveMultipart
in interface MultipartResolver
request
- the servlet request to wrap (must be of a multipart content type)MultipartException
- if the servlet request is not multipart, or if
implementation-specific problems are encountered (such as exceeding file size limits)MultipartRequest.getFile(java.lang.String)
,
MultipartRequest.getFileNames()
,
MultipartRequest.getFileMap()
,
javax.servlet.http.HttpServletRequest#getParameter
,
javax.servlet.http.HttpServletRequest#getParameterNames
,
javax.servlet.http.HttpServletRequest#getParameterMap
protected CommonsFileUploadSupport.MultipartParsingResult parseRequest(HttpServletRequest request) throws MultipartException
request
- the request to parseMultipartException
- if multipart resolution failed.protected java.lang.String determineEncoding(HttpServletRequest request)
The default implementation checks the request encoding, falling back to the default encoding specified for this resolver.
request
- current HTTP requestnull
)javax.servlet.ServletRequest#getCharacterEncoding
,
CommonsFileUploadSupport.setDefaultEncoding(java.lang.String)
public void cleanupMultipart(MultipartHttpServletRequest request)
MultipartResolver
cleanupMultipart
in interface MultipartResolver
request
- the request to cleanup resources for