FileUploader (jessma-core 3.5.1 API)

java.lang.Object
- org.jessma.util.http.FileUploader

public class FileUploader
extends Object

文件上传器

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`FileUploader.CommonFileNameGenerator` 通用文件名生成器实现 `FileUploader.FileNameGenerator` 接口，根据序列值和时间生成唯一文件名
`static class`	`FileUploader.FileInfo` 上传文件信息结构体
`static interface`	`FileUploader.FileNameGenerator` 文件名生成器接口每次保存一个上传文件前都需要调用该接口的 `FileUploader.FileNameGenerator.generate(org.apache.commons.fileupload.FileItem, java.lang.String)` 方法生成要保存的文件名
`static class`	`FileUploader.Result` 文件上传结果枚举值

字段概要

字段
限定符和类型	字段和说明
`static FileUploader.FileNameGenerator`	`DEFAULT_FILE_NAME_GENERATOR` 默认的文件名生成器
`static int`	`DEFAULT_SIZE_THRESHOLD` 默认的写文件阀值
`static long`	`NO_LIMIT_FILE_SIZE_MAX` 不限制文件上传单个文件大小的 File Size Max 常量
`static long`	`NO_LIMIT_SIZE_MAX` 不限制文件上传总大小的 Size Max 常量

构造器概要

构造器
构造器和说明
`FileUploader()`
`FileUploader(String savePath)` 构造函数
`FileUploader(String savePath, long sizeMax, long fileSizeMax)` 构造函数
`FileUploader(String savePath, String[] acceptTypes)` 构造函数
`FileUploader(String savePath, String[] acceptTypes, long sizeMax, long fileSizeMax)` 构造函数

方法概要

方法
限定符和类型	方法和说明
`boolean`	`addAcceptType(String acceptType)` 添加一个可接受的上传文件类型
`Set<String>`	`getAcceptTypes()` 获取可接受的上传文件类型集合
`Throwable`	`getCause()` 获取文件上传失败的原因（文件上传失败时使用）
`org.apache.commons.io.FileCleaningTracker`	`getFactoryCleaningTracker()` 获取临时文件跟踪器，参考：`DiskFileItemFactory.getFileCleaningTracker()`
`String`	`getFactoryRepository()` 获取上传文件过程中的临时文件存放位置，参考：`DiskFileItemFactory.getRepository()`
`int`	`getFactorySizeThreshold()` 获取写文件阀值，当上传的内容超过该值就把内容写到磁盘中，参考：`DiskFileItemFactory.getSizeThreshold()`
`Map<String,FileUploader.FileInfo[]>`	`getFileFields()` 获取所有文件表单域的映射
`FileUploader.FileNameGenerator`	`getFileNameGenerator()` 获取文件名生成器，参考：`FileUploader.FileNameGenerator`
`long`	`getFileSizeMax()` 获取文件上传的单个文件大小限制
`Map<String,String[]>`	`getParamFields()` 获取所有非文件表单域的映射
`String`	`getSavePath()` 获取上传文件的保存路径（不包含文件名）
`String`	`getServletHeaderencoding()` 获取上传组件解析上传内容的编码格式，参考：`FileUploadBase.getHeaderEncoding()`
`org.apache.commons.fileupload.ProgressListener`	`getServletProgressListener()` 获取上传组件的处理进程监听器，参考：`FileUploadBase.getProgressListener()`
`long`	`getSizeMax()` 获取文件上传的总文件大小限制
`boolean`	`removeAcceptType(String acceptType)` 删除一个可接受的上传文件类型
`void`	`setAcceptTypes(Set<String> acceptTypes)` 设置可接受的上传文件类型集合
`void`	`setAcceptTypes(String[] acceptTypes)` 设置可接受的上传文件类型集合
`void`	`setFactoryCleaningTracker(org.apache.commons.io.FileCleaningTracker factoryCleaningTracker)` 设置临时文件跟踪器，参考：`DiskFileItemFactory.setFileCleaningTracker(FileCleaningTracker)`
`void`	`setFactoryRepository(String factoryRepository)` 设置上传文件过程中的临时文件存放位置，参考：`DiskFileItemFactory.setRepository(File)`
`void`	`setFactorySizeThreshold(int factorySizeThreshold)` 设置写文件阀值，当上传的内容超过该值就把内容写到磁盘中，参考：`DiskFileItemFactory.setSizeThreshold(int)`
`void`	`setFileNameGenerator(FileUploader.FileNameGenerator fileNameGenerator)` 设置文件名生成器，参考：`FileUploader.FileNameGenerator`
`void`	`setFileSizeMax(long fileSizeMax)` 设置文件上传的单个文件大小限制
`void`	`setSavePath(String savePath)` 设置上传文件的保存路径（不包含文件名）
`void`	`setServletHeaderencoding(String servletHeaderencoding)` 设置上传组件解析上传内容的编码格式，参考：`FileUploadBase.setHeaderEncoding(String)`
`void`	`setServletProgressListener(org.apache.commons.fileupload.ProgressListener servletProgressListener)` 设置上传组件的处理进程监听器，参考：`FileUploadBase.setProgressListener(ProgressListener)`
`void`	`setSizeMax(long sizeMax)` 设置文件上传的总文件大小限制
`FileUploader.Result`	`upload(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` 执行上传

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - NO_LIMIT_SIZE_MAX
```
public static final long NO_LIMIT_SIZE_MAX
```
    不限制文件上传总大小的 Size Max 常量
    
    另请参阅:
    常量字段值
  - NO_LIMIT_FILE_SIZE_MAX
