All Known Implementing Classes:

DefaultUploadService
```
public interface UploadService
```
This service handles parsing multipart/form-data POST requests and turning them into form fields and uploaded files. This can be either performed automatically by the org.apache.fulcrum.parser.ParameterParser or manually by a user defined org.apache.turbine.modules.Action.

Version:

$Id$

Author:

Rafal Krzewski, Daniel Rall

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CONTENT_DISPOSITION`	HTTP header.
`static String`	`CONTENT_TYPE`	HTTP header.
`static String`	`FORM_DATA`	HTTP header base type modifier.
`static String`	`HEADER_ENCODING_DEFAULT`	The default value of 'headerEncoding' property (.).
`static String`	`HEADER_ENCODING_KEY`	The key in UploadService properties in TurbineResources.properties 'headerEncoding' property.
`static String`	`MIXED`	HTTP header base type modifier.
`static String`	`MULTIPART`	HTTP header base type.
`static String`	`MULTIPART_FORM_DATA`	HTTP header.
`static String`	`MULTIPART_MIXED`	HTTP header.
`static String`	`REPOSITORY_DEFAULT`	The default value of 'repository' property (.).
`static String`	`REPOSITORY_KEY`	The key in UploadService properties in TurbineResources.properties 'repository' property.
`static String`	`REPOSITORY_PARAMETER`	The request parameter name for overriding 'repository' property (path).
`static String`	`ROLE`	Avalon Identifier
`static int`	`SIZE_MAX_DEFAULT`	The default value of 'sizMax' property (1 megabyte = 1048576 bytes).
`static String`	`SIZE_MAX_KEY`	w The key in UploadService properties in service configuration 'sizeMax' property.
`static int`	`SIZE_THRESHOLD_DEFAULT`	The default value of 'sizeThreshold' property (10 kilobytes = 10240 bytes).
`static String`	`SIZE_THRESHOLD_KEY`	The key in UploadService properties in TurbineResources.properties 'sizeThreshold' property.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getHeaderEncoding()`	Retrieves the value of the `headerEncoding` property of `UploadService`.
`org.apache.commons.fileupload.FileItemIterator`	`getItemIterator(javax.portlet.ActionRequest req)`	Processes an RFC 1867 compliant `multipart/form-data` stream.
`org.apache.commons.fileupload.FileItemIterator`	`getItemIterator(HttpServletRequest req)`	Processes an RFC 1867 compliant `multipart/form-data` stream.
`String`	`getRepository()`	Retrieves the value of the `repository` property of `UploadService`.
`long`	`getSizeMax()`	Retrieves the value of `size.max` property of the `UploadService`.
`long`	`getSizeThreshold()`	Retrieves the value of `size.threshold` property of `UploadService`.
`boolean`	`isMultipart(javax.portlet.ActionRequest req)`	Utility method that determines whether the request contains multipart content.
`boolean`	`isMultipart(HttpServletRequest req)`	Utility method that determines whether the request contains multipart content.
`List<org.apache.commons.fileupload.FileItem>`	`parseRequest(javax.portlet.ActionRequest req)`	Parses a RFC 1867 compliant `multipart/form-data` stream.
`List<org.apache.commons.fileupload.FileItem>`	`parseRequest(javax.portlet.ActionRequest req, int sizeThreshold, int sizeMax, String path)`	Parses a RFC 1867 compliant `multipart/form-data` stream.
`List<org.apache.commons.fileupload.FileItem>`	`parseRequest(javax.portlet.ActionRequest req, String path)`	Parses a RFC 1867 compliant `multipart/form-data` stream.
`List<org.apache.commons.fileupload.FileItem>`	`parseRequest(HttpServletRequest req)`	Parses a RFC 1867 compliant `multipart/form-data` stream.
`List<org.apache.commons.fileupload.FileItem>`	`parseRequest(HttpServletRequest req, int sizeThreshold, int sizeMax, String path)`	Parses a RFC 1867 compliant `multipart/form-data` stream.
`List<org.apache.commons.fileupload.FileItem>`	`parseRequest(HttpServletRequest req, String path)`	Parses a RFC 1867 compliant `multipart/form-data` stream.

- Field Detail
  - ROLE
```
static final String ROLE
```
    Avalon Identifier
  - CONTENT_TYPE
```
static final String CONTENT_TYPE
```
    HTTP header.
    
    See Also:
    
    Constant Field Values
  - CONTENT_DISPOSITION
```
static final String CONTENT_DISPOSITION
```
    HTTP header.
    
    See Also:
    
    Constant Field Values
  - MULTIPART
```
static final String MULTIPART
```
    HTTP header base type.
    
    See Also:
    
    Constant Field Values
  - FORM_DATA
```
static final String FORM_DATA
```
    HTTP header base type modifier.
    
    See Also:
    
    Constant Field Values
  - MIXED
```
static final String MIXED
```
    HTTP header base type modifier.
    
    See Also:
    
    Constant Field Values
  - MULTIPART_FORM_DATA
