| java.lang.Object
 org.apache.struts.upload.CommonsMultipartRequestHandler
| CommonsMultipartRequestHandler | | public class CommonsMultipartRequestHandler implements MultipartRequestHandler(Code) | | This class implements the MultipartRequestHandler
interface by providing a wrapper around the Jakarta Commons FileUpload
library.
version:
$Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $
since:
Struts 1.1 |
| Field Summary | |
| final public static long | DEFAULT_SIZE_MAX
The default value for the maximum allowable size, in bytes, of an
uploaded file. | | final public 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. | | protected static Log | log
Commons Logging instance. |
| 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. | | public void | finish()
Cleans up at the end of a request. | | public Hashtable | getAllElements()
Returns a hash table containing both text and file request
parameters. | | public Hashtable | getFileElements()
Returns a hash table containing the file (that is, non-text)
request parameters. | | public 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. | | public 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.
The value is obtained from the current module's controller
configuration. | | protected long | getSizeThreshold(ModuleConfig mc)
Returns the size threshold which determines whether an uploaded
file will be written to disk or cached in memory. | | public Hashtable | getTextElements()
Returns a hash table containing the text (that is, non-file)
request parameters. | | public 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. | | public void | rollback()
Cleans up when a problem occurs during request processing. | | public void | setMapping(ActionMapping mapping)
Sets the action mapping with which this handler is associated. | | public void | setServlet(ActionServlet servlet)
Sets the servlet with which this handler is associated. |
| DEFAULT_SIZE_MAX | | final public static long DEFAULT_SIZE_MAX(Code) | | The default value for the maximum allowable size, in bytes, of an
uploaded file. The value is equivalent to 250MB.
|
| DEFAULT_SIZE_THRESHOLD | | final public static int DEFAULT_SIZE_THRESHOLD(Code) | | The default value for the threshold which determines whether an
uploaded file will be written to disk or cached in memory. The value is
equivalent to 250KB.
|
| log | | protected static Log log(Code) | | Commons Logging instance.
|
| addFileParameter | | protected void addFileParameter(FileItem item)(Code) | | Adds a file parameter to the set of file parameters for this
request and also to the list of all parameters.
Parameters:
item - The file item for the parameter to add. |
| addTextParameter | | protected void addTextParameter(HttpServletRequest request, FileItem item)(Code) | | Adds a regular text parameter to the set of text parameters for
this request and also to the list of all parameters. Handles the case
of multiple values for the same parameter by using an array for the
parameter value.
Parameters:
request - The request in which the parameter was specified.
Parameters:
item - The file item for the parameter to add. |
| convertSizeToBytes | | protected long convertSizeToBytes(String sizeString, long defaultSize)(Code) | | Converts a size value from a string representation to its numeric
value. The string must be of the form nnnm, where nnn is an arbitrary
decimal value, and m is a multiplier. The multiplier must be one of
'K', 'M' and 'G', representing kilobytes, megabytes and gigabytes
respectively. If the size value cannot be converted, for
example due to invalid syntax, the supplied default is returned
instead.
Parameters:
sizeString - The string representation of the size to beconverted.
Parameters:
defaultSize - The value to be returned if the string is invalid. The actual size in bytes. |
| finish | | public void finish()(Code) | | Cleans up at the end of a request.
|
| getAllElements | | public Hashtable getAllElements()(Code) | | Returns a hash table containing both text and file request
parameters.
The text and file request parameters. |
| getFileElements | | public Hashtable getFileElements()(Code) | | Returns a hash table containing the file (that is, non-text)
request parameters.
The file request parameters. |
| getMapping | | public ActionMapping getMapping()(Code) | | Retrieves the action mapping with which this handler is associated.
The associated action mapping. |
| getRepositoryPath | | protected String getRepositoryPath(ModuleConfig mc)(Code) | | Returns the path to the temporary directory to be used for uploaded
files which are written to disk. The directory used is determined from
the first of the following to be non-empty. - A temp dir
explicitly defined either using the
tempDir servlet init
param, or the tempDir attribute of the <controller>
element in the Struts config file. - The container-specified
temp dir, obtained from the
javax.servlet.context.tempdir
servlet context attribute. - The temp dir specified by the
java.io.tmpdir system property. (/ol>
Parameters:
mc - The module config instance for which the path should bedetermined. The path to the directory to be used to store uploaded files. |
| getServlet | | public ActionServlet getServlet()(Code) | | Retrieves the servlet with which this handler is associated.
The associated servlet. |
| getSizeMax | | protected long getSizeMax(ModuleConfig mc)(Code) | | Returns the maximum allowable size, in bytes, of an uploaded file.
The value is obtained from the current module's controller
configuration.
Parameters:
mc - The current module's configuration. The maximum allowable file size, in bytes. |
| getSizeThreshold | | protected long getSizeThreshold(ModuleConfig mc)(Code) | | Returns the size threshold which determines whether an uploaded
file will be written to disk or cached in memory.
Parameters:
mc - The current module's configuration. The size threshold, in bytes. |
| getTextElements | | public Hashtable getTextElements()(Code) | | Returns a hash table containing the text (that is, non-file)
request parameters.
The text request parameters. |
| handleRequest | | public void handleRequest(HttpServletRequest request) throws ServletException(Code) | | Parses the input stream and partitions the parsed items into a set
of form fields and a set of file items. In the process, the parsed
items are translated from Commons FileUpload FileItem
instances to Struts FormFile instances.
Parameters:
request - The multipart request to be processed.
throws:
ServletException - if an unrecoverable error occurs. |
| rollback | | public void rollback()(Code) | | Cleans up when a problem occurs during request processing.
|
| setMapping | | public void setMapping(ActionMapping mapping)(Code) | | Sets the action mapping with which this handler is associated.
Parameters:
mapping - The associated action mapping. |
| setServlet | | public void setServlet(ActionServlet servlet)(Code) | | Sets the servlet with which this handler is associated.
Parameters:
servlet - The associated servlet. |
|
|