edu.cornell.mannlib.vitro.webapp.controller

Class MultipartRequestWrapper

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

edu.cornell.mannlib.vitro.webapp.controller.MultipartRequestWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class MultipartRequestWrapper
extends javax.servlet.http.HttpServletRequestWrapper

Wraps a multipart HTTP request, and pre-parses it for file uploads, without losing the request parameters. Parsing through the request with an Apache ServletFileUpload builds a list of FileItems that includes the parameters and the file parts. After that, however, the parameters are no longer accessible from the request. This wrapper will see that they don't get lost. The List of FileItems includes both "formField" items and "file" items. As with the usual parameters on a request, we can have more than one value with the same name. So this creates a map of <String, List<String>> to hold the parameters, and a map of <String, List<FileItem>> to hold the files. The parameters will be available to the wrapper through the normal methods. The files will be available as an attribute that holds the map. Also, a separate attribute will hold a Boolean to indicate that this was indeed a multipart request. Conveninence methods in VitroRequest will make these easy to handle, without actually touching the attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MultipartRequestWrapper.ParsingStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_FILE_ITEM_MAP
static String	ATTRIBUTE_FILE_SIZE_EXCEPTION
static String	ATTRIBUTE_IS_MULTIPART

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
MultipartRequestWrapper(javax.servlet.http.HttpServletRequest req, edu.cornell.mannlib.vitro.webapp.controller.MultipartRequestWrapper.ListsMap<String> parameters, edu.cornell.mannlib.vitro.webapp.controller.MultipartRequestWrapper.ListsMap<org.apache.commons.fileupload.FileItem> files)

Method Summary

Modifier and Type	Method and Description
String	getParameter(String name) Look in the map of parsed parameters.
Map<String,String[]>	getParameterMap() Make a copy of the map of parsed parameters;
Enumeration<?>	getParameterNames() Look in the map of parsed parameters.
String[]	getParameterValues(String name) Look in the map of parsed parameters.
static javax.servlet.http.HttpServletRequest	parse(javax.servlet.http.HttpServletRequest req, MultipartRequestWrapper.ParsingStrategy strategy) If this is a multipart request, wrap it.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

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 class javax.servlet.ServletRequestWrapper

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

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

Field Detail

ATTRIBUTE_IS_MULTIPART

public static final String ATTRIBUTE_IS_MULTIPART

ATTRIBUTE_FILE_ITEM_MAP

public static final String ATTRIBUTE_FILE_ITEM_MAP

ATTRIBUTE_FILE_SIZE_EXCEPTION

public static final String ATTRIBUTE_FILE_SIZE_EXCEPTION

Constructor Detail

MultipartRequestWrapper

public MultipartRequestWrapper(javax.servlet.http.HttpServletRequest req,
                               edu.cornell.mannlib.vitro.webapp.controller.MultipartRequestWrapper.ListsMap<String> parameters,
                               edu.cornell.mannlib.vitro.webapp.controller.MultipartRequestWrapper.ListsMap<org.apache.commons.fileupload.FileItem> files)

Method Detail

parse

public static javax.servlet.http.HttpServletRequest parse(javax.servlet.http.HttpServletRequest req,
                                                          MultipartRequestWrapper.ParsingStrategy strategy)
                                                   throws IOException

If this is a multipart request, wrap it. Otherwise, just return the request as it is.

Throws:

IOException

getParameter

public String getParameter(String name)

Look in the map of parsed parameters.

Specified by:

getParameter in interface javax.servlet.ServletRequest

Overrides:

getParameter in class javax.servlet.ServletRequestWrapper

getParameterNames

public Enumeration<?> getParameterNames()

Look in the map of parsed parameters. Make a protective copy.

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

Overrides:

getParameterNames in class javax.servlet.ServletRequestWrapper

getParameterValues

public String[] getParameterValues(String name)

Look in the map of parsed parameters.

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

Overrides:

getParameterValues in class javax.servlet.ServletRequestWrapper

getParameterMap

public Map<String,String[]> getParameterMap()

Make a copy of the map of parsed parameters;

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

Overrides:

getParameterMap in class javax.servlet.ServletRequestWrapper