|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
org.apache.struts2.dispatcher.StrutsRequestWrapper
org.apache.struts2.dispatcher.multipart.MultiPartRequestWrapper
public class MultiPartRequestWrapper
Parse a multipart request and provide a wrapper around the request. The parsing implementation used
depends on the struts.multipart.parser setting. It should be set to a class which
extends MultiPartRequest.
addError(String). An action handling a multipart form should first check hasErrors()
before doing any other processing.
An alternate implementation, PellMultiPartRequest, is provided as a plugin.
| Field Summary | |
|---|---|
protected static Logger |
LOG
|
| Fields inherited from interface javax.servlet.http.HttpServletRequest |
|---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
| Constructor Summary | |
|---|---|
MultiPartRequestWrapper(MultiPartRequest multiPartRequest,
javax.servlet.http.HttpServletRequest request,
String saveDir,
LocaleProvider provider)
|
|
MultiPartRequestWrapper(MultiPartRequest multiPartRequest,
javax.servlet.http.HttpServletRequest request,
String saveDir,
LocaleProvider provider,
boolean disableRequestAttributeValueStackLookup)
Process file downloads and log any errors. |
|
| Method Summary | |
|---|---|
protected void |
addError(String anErrorMessage)
Adds an error message when it isn't already added. |
protected String |
buildErrorMessage(Throwable e,
Object[] args)
|
void |
cleanUp()
|
String[] |
getContentTypes(String name)
Get an array of content encoding for the specified input field name or null if no content type was specified. |
Collection<String> |
getErrors()
Returns a collection of any errors generated when parsing the multipart request. |
String[] |
getFileNames(String fieldName)
Get a String array of the file names for uploaded files |
Enumeration<String> |
getFileParameterNames()
Get an enumeration of the parameter names for uploaded files |
File[] |
getFiles(String fieldName)
Get a File[] for the given input field name. |
String[] |
getFileSystemNames(String fieldName)
Get the filename(s) of the file(s) uploaded for the given input field name. |
String |
getParameter(String name)
|
Map |
getParameterMap()
|
Enumeration |
getParameterNames()
|
String[] |
getParameterValues(String name)
|
boolean |
hasErrors()
Returns true if any errors occured when parsing the HTTP multipart request, false otherwise. |
protected Enumeration |
mergeParams(Enumeration params1,
Enumeration params2)
Merges 2 enumeration of parameters as one. |
protected void |
setLocale(javax.servlet.http.HttpServletRequest request)
|
| Methods inherited from class org.apache.struts2.dispatcher.StrutsRequestWrapper |
|---|
getAttribute |
| 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 |
|---|
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 |
|---|
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 |
|---|
protected static final Logger LOG
| Constructor Detail |
|---|
public MultiPartRequestWrapper(MultiPartRequest multiPartRequest,
javax.servlet.http.HttpServletRequest request,
String saveDir,
LocaleProvider provider,
boolean disableRequestAttributeValueStackLookup)
multiPartRequest - Our MultiPartRequest objectrequest - Our HttpServletRequest objectsaveDir - Target directory for any files that we saveprovider -
public MultiPartRequestWrapper(MultiPartRequest multiPartRequest,
javax.servlet.http.HttpServletRequest request,
String saveDir,
LocaleProvider provider)
| Method Detail |
|---|
protected void setLocale(javax.servlet.http.HttpServletRequest request)
protected String buildErrorMessage(Throwable e,
Object[] args)
public Enumeration<String> getFileParameterNames()
public String[] getContentTypes(String name)
name - input field name
public File[] getFiles(String fieldName)
File[] for the given input field name.
fieldName - input field name
public String[] getFileNames(String fieldName)
fieldName - Field to check for file names.
public String[] getFileSystemNames(String fieldName)
fieldName - input field name
public String getParameter(String name)
getParameter in interface javax.servlet.ServletRequestgetParameter in class javax.servlet.ServletRequestWrapperServletRequest.getParameter(String)public Map getParameterMap()
getParameterMap in interface javax.servlet.ServletRequestgetParameterMap in class javax.servlet.ServletRequestWrapperServletRequest.getParameterMap()public Enumeration getParameterNames()
getParameterNames in interface javax.servlet.ServletRequestgetParameterNames in class javax.servlet.ServletRequestWrapperServletRequest.getParameterNames()public String[] getParameterValues(String name)
getParameterValues in interface javax.servlet.ServletRequestgetParameterValues in class javax.servlet.ServletRequestWrapperServletRequest.getParameterValues(String)public boolean hasErrors()
public Collection<String> getErrors()
protected void addError(String anErrorMessage)
anErrorMessage - the error message to report.
protected Enumeration mergeParams(Enumeration params1,
Enumeration params2)
params1 - the first enumeration.params2 - the second enumeration.
public void cleanUp()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||