net.sourceforge.stripes.controller.multipart
Interface MultipartWrapper

All Known Implementing Classes:

CommonsMultipartWrapper, CosMultipartWrapper

public interface MultipartWrapper

Interface which must be implemented by classes which provide the ability to parse the POST content when it is of type multipart/form-data. Provides a single, pluggable wrapper interface around third party libraries which provide this capability.

Since:

Stripes 1.4

Author:

Tim Fennell

Method Summary

void	build(HttpServletRequest request, File tempDir, long maxPostSize) Pseudo-constructor that allows the class to perform any initialization necessary.
Enumeration<String>	getFileParameterNames() Fetches the names of all file parameters in the request.
FileBean	getFileParameterValue(String name) Responsible for constructing a FileBean object for the named file parameter.
Enumeration<String>	getParameterNames() Fetches the names of all non-file parameters in the request.
String[]	getParameterValues(String name) Fetches all values of a specific parameter in the request.

Method Detail

build

void build(HttpServletRequest request,
           File tempDir,
           long maxPostSize)
           throws IOException,
                  FileUploadLimitExceededException

Pseudo-constructor that allows the class to perform any initialization necessary.

Parameters:

request - an HttpServletRequest that has a content-type of multipart.

tempDir - a File representing the temporary directory that can be used to store file parts as they are uploaded if this is desirable

maxPostSize - the size in bytes beyond which the request should not be read, and a FileUploadLimitExceeded exception should be thrown

Throws:

IOException - if a problem occurs processing the request of storing temporary files

FileUploadLimitExceededException - if the POST content is longer than the maxPostSize supplied.

getParameterNames

Enumeration<String> getParameterNames()

Fetches the names of all non-file parameters in the request. Directly analogous to the method of the same name in HttpServletRequest when the request is non-multipart.

Returns:

an Enumeration of all non-file parameter names in the request

getParameterValues

String[] getParameterValues(String name)

Fetches all values of a specific parameter in the request. To simulate the HTTP request style, the array should be null for non-present parameters, and values in the array should never be null - the empty String should be used when there is value.

Parameters:

name - the name of the request parameter

Returns:

an array of non-null parameters or null

getFileParameterNames

Enumeration<String> getFileParameterNames()

Fetches the names of all file parameters in the request. Note that these are not the file names, but the names given to the form fields in which the files are specified.

Returns:

the names of all file parameters in the request.

getFileParameterValue

FileBean getFileParameterValue(String name)

Responsible for constructing a FileBean object for the named file parameter. If there is no file parameter with the specified name this method should return null.

Parameters:

name - the name of the file parameter

Returns:

a FileBean object wrapping the uploaded file