|
||||||||||
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
Parses a multipart request and provides 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
.
Struts ships with three implementations,
org.apache.struts2.dispatcher.multipart.PellMultiPartRequest
, and
org.apache.struts2.dispatcher.multipart.CosMultiPartRequest
and
JakartaMultiPartRequest
. The Jakarta implementation
is the default. The struts.multipart.parser property should be set to jakarta for the
Jakarta implementation, pell for the Pell implementation and cos for the Jason Hunter
implementation. The files are uploaded when the object is instantiated. If there are any errors they are logged using
addError(String)
. An action handling a multipart form should first check hasErrors()
before doing any other processing.
Field Summary | |
---|---|
protected static org.apache.commons.logging.Log |
log
|
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary | |
---|---|
MultiPartRequestWrapper(javax.servlet.http.HttpServletRequest request,
java.lang.String saveDir,
int maxSize)
Instantiates the appropriate MultiPartRequest parser implementation and processes the data. |
Method Summary | |
---|---|
protected void |
addError(java.lang.String anErrorMessage)
Adds an error message. |
java.lang.String[] |
getContentTypes(java.lang.String name)
Get an array of content encoding for the specified input field name or null if no content type was specified. |
java.util.Collection |
getErrors()
Returns a collection of any errors generated when parsing the multipart request. |
java.lang.String[] |
getFileNames(java.lang.String fieldName)
Get a String array of the file names for uploaded files |
java.util.Enumeration<java.lang.String> |
getFileParameterNames()
Get an enumeration of the parameter names for uploaded files |
java.io.File[] |
getFiles(java.lang.String fieldName)
Get a java.io.File[] for the given input field name. |
java.lang.String[] |
getFileSystemNames(java.lang.String fieldName)
Get the filename(s) of the file(s) uploaded for the given input field name. |
java.lang.String |
getParameter(java.lang.String name)
|
java.util.Map |
getParameterMap()
|
java.util.Enumeration |
getParameterNames()
|
java.lang.String[] |
getParameterValues(java.lang.String name)
|
boolean |
hasErrors()
Returns true if any errors occured when parsing the HTTP multipart request, false otherwise. |
protected java.util.Enumeration |
mergeParams(java.util.Enumeration params1,
java.util.Enumeration params2)
Merges 2 enumeration of parameters as one. |
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 org.apache.commons.logging.Log log
Constructor Detail |
---|
public MultiPartRequestWrapper(javax.servlet.http.HttpServletRequest request, java.lang.String saveDir, int maxSize)
request
- the servlet request objectsaveDir
- directory to save the file(s) tomaxSize
- maximum file size allowedMethod Detail |
---|
public java.util.Enumeration<java.lang.String> getFileParameterNames()
public java.lang.String[] getContentTypes(java.lang.String name)
name
- input field name
public java.io.File[] getFiles(java.lang.String fieldName)
java.io.File[]
for the given input field name.
fieldName
- input field name
public java.lang.String[] getFileNames(java.lang.String fieldName)
public java.lang.String[] getFileSystemNames(java.lang.String fieldName)
fieldName
- input field name
public java.lang.String getParameter(java.lang.String name)
getParameter
in interface javax.servlet.ServletRequest
getParameter
in class javax.servlet.ServletRequestWrapper
ServletRequest.getParameter(String)
public java.util.Map getParameterMap()
getParameterMap
in interface javax.servlet.ServletRequest
getParameterMap
in class javax.servlet.ServletRequestWrapper
ServletRequest.getParameterMap()
public java.util.Enumeration getParameterNames()
getParameterNames
in interface javax.servlet.ServletRequest
getParameterNames
in class javax.servlet.ServletRequestWrapper
ServletRequest.getParameterNames()
public java.lang.String[] getParameterValues(java.lang.String name)
getParameterValues
in interface javax.servlet.ServletRequest
getParameterValues
in class javax.servlet.ServletRequestWrapper
ServletRequest.getParameterValues(String)
public boolean hasErrors()
public java.util.Collection getErrors()
protected void addError(java.lang.String anErrorMessage)
anErrorMessage
- the error message to report.protected java.util.Enumeration mergeParams(java.util.Enumeration params1, java.util.Enumeration params2)
params1
- the first enumeration.params2
- the second enumeration.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |