org.apache.struts.upload
public class CommonsMultipartRequestHandler extends Object implements MultipartRequestHandler
MultipartRequestHandler
interface
by providing a wrapper around the Jakarta Commons FileUpload library.
Since: Struts 1.1
Version: $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
Nested Class Summary | |
---|---|
static class | CommonsMultipartRequestHandler.CommonsFormFile
This class implements the Struts FormFile interface by
wrapping the Commons FileUpload FileItem interface. |
Field Summary | |
---|---|
static long | DEFAULT_SIZE_MAX
The default value for the maximum allowable size, in bytes, of an
uploaded file. |
static int | DEFAULT_SIZE_THRESHOLD
The default value for the threshold which determines whether an uploaded
file will be written to disk or cached in memory. |
Hashtable | elementsAll
The combined text and file request parameters. |
Hashtable | elementsFile
The file request parameters. |
Hashtable | elementsText
The text request parameters. |
protected static Log | log
Commons Logging instance. |
ActionMapping | mapping
The action mapping with which this handler is associated. |
ActionServlet | servlet
The servlet with which this handler is associated. |
Method Summary | |
---|---|
protected void | addFileParameter(FileItem item)
Adds a file parameter to the set of file parameters for this request
and also to the list of all parameters.
|
protected void | addTextParameter(HttpServletRequest request, FileItem item)
Adds a regular text parameter to the set of text parameters for this
request and also to the list of all parameters. |
protected long | convertSizeToBytes(String sizeString, long defaultSize)
Converts a size value from a string representation to its numeric value.
|
void | finish()
Cleans up at the end of a request. |
Hashtable | getAllElements()
Returns a hash table containing both text and file request parameters.
|
Hashtable | getFileElements()
Returns a hash table containing the file (that is, non-text) request
parameters.
|
ActionMapping | getMapping()
Retrieves the action mapping with which this handler is associated.
|
protected String | getRepositoryPath(ModuleConfig mc)
Returns the path to the temporary directory to be used for uploaded
files which are written to disk. |
ActionServlet | getServlet()
Retrieves the servlet with which this handler is associated.
|
protected long | getSizeMax(ModuleConfig mc)
Returns the maximum allowable size, in bytes, of an uploaded file. |
protected long | getSizeThreshold(ModuleConfig mc)
Returns the size threshold which determines whether an uploaded file
will be written to disk or cached in memory.
|
Hashtable | getTextElements()
Returns a hash table containing the text (that is, non-file) request
parameters.
|
void | handleRequest(HttpServletRequest request)
Parses the input stream and partitions the parsed items into a set of
form fields and a set of file items. |
void | rollback()
Cleans up when a problem occurs during request processing. |
void | setMapping(ActionMapping mapping)
Sets the action mapping with which this handler is associated.
|
void | setServlet(ActionServlet servlet)
Sets the servlet with which this handler is associated.
|
Parameters: item The file item for the parameter to add.
Parameters: request The request in which the parameter was specified. item The file item for the parameter to add.
Parameters: sizeString The string representation of the size to be converted. defaultSize The value to be returned if the string is invalid.
Returns: The actual size in bytes.
Returns: The text and file request parameters.
Returns: The file request parameters.
Returns: The associated action mapping.
tempDir
servlet init param, or the tempDir
attribute of the
<controller> element in the Struts config file.javax.servlet.context.tempdir
servlet context
attribute.java.io.tmpdir
system
property.Parameters: mc The module config instance for which the path should be determined.
Returns: The path to the directory to be used to store uploaded files.
Returns: The associated servlet.
Parameters: mc The current module's configuration.
Returns: The maximum allowable file size, in bytes.
Parameters: mc The current module's configuration.
Returns: The size threshold, in bytes.
Returns: The text request parameters.
FileItem
instances
to Struts FormFile
instances.
Parameters: request The multipart request to be processed.
Throws: ServletException if an unrecoverable error occurs.
Parameters: mapping The associated action mapping.
Parameters: servlet The associated servlet.