org.frameworkset.web.multipart.MultipartResolver Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of bboss-mvc Show documentation

bboss is a j2ee framework include aop/ioc,mvc,persistent,taglib,rpc,event ,bean-xml serializable and so on.http://www.bbossgroups.com

There is a newer version: 6.2.5

Show newest version

package org.frameworkset.web.multipart;

import javax.servlet.http.HttpServletRequest;

import org.frameworkset.web.multipart.commons.CommonsMultipartResolver;

/**
 * 
 * Title: MultipartResolver.java 
 * Description: 
 * bboss workgroup
 * Copyright (c) 2008
 * @Date 2010-10-6
 * @author biaoping.yin
 * 
 * @version 1.0
 * @see CommonsMultipartResolver
 * @see ByteArrayMultipartFileEditor
 * @see StringMultipartFileEditor
 * @see DispatcherServlet
 */
public interface MultipartResolver {
	public static final String mimetype_application_octet_stream = "application/octet-stream"; 
	
	/**
	 * Determine if the given request contains multipart content.
	 * Will typically check for content type "multipart/form-data", but the actually
	 * accepted requests might depend on the capabilities of the resolver implementation.
	 * @param request the servlet request to be evaluated
	 * @return whether the request contains multipart content
	 */
	boolean isMultipart(HttpServletRequest request);

	/**
	 * Parse the given HTTP request into multipart files and parameters,
	 * and wrap the request inside a
	 * {@link MultipartHttpServletRequest} object
	 * that provides access to file descriptors and makes contained
	 * parameters accessible via the standard ServletRequest methods.
	 * @param request the servlet request to wrap (must be of a multipart content type)
	 * @return the wrapped servlet request
	 * @throws MultipartException if the servlet request is not multipart, or if
	 * implementation-specific problems are encountered (such as exceeding file size limits)
	 * @see MultipartHttpServletRequest#getFile
	 * @see MultipartHttpServletRequest#getFileNames
	 * @see MultipartHttpServletRequest#getFileMap
	 * @see javax.servlet.http.HttpServletRequest#getParameter
	 * @see javax.servlet.http.HttpServletRequest#getParameterNames
	 * @see javax.servlet.http.HttpServletRequest#getParameterMap
	 */
	MultipartHttpServletRequest resolveMultipart(HttpServletRequest request) throws MultipartException;

	/**
	 * Cleanup any resources used for the multipart handling,
	 * like a storage for the uploaded files.
	 * @param request the request to cleanup resources for
	 */
	void cleanupMultipart(MultipartHttpServletRequest request);

}