```
static final String MULTIPART_FORM_DATA
```
    HTTP header.
    
    See Also:
    
    Constant Field Values
  - MULTIPART_MIXED
```
static final String MULTIPART_MIXED
```
    HTTP header.
    
    See Also:
    
    Constant Field Values
  - REPOSITORY_PARAMETER
```
static final String REPOSITORY_PARAMETER
```
    The request parameter name for overriding 'repository' property (path).
    
    See Also:
    
    Constant Field Values
  - REPOSITORY_KEY
```
static final String REPOSITORY_KEY
```
    The key in UploadService properties in TurbineResources.properties 'repository' property.
    
    See Also:
    
    Constant Field Values
  - REPOSITORY_DEFAULT
```
static final String REPOSITORY_DEFAULT
```
    The default value of 'repository' property (.). This is the directory where uploaded files will get stored temporarily. Note that "." is whatever the servlet container chooses to be it's 'current directory'.
    
    See Also:
    
    Constant Field Values
  - SIZE_MAX_KEY
```
static final String SIZE_MAX_KEY
```
    w The key in UploadService properties in service configuration 'sizeMax' property.
    
    See Also:
    
    Constant Field Values
  - SIZE_MAX_DEFAULT
```
static final int SIZE_MAX_DEFAULT
```
    The default value of 'sizMax' property (1 megabyte = 1048576 bytes). This is the maximum size of POST request that will be parsed by the uploader. If you need to set specific limits for your users, set this property to the largest limit value, and use an action + no auto upload to enforce limits.
    
    See Also:
    
    Constant Field Values
  - SIZE_THRESHOLD_KEY
```
static final String SIZE_THRESHOLD_KEY
```
    The key in UploadService properties in TurbineResources.properties 'sizeThreshold' property.
    
    See Also:
    
    Constant Field Values
  - SIZE_THRESHOLD_DEFAULT
```
static final int SIZE_THRESHOLD_DEFAULT
```
    The default value of 'sizeThreshold' property (10 kilobytes = 10240 bytes). This is the maximum size of a POST request that will have it's components stored temporarily in memory, instead of disk.
    
    See Also:
    
    Constant Field Values
  - HEADER_ENCODING_KEY
```
static final String HEADER_ENCODING_KEY
```
    The key in UploadService properties in TurbineResources.properties 'headerEncoding' property.
    
    See Also:
    
    Constant Field Values
  - HEADER_ENCODING_DEFAULT
```
static final String HEADER_ENCODING_DEFAULT
```
    The default value of 'headerEncoding' property (.). The value has been decided by copying from DiskFileItem class
    
    See Also:
    
    Constant Field Values
- Method Detail
  - parseRequest
```
List<org.apache.commons.fileupload.FileItem> parseRequest(HttpServletRequest req)
                                                   throws org.apache.avalon.framework.service.ServiceException
```
    Parses a RFC 1867 compliant multipart/form-data stream.
    
    Parameters:
    
    req - The servlet request to be parsed.
    
    Returns:
    
    list of file items
    
    Throws:
    
    org.apache.avalon.framework.service.ServiceException - Problems reading/parsing the request or storing the uploaded file(s).
  - parseRequest
```
List<org.apache.commons.fileupload.FileItem> parseRequest(HttpServletRequest req,
                                                          String path)
                                                   throws org.apache.avalon.framework.service.ServiceException
```
    Parses a RFC 1867 compliant multipart/form-data stream.
    
    Parameters:
    
    req - The servlet request to be parsed.
    
    path - The location where the files should be stored.
    
    Returns:
    
    List of FileItem parts
    
    Throws:
    
    org.apache.avalon.framework.service.ServiceException - Problems reading/parsing the request or storing the uploaded file(s).
  - parseRequest
```
List<org.apache.commons.fileupload.FileItem> parseRequest(HttpServletRequest req,
                                                          int sizeThreshold,
                                                          int sizeMax,
                                                          String path)
                                                   throws org.apache.avalon.framework.service.ServiceException
```
    Parses a RFC 1867 compliant multipart/form-data stream.
    
    Parameters:
    
    req - The servlet request to be parsed.
    
    sizeThreshold - the max size in bytes to be stored in memory
    
    sizeMax - the maximum allowed upload size in bytes
    
    path - The location where the files should be stored.
    
    Returns:
    
    List of FileItem parts
    
    Throws:
    
    org.apache.avalon.framework.service.ServiceException - Problems reading/parsing the request or storing the uploaded file(s).
  - getItemIterator
```
org.apache.commons.fileupload.FileItemIterator getItemIterator(HttpServletRequest req)
                                                        throws org.apache.avalon.framework.service.ServiceException
```
    Processes an RFC 1867 compliant multipart/form-data stream.
    
    Parameters:
    
    req - The servlet request to be parsed.
    
    Returns:
    
    An iterator to instances of FileItemStream parsed from the request, in the order that they were transmitted.
    
    Throws:
    
    org.apache.avalon.framework.service.ServiceException - if there are problems reading/parsing the request or storing files. This may also be a network error while communicating with the client or a problem while storing the uploaded content.
  - parseRequest
