|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.web.multipart.commons.CommonsFileUploadSupport org.springframework.web.multipart.commons.CommonsMultipartResolver
public class CommonsMultipartResolver
Servlet-based MultipartResolver implementation for Jakarta Commons FileUpload 1.1 or higher.
Provides maxUploadSize, maxInMemorySize, and defaultEncoding settings as bean properties (inherited from CommonsFileUploadSupport). See respective 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).
NOTE: As of Spring 2.0, this multipart resolver requires Commons FileUpload 1.1 or higher. The implementation does not use any deprecated FileUpload 1.0 API anymore, to be compatible with future Commons FileUpload releases.
CommonsMultipartResolver(ServletContext)
,
CommonsMultipartFile
,
PortletMultipartResolver
,
ServletFileUpload
,
DiskFileItemFactory
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.springframework.web.multipart.commons.CommonsFileUploadSupport |
---|
CommonsFileUploadSupport.MultipartParsingResult |
Field Summary |
---|
Fields inherited from class org.springframework.web.multipart.commons.CommonsFileUploadSupport |
---|
logger |
Constructor Summary | |
---|---|
CommonsMultipartResolver()
Constructor for use as bean. |
|
CommonsMultipartResolver(ServletContext servletContext)
Constructor for standalone usage. |
Method Summary | |
---|---|
void |
cleanupMultipart(MultipartHttpServletRequest request)
Cleanup any resources used for the multipart handling, like a storage for the uploaded files. |
protected 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. |
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 |
setServletContext(ServletContext servletContext)
Set the ServletContext that this object runs in. |
Methods inherited from class org.springframework.web.multipart.commons.CommonsFileUploadSupport |
---|
cleanupFileItems, getDefaultEncoding, getFileItemFactory, getFileUpload, isUploadTempDirSpecified, newFileItemFactory, parseFileItems, prepareFileUpload, setDefaultEncoding, setMaxInMemorySize, setMaxUploadSize, setUploadTempDir |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CommonsMultipartResolver()
public CommonsMultipartResolver(ServletContext servletContext)
servletContext
- the ServletContext to useMethod Detail |
---|
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 use
public void setServletContext(ServletContext servletContext)
ServletContextAware
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 evaluated
public 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)MultipartHttpServletRequest.getFile(java.lang.String)
,
MultipartHttpServletRequest.getFileNames()
,
MultipartHttpServletRequest.getFileMap()
,
ServletRequest.getParameter(java.lang.String)
,
ServletRequest.getParameterNames()
,
ServletRequest.getParameterMap()
protected String determineEncoding(HttpServletRequest request)
The default implementation checks the request encoding, falling back to the default encoding specified for this resolver.
request
- current HTTP request
null
)ServletRequest.getCharacterEncoding()
,
CommonsFileUploadSupport.setDefaultEncoding(java.lang.String)
public void cleanupMultipart(MultipartHttpServletRequest request)
MultipartResolver
cleanupMultipart
in interface MultipartResolver
request
- the request to cleanup resources for
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |