net.ymate.platform.webmvc.util

Class FileUploadHelper

java.lang.Object

net.ymate.platform.webmvc.util.FileUploadHelper

public final class FileUploadHelper
extends Object

文件上传处理助手类；注：文件上传页面Form表单必须采用POST方式提交并设置属性：enctype="multipart/form-data"，否则将无法处理

Author:

刘镇 (suninformation@163.com) on 2011-6-5 下午02:50:07

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileUploadHelper.IUploadFileItemProcessor 文件上传处理回调接口定义，用于将每个文件交给开发者自行处理
static class	FileUploadHelper.UploadFileWrapper 上传文件对象包装器
static class	FileUploadHelper.UploadFormWrapper 文件上传表单包装器；

Method Summary

Modifier and Type	Method and Description
static FileUploadHelper	bind(IWebMvc owner, HttpServletRequest request)
long	getFileSizeMax()
ProgressListener	getFileUploadListener()
long	getSizeMax()
int	getSizeThreshold()
File	getUploadTempDir()
FileUploadHelper.UploadFormWrapper	processUpload()
FileUploadHelper.UploadFormWrapper	processUpload(FileUploadHelper.IUploadFileItemProcessor processor)
FileUploadHelper	setFileSizeMax(long fileSize)
FileUploadHelper	setFileUploadListener(ProgressListener listener)
FileUploadHelper	setSizeMax(long size)
FileUploadHelper	setSizeThreshold(int threshold)
FileUploadHelper	setUploadTempDir(File uploadDir)

Methods inherited from class java.lang.Object

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

Method Detail

bind

public static FileUploadHelper bind(IWebMvc owner,
                                    HttpServletRequest request)

processUpload

public FileUploadHelper.UploadFormWrapper processUpload(FileUploadHelper.IUploadFileItemProcessor processor)
                                                 throws FileUploadException,
                                                        IOException

Parameters:

processor - 文件上传处理器

Returns:

处理表单提交，使用提供的文件上传处理器处理文件流

Throws:

FileUploadException - 文件上传时可能产生的异常

IOException - 文件读写可能产生的异常

processUpload

public FileUploadHelper.UploadFormWrapper processUpload()
                                                 throws FileUploadException,
                                                        IOException

Returns:

处理表单提交

Throws:

FileUploadException - 文件上传时可能产生的异常

IOException - 文件读写可能产生的异常

getFileUploadListener

public ProgressListener getFileUploadListener()

Returns:

监听器

setFileUploadListener

public FileUploadHelper setFileUploadListener(ProgressListener listener)

Parameters:

listener - 文件上传进度监听器

Returns:

设置监听器

getUploadTempDir

public File getUploadTempDir()

Returns:

上传文件临时目录（不支持自定义文件流处理）

setUploadTempDir

public FileUploadHelper setUploadTempDir(File uploadDir)

Parameters:

uploadDir - 临时目录

Returns:

上传文件临时目录（不支持自定义文件流处理），默认使用：System.getProperty("java.io.tmpdir")

getFileSizeMax

public long getFileSizeMax()

Returns:

上传文件最大值

setFileSizeMax

public FileUploadHelper setFileSizeMax(long fileSize)

Parameters:

fileSize - 文件大小

Returns:

设置上传文件最大值

getSizeThreshold

public int getSizeThreshold()

Returns:

内存缓冲区的大小, 默认值为10K, 如果文件大于10K, 将使用临时文件缓存上传文件

setSizeThreshold

public FileUploadHelper setSizeThreshold(int threshold)

Parameters:

threshold - 缓冲区大小

Returns:

内存缓冲区的大小, 默认值为10K, 如果文件大于10K, 将使用临时文件缓存上传文件

getSizeMax

public long getSizeMax()

Returns:

上传文件总量的最大值

setSizeMax

public FileUploadHelper setSizeMax(long size)

Parameters:

size - 文件总量大小

Returns:

设置上传文件总量的最大值