```
List<org.apache.commons.fileupload.FileItem> parseRequest(javax.portlet.ActionRequest req)
                                                   throws org.apache.avalon.framework.service.ServiceException
```
    Parses a RFC 1867 compliant multipart/form-data stream.
    
    Parameters:
    
    req - The portlet request to be parsed.
    
    Returns:
    
    List of FileItem parts
    
    Throws:
    
    org.apache.avalon.framework.service.ServiceException - Problems reading/parsing the request or storing the uploaded file(s).
  - parseRequest
```
List<org.apache.commons.fileupload.FileItem> parseRequest(javax.portlet.ActionRequest req,
                                                          String path)
                                                   throws org.apache.avalon.framework.service.ServiceException
```
    Parses a RFC 1867 compliant multipart/form-data stream.
    
    Parameters:
    
    req - The portlet request to be parsed.
    
    path - The location where the files should be stored.
    
    Returns:
    
    List of FileItem parts
    
    Throws:
    
    org.apache.avalon.framework.service.ServiceException - Problems reading/parsing the request or storing the uploaded file(s).
  - parseRequest
```
List<org.apache.commons.fileupload.FileItem> parseRequest(javax.portlet.ActionRequest req,
                                                          int sizeThreshold,
                                                          int sizeMax,
                                                          String path)
                                                   throws org.apache.avalon.framework.service.ServiceException
```
    Parses a RFC 1867 compliant multipart/form-data stream.
    
    Parameters:
    
    req - The portlet request to be parsed.
    
    sizeThreshold - the max size in bytes to be stored in memory
    
    sizeMax - the maximum allowed upload size in bytes
    
    path - The location where the files should be stored.
    
    Returns:
    
    The list of FileItem parts uploaded
    
    Throws:
    
    org.apache.avalon.framework.service.ServiceException - Problems reading/parsing the request or storing the uploaded file(s).
  - getItemIterator
```
org.apache.commons.fileupload.FileItemIterator getItemIterator(javax.portlet.ActionRequest req)
                                                        throws org.apache.avalon.framework.service.ServiceException
```
    Processes an RFC 1867 compliant multipart/form-data stream.
    
    Parameters:
    
    req - The portlet request to be parsed.
    
    Returns:
    
    An iterator to instances of FileItemStream parsed from the request, in the order that they were transmitted.
    
    Throws:
    
    org.apache.avalon.framework.service.ServiceException - if there are problems reading/parsing the request or storing files. This may also be a network error while communicating with the client or a problem while storing the uploaded content.
  - getSizeMax
```
long getSizeMax()
```
    Retrieves the value of size.max property of the UploadService.
    
    Returns:
    
    The maximum upload size.
  - getSizeThreshold
```
long getSizeThreshold()
```
    Retrieves the value of size.threshold property of UploadService.
    
    Returns:
    
    The threshold beyond which files are written directly to disk.
  - getRepository
```
String getRepository()
```
    Retrieves the value of the repository property of UploadService.
    
    Returns:
    
    The repository.
  - getHeaderEncoding
```
String getHeaderEncoding()
```
    Retrieves the value of the headerEncoding property of UploadService.
    
    Returns:
    
    Returns the headerEncoding.
  - isMultipart
```
boolean isMultipart(HttpServletRequest req)
```
    Utility method that determines whether the request contains multipart content.
    
    Parameters:
    
    req - The servlet request to be evaluated. Must be non-null.
    
    Returns:
    
    true if the request is multipart; false otherwise.
  - isMultipart
```
boolean isMultipart(javax.portlet.ActionRequest req)
```
    Utility method that determines whether the request contains multipart content.
    
    Parameters:
    
    req - The portlet request to be evaluated. Must be non-null.
    
    Returns:
    
    true if the request is multipart; false otherwise.

Interface UploadService

Field Summary

Method Summary

Field Detail

ROLE

CONTENT_TYPE

CONTENT_DISPOSITION

MULTIPART

FORM_DATA

MIXED

MULTIPART_FORM_DATA

MULTIPART_MIXED

REPOSITORY_PARAMETER

REPOSITORY_KEY

REPOSITORY_DEFAULT

SIZE_MAX_KEY

SIZE_MAX_DEFAULT

SIZE_THRESHOLD_KEY

SIZE_THRESHOLD_DEFAULT

HEADER_ENCODING_KEY

HEADER_ENCODING_DEFAULT

Method Detail

parseRequest

parseRequest

parseRequest

getItemIterator

parseRequest

parseRequest

parseRequest

getItemIterator

getSizeMax

getSizeThreshold

getRepository

getHeaderEncoding

isMultipart

isMultipart