org.apache.struts.upload
クラス CommonsMultipartRequestHandler

java.lang.Object
  org.apache.struts.upload.CommonsMultipartRequestHandler

すべての実装インタフェース:

MultipartRequestHandler

public class CommonsMultipartRequestHandler

extends java.lang.Object

implements MultipartRequestHandler

This class implements the MultipartRequestHandler interface by providing a wrapper around the Jakarta Commons FileUpload library.

導入されたバージョン:

Struts 1.1

バージョン:

$Revision: 1.1 $ $Date: 2004/10/20 03:26:41 $

入れ子クラスの概要

(パッケージプライベート) static class

CommonsMultipartRequestHandler.CommonsFormFile This class implements the Struts FormFile interface by wrapping the Commons FileUpload FileItem interface.

フィールドの概要

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.
private java.util.Hashtable	elementsAll The combined text and file request parameters.
private java.util.Hashtable	elementsFile The file request parameters.
private java.util.Hashtable	elementsText The text request parameters.
protected static org.apache.commons.logging.Log	log Commons Logging instance.
private ActionMapping	mapping The action mapping with which this handler is associated.
private ActionServlet	servlet The servlet with which this handler is associated.

インタフェース org.apache.struts.upload.MultipartRequestHandler から継承したフィールド

ATTRIBUTE_MAX_LENGTH_EXCEEDED

コンストラクタの概要

CommonsMultipartRequestHandler()

メソッドの概要

protected void	addFileParameter(org.apache.commons.fileupload.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(javax.servlet.http.HttpServletRequest request, org.apache.commons.fileupload.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(java.lang.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.
java.util.Hashtable	getAllElements() Returns a hash table containing both text and file request parameters.
java.util.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 java.lang.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.
java.util.Hashtable	getTextElements() Returns a hash table containing the text (that is, non-file) request parameters.
void	handleRequest(javax.servlet.http.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.

クラス java.lang.Object から継承したメソッド

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

フィールドの詳細

DEFAULT_SIZE_MAX

public static final long DEFAULT_SIZE_MAX

The default value for the maximum allowable size, in bytes, of an uploaded file. The value is equivalent to 250MB.

関連項目:

定数フィールド値

DEFAULT_SIZE_THRESHOLD

public static final 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. The value is equivalent to 250KB.

関連項目:

定数フィールド値

log

protected static org.apache.commons.logging.Log log

Commons Logging instance.

elementsAll

private java.util.Hashtable elementsAll

The combined text and file request parameters.

elementsFile

private java.util.Hashtable elementsFile

The file request parameters.

elementsText

private java.util.Hashtable elementsText

The text request parameters.

mapping

private ActionMapping mapping

The action mapping with which this handler is associated.

servlet

private ActionServlet servlet

The servlet with which this handler is associated.

コンストラクタの詳細

CommonsMultipartRequestHandler

public CommonsMultipartRequestHandler()

メソッドの詳細

getServlet

public ActionServlet getServlet()

Retrieves the servlet with which this handler is associated.

定義:

インタフェース MultipartRequestHandler 内の getServlet

戻り値:

The associated servlet.

setServlet

public void setServlet(ActionServlet servlet)

Sets the servlet with which this handler is associated.

定義:

インタフェース MultipartRequestHandler 内の setServlet

パラメータ:

servlet - The associated servlet.

getMapping

public ActionMapping getMapping()

Retrieves the action mapping with which this handler is associated.

定義:

インタフェース MultipartRequestHandler 内の getMapping

戻り値:

The associated action mapping.

setMapping

public void setMapping(ActionMapping mapping)

Sets the action mapping with which this handler is associated.

定義:

インタフェース MultipartRequestHandler 内の setMapping

パラメータ:

mapping - The associated action mapping.

handleRequest

public void handleRequest(javax.servlet.http.HttpServletRequest request)
                   throws javax.servlet.ServletException

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.

定義:

インタフェース MultipartRequestHandler 内の handleRequest

パラメータ:

request - The multipart request to be processed.

例外:

javax.servlet.ServletException - if an unrecoverable error occurs.

getTextElements

public java.util.Hashtable getTextElements()

Returns a hash table containing the text (that is, non-file) request parameters.

定義:

インタフェース MultipartRequestHandler 内の getTextElements

戻り値:

The text request parameters.

getFileElements

public java.util.Hashtable getFileElements()

Returns a hash table containing the file (that is, non-text) request parameters.

定義:

インタフェース MultipartRequestHandler 内の getFileElements

戻り値:

The file request parameters.

関連項目:

FormFile

getAllElements

public java.util.Hashtable getAllElements()

Returns a hash table containing both text and file request parameters.

定義:

インタフェース MultipartRequestHandler 内の getAllElements

戻り値:

The text and file request parameters.

rollback

public void rollback()

Cleans up when a problem occurs during request processing.

定義:

インタフェース MultipartRequestHandler 内の rollback

finish

public void finish()

Cleans up at the end of a request.

定義:

インタフェース MultipartRequestHandler 内の finish

getSizeMax

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.

パラメータ:

mc - The current module's configuration.

戻り値:

The maximum allowable file size, in bytes.

getSizeThreshold

protected long getSizeThreshold(ModuleConfig mc)

Returns the size threshold which determines whether an uploaded file will be written to disk or cached in memory.

パラメータ:

mc - The current module's configuration.

戻り値:

The size threshold, in bytes.

convertSizeToBytes

protected long convertSizeToBytes(java.lang.String sizeString,
                                  long defaultSize)

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.

パラメータ:

sizeString - The string representation of the size to be converted.

defaultSize - The value to be returned if the string is invalid.

戻り値:

The actual size in bytes.

getRepositoryPath

protected java.lang.String getRepositoryPath(ModuleConfig mc)

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.

1. 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.
2. The container-specified temp dir, obtained from the javax.servlet.context.tempdir servlet context attribute.
3. The temp dir specified by the java.io.tmpdir system property.
(/ol>

パラメータ:

mc - The module config instance for which the path should be determined.

戻り値:

The path to the directory to be used to store uploaded files.

addTextParameter

protected void addTextParameter(javax.servlet.http.HttpServletRequest request,
                                org.apache.commons.fileupload.FileItem item)

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.

パラメータ:

request - The request in which the parameter was specified.

item - The file item for the parameter to add.

addFileParameter

protected void addFileParameter(org.apache.commons.fileupload.FileItem item)

Adds a file parameter to the set of file parameters for this request and also to the list of all parameters.

パラメータ:

item - The file item for the parameter to add.