```
public static final long NO_LIMIT_FILE_SIZE_MAX
```
    不限制文件上传单个文件大小的 File Size Max 常量
    
    另请参阅:
    常量字段值
  - DEFAULT_SIZE_THRESHOLD
```
public static final int DEFAULT_SIZE_THRESHOLD
```
    默认的写文件阀值
    
    另请参阅:
    常量字段值
  - DEFAULT_FILE_NAME_GENERATOR
```
public static final FileUploader.FileNameGenerator DEFAULT_FILE_NAME_GENERATOR
```
    默认的文件名生成器
- 构造器详细资料
  - FileUploader
```
public FileUploader()
```
  - FileUploader
```
public FileUploader(String savePath)
```
    构造函数
    
    参数:
    savePath - : 上传文件的保存路径（不包含文件名），参考：setSavePath(String)
  - FileUploader
```
public FileUploader(String savePath,
            long sizeMax,
            long fileSizeMax)
```
    构造函数
    
    参数:
    savePath - : 上传文件的保存路径（不包含文件名），参考：setSavePath(String)
    sizeMax - : 文件上传的总文件大小限制，默认：NO_LIMIT_SIZE_MAX
    fileSizeMax - : 文件上传的单个文件大小限制，默认：NO_LIMIT_FILE_SIZE_MAX
  - FileUploader
```
public FileUploader(String savePath,
            String[] acceptTypes)
```
    构造函数
    
    参数:
    savePath - : 上传文件的保存路径（不包含文件名），参考：setSavePath(String)
    acceptTypes - : 可接受的上传文件类型集合，默认：不限制
  - FileUploader
```
public FileUploader(String savePath,
            String[] acceptTypes,
            long sizeMax,
            long fileSizeMax)
```
    构造函数
    
    参数:
    savePath - : 上传文件的保存路径（不包含文件名），参考：setSavePath(String)
    acceptTypes - : 可接受的上传文件类型集合，默认：不限制
    sizeMax - : 文件上传的总文件大小限制，默认：NO_LIMIT_SIZE_MAX
    fileSizeMax - : 文件上传的单个文件大小限制，默认：NO_LIMIT_FILE_SIZE_MAX
- 方法详细资料
  - getSavePath
```
public String getSavePath()
```
    获取上传文件的保存路径（不包含文件名）
  - setSavePath
```
public void setSavePath(String savePath)
```
    设置上传文件的保存路径（不包含文件名）
    
    参数:
    savePath - : 文件路径，可能是绝对路径或相对路径
    1) 绝对路径：以根目录符开始（如：'/'、'D:\'），是服务器文件系统的路径
    2) 相对路径：不以根目录符开始，是相对于 WEB 应用程序 Context 的路径，（如：mydir 是指 '${WEB-APP-DIR}/mydir'）
    3) 规则：上传文件前会检查该路径是否存在，如果不存在则会尝试生成该路径，如果生成失败则上传失败并返回 FileUploader.Result.INVALID_SAVE_PATH
  - getFileSizeMax
```
public long getFileSizeMax()
```
    获取文件上传的单个文件大小限制
  - setFileSizeMax
```
public void setFileSizeMax(long fileSizeMax)
```
    设置文件上传的单个文件大小限制
  - getSizeMax
```
public long getSizeMax()
```
    获取文件上传的总文件大小限制
  - setSizeMax
```
public void setSizeMax(long sizeMax)
```
    设置文件上传的总文件大小限制
  - getAcceptTypes
```
public Set<String> getAcceptTypes()
```
    获取可接受的上传文件类型集合
  - setAcceptTypes
```
public void setAcceptTypes(Set<String> acceptTypes)
```
    设置可接受的上传文件类型集合
  - setAcceptTypes
