/* * Copyright 2002-2010 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.springframework.web.portlet.multipart; import java.util.List; import javax.portlet.ActionRequest; import javax.portlet.PortletContext; import org.apache.commons.fileupload.FileItem; import org.apache.commons.fileupload.FileItemFactory; import org.apache.commons.fileupload.FileUpload; import org.apache.commons.fileupload.FileUploadBase; import org.apache.commons.fileupload.FileUploadException; import org.apache.commons.fileupload.portlet.PortletFileUpload; import org.springframework.util.Assert; import org.springframework.web.multipart.MaxUploadSizeExceededException; import org.springframework.web.multipart.MultipartException; import org.springframework.web.multipart.commons.CommonsFileUploadSupport; import org.springframework.web.portlet.context.PortletContextAware; import org.springframework.web.portlet.util.PortletUtils; /** * {@link PortletMultipartResolver} implementation for * Jakarta Commons FileUpload * 1.2 or above. * *
Provides "maxUploadSize", "maxInMemorySize" and "defaultEncoding" settings as * bean properties (inherited from {@link CommonsFileUploadSupport}). See corresponding * PortletFileUpload / DiskFileItemFactory properties ("sizeMax", "sizeThreshold", * "headerEncoding") for details in terms of defaults and accepted values. * *
Saves temporary files to the portlet container's temporary directory. * Needs to be initialized either by an application context or * via the constructor that takes a PortletContext (for standalone usage). * * @author Juergen Hoeller * @since 2.0 * @see #CommonsPortletMultipartResolver(javax.portlet.PortletContext) * @see #setResolveLazily * @see org.springframework.web.multipart.commons.CommonsMultipartResolver * @see org.apache.commons.fileupload.portlet.PortletFileUpload * @see org.apache.commons.fileupload.disk.DiskFileItemFactory */ public class CommonsPortletMultipartResolver extends CommonsFileUploadSupport implements PortletMultipartResolver, PortletContextAware { private boolean resolveLazily = false; /** * Constructor for use as bean. Determines the portlet container's * temporary directory via the PortletContext passed in as through the * PortletContextAware interface (typically by an ApplicationContext). * @see #setPortletContext * @see org.springframework.web.portlet.context.PortletContextAware */ public CommonsPortletMultipartResolver() { super(); } /** * Constructor for standalone usage. Determines the portlet container's * temporary directory via the given PortletContext. * @param portletContext the PortletContext to use */ public CommonsPortletMultipartResolver(PortletContext portletContext) { this(); setPortletContext(portletContext); } /** * Set whether to resolve the multipart request lazily at the time of * file or parameter access. *
Default is "false", resolving the multipart elements immediately, throwing
* corresponding exceptions at the time of the {@link #resolveMultipart} call.
* Switch this to "true" for lazy multipart parsing, throwing parse exceptions
* once the application attempts to obtain multipart files or parameters.
*/
public void setResolveLazily(boolean resolveLazily) {
this.resolveLazily = resolveLazily;
}
/**
* Initialize the underlying The default implementation checks the request encoding,
* falling back to the default encoding specified for this resolver.
* @param request current portlet request
* @return the encoding for the request (never org.apache.commons.fileupload.portlet.PortletFileUpload
* instance. Can be overridden to use a custom subclass, e.g. for testing purposes.
* @return the new PortletFileUpload instance
*/
@Override
protected FileUpload newFileUpload(FileItemFactory fileItemFactory) {
return new PortletFileUpload(fileItemFactory);
}
public void setPortletContext(PortletContext portletContext) {
if (!isUploadTempDirSpecified()) {
getFileItemFactory().setRepository(PortletUtils.getTempDir(portletContext));
}
}
public boolean isMultipart(ActionRequest request) {
return (request != null && PortletFileUpload.isMultipartContent(request));
}
public MultipartActionRequest resolveMultipart(final ActionRequest request) throws MultipartException {
Assert.notNull(request, "Request must not be null");
if (this.resolveLazily) {
return new DefaultMultipartActionRequest(request) {
@Override
protected void initializeMultipart() {
MultipartParsingResult parsingResult = parseRequest(request);
setMultipartFiles(parsingResult.getMultipartFiles());
setMultipartParameters(parsingResult.getMultipartParameters());
}
};
}
else {
MultipartParsingResult parsingResult = parseRequest(request);
return new DefaultMultipartActionRequest(
request, parsingResult.getMultipartFiles(), parsingResult.getMultipartParameters());
}
}
/**
* Parse the given portlet request, resolving its multipart elements.
* @param request the request to parse
* @return the parsing result
* @throws MultipartException if multipart resolution failed.
*/
@SuppressWarnings("unchecked")
protected MultipartParsingResult parseRequest(ActionRequest request) throws MultipartException {
String encoding = determineEncoding(request);
FileUpload fileUpload = prepareFileUpload(encoding);
try {
Listnull
)
* @see javax.portlet.ActionRequest#getCharacterEncoding
* @see #setDefaultEncoding
*/
protected String determineEncoding(ActionRequest request) {
String encoding = request.getCharacterEncoding();
if (encoding == null) {
encoding = getDefaultEncoding();
}
return encoding;
}
public void cleanupMultipart(MultipartActionRequest request) {
if (request != null) {
try {
cleanupFileItems(request.getMultiFileMap());
}
catch (Throwable ex) {
logger.warn("Failed to perform multipart cleanup for portlet request", ex);
}
}
}
}