```
public void setAcceptTypes(String[] acceptTypes)
```
    设置可接受的上传文件类型集合
  - addAcceptType
```
public boolean addAcceptType(String acceptType)
```
    添加一个可接受的上传文件类型
  - removeAcceptType
```
public boolean removeAcceptType(String acceptType)
```
    删除一个可接受的上传文件类型
  - getParamFields
```
public Map<String,String[]> getParamFields()
```
    获取所有非文件表单域的映射
    
    返回:
    : key -> 表单域名称，value -> 表单内容，类型为 String[ ]
  - getFileFields
```
public Map<String,FileUploader.FileInfo[]> getFileFields()
```
    获取所有文件表单域的映射
    
    返回:
    : key -> 表单域名称，value -> FileUploader.FileInfo[ ]
  - getFactoryRepository
```
public String getFactoryRepository()
```
    获取上传文件过程中的临时文件存放位置，参考：DiskFileItemFactory.getRepository()
  - setFactoryRepository
```
public void setFactoryRepository(String factoryRepository)
```
    设置上传文件过程中的临时文件存放位置，参考：DiskFileItemFactory.setRepository(File)
  - getFactorySizeThreshold
```
public int getFactorySizeThreshold()
```
    获取写文件阀值，当上传的内容超过该值就把内容写到磁盘中，参考：DiskFileItemFactory.getSizeThreshold()
  - setFactorySizeThreshold
```
public void setFactorySizeThreshold(int factorySizeThreshold)
```
    设置写文件阀值，当上传的内容超过该值就把内容写到磁盘中，参考：DiskFileItemFactory.setSizeThreshold(int)
  - getFactoryCleaningTracker
```
public org.apache.commons.io.FileCleaningTracker getFactoryCleaningTracker()
```
    获取临时文件跟踪器，参考：DiskFileItemFactory.getFileCleaningTracker()
  - setFactoryCleaningTracker
```
public void setFactoryCleaningTracker(org.apache.commons.io.FileCleaningTracker factoryCleaningTracker)
```
    设置临时文件跟踪器，参考：DiskFileItemFactory.setFileCleaningTracker(FileCleaningTracker)
  - getServletHeaderencoding
```
public String getServletHeaderencoding()
```
    获取上传组件解析上传内容的编码格式，参考：FileUploadBase.getHeaderEncoding()
  - setServletHeaderencoding
```
public void setServletHeaderencoding(String servletHeaderencoding)
```
    设置上传组件解析上传内容的编码格式，参考：FileUploadBase.setHeaderEncoding(String)
  - getServletProgressListener
```
public org.apache.commons.fileupload.ProgressListener getServletProgressListener()
```
    获取上传组件的处理进程监听器，参考：FileUploadBase.getProgressListener()
  - setServletProgressListener
```
public void setServletProgressListener(org.apache.commons.fileupload.ProgressListener servletProgressListener)
```
    设置上传组件的处理进程监听器，参考：FileUploadBase.setProgressListener(ProgressListener)
  - getFileNameGenerator
```
public FileUploader.FileNameGenerator getFileNameGenerator()
```
    获取文件名生成器，参考：FileUploader.FileNameGenerator
  - setFileNameGenerator
```
public void setFileNameGenerator(FileUploader.FileNameGenerator fileNameGenerator)
```
    设置文件名生成器，参考：FileUploader.FileNameGenerator
  - getCause
```
public Throwable getCause()
```
    获取文件上传失败的原因（文件上传失败时使用）
  - upload
```
public FileUploader.Result upload(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
```
    执行上传
    
    参数:
    request - : HttpServletRequest 对象
    response - : HttpServletResponse 对象
    
    返回:
    : 成功：返回 FileUploader.Result.SUCCESS ，失败：返回其他结果，失败原因通过 getCause() 获取

类 FileUploader

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

NO_LIMIT_SIZE_MAX

NO_LIMIT_FILE_SIZE_MAX

DEFAULT_SIZE_THRESHOLD

DEFAULT_FILE_NAME_GENERATOR

构造器详细资料

FileUploader

FileUploader

FileUploader

FileUploader

FileUploader

方法详细资料

getSavePath

setSavePath

getFileSizeMax

setFileSizeMax

getSizeMax

setSizeMax

getAcceptTypes

setAcceptTypes

setAcceptTypes

addAcceptType

removeAcceptType

getParamFields

getFileFields

getFactoryRepository

setFactoryRepository

getFactorySizeThreshold

setFactorySizeThreshold

getFactoryCleaningTracker

setFactoryCleaningTracker

getServletHeaderencoding

setServletHeaderencoding

getServletProgressListener

setServletProgressListener

getFileNameGenerator

setFileNameGenerator

getCause

upload