org.jessma.util.http

类 FileDownloader

java.lang.Object

org.jessma.util.http.FileDownloader

public class FileDownloader
extends Object

文件下载器

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	FileDownloader.Mode 下载模式
static class	FileDownloader.Result 下载结果

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_BUFFER_SIZE 默认字节交换缓冲区大小
static String	DEFAULT_CONTENT_TYPE 下载文件的默认 Mime Type

构造器概要

构造器

构造器和说明
FileDownloader()
FileDownloader(byte[] bytes, String saveFileName) 构造函数
FileDownloader(byte[] bytes, String contentType, String saveFileName) 构造函数
FileDownloader(byte[] bytes, String contentType, String saveFileName, int bufferSize) 构造函数
FileDownloader(InputStream is, String saveFileName) 构造函数
FileDownloader(InputStream is, String contentType, String saveFileName) 构造函数
FileDownloader(InputStream is, String contentType, String saveFileName, int bufferSize) 构造函数
FileDownloader(String filePath) 构造函数
FileDownloader(String filePath, String contentType) 构造函数
FileDownloader(String filePath, String contentType, String saveFileName) 构造函数
FileDownloader(String filePath, String contentType, String saveFileName, int bufferSize) 构造函数

方法概要

方法

限定符和类型	方法和说明
FileDownloader.Result	download(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 执行下载
int	getBufferSize() 获取字节交换缓冲区的大小
byte[]	getBytes() 获取下载内容字节数组
Throwable	getCause() 获取文件下载失败的原因（文件下载失败时使用）
String	getContentType() 获取下载文件的 Mime Type
String	getFilePath() 获取下载文件的路径（包含文件名）
FileDownloader.Mode	getMode() 获取当前下载模式，参考：FileDownloader.Mode
String	getSaveFileName() 获取显示在浏览器的下载对话框中的文件名称
InputStream	getStream() 获取下载内容字节流
void	setBufferSize(int bufferSize) 设置字节交换缓冲区的大小
void	setBytes(byte[] bytes) 设置下载内容字节数组
void	setContentType(String contentType) 设置下载文件的 Mime Type
void	setFilePath(String filePath) 设置下载文件的路径（包含文件名）
void	setSaveFileName(String saveFileName) 设置显示在浏览器的下载对话框中的文件名称
void	setStream(InputStream stream) 设置下载内容字节流

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

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

字段详细资料

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

默认字节交换缓冲区大小

另请参阅:

常量字段值

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

下载文件的默认 Mime Type

另请参阅:

常量字段值

构造器详细资料

FileDownloader

public FileDownloader()

FileDownloader

public FileDownloader(String filePath)

构造函数

参数:

filePath - : 下载文件的路径（包含文件名），可能是相对路径或绝对路径，参考：setFilePath(String)

FileDownloader

public FileDownloader(String filePath,
              String contentType)

构造函数

参数:

filePath - : 下载文件的路径（包含文件名），可能是相对路径或绝对路径，参考：setFilePath(String)

contentType - : 下载文件的 Mime Type，默认：DEFAULT_CONTENT_TYPE

FileDownloader

public FileDownloader(String filePath,
              String contentType,
              String saveFileName)

构造函数

参数:

filePath - : 下载文件的路径（包含文件名），可能是相对路径或绝对路径，参考：setFilePath(String)

contentType - : 下载文件的 Mime Type，默认：DEFAULT_CONTENT_TYPE

saveFileName - : 显示在浏览器的下载对话框中的文件名称，默认与 filePath 参数中的文件名一致

FileDownloader

public FileDownloader(String filePath,
              String contentType,
              String saveFileName,
              int bufferSize)

构造函数

参数:

filePath - : 下载文件的路径（包含文件名），可能是相对路径或绝对路径，参考：setFilePath(String)

contentType - : 下载文件的 Mime Type，默认：DEFAULT_CONTENT_TYPE

saveFileName - : 显示在浏览器的下载对话框中的文件名称，默认与 filePath 参数中的文件名一致

bufferSize - : 字节缓冲区大小，默认：DEFAULT_CONTENT_TYPE

FileDownloader

public FileDownloader(byte[] bytes,
              String saveFileName)

构造函数

参数:

bytes - : 下载内容字节数组

saveFileName - : 显示在浏览器的下载对话框中的文件名称

FileDownloader

public FileDownloader(byte[] bytes,
              String contentType,
              String saveFileName)

构造函数

参数:

bytes - : 下载内容字节数组

contentType - : 下载文件的 Mime Type，默认：DEFAULT_CONTENT_TYPE

saveFileName - : 显示在浏览器的下载对话框中的文件名称

FileDownloader

public FileDownloader(byte[] bytes,
              String contentType,
              String saveFileName,
              int bufferSize)

构造函数

参数:

bytes - : 下载内容字节数组

contentType - : 下载文件的 Mime Type，默认：DEFAULT_CONTENT_TYPE

saveFileName - : 显示在浏览器的下载对话框中的文件名称

bufferSize - : 字节缓冲区大小，默认：DEFAULT_CONTENT_TYPE

FileDownloader

public FileDownloader(InputStream is,
              String saveFileName)

构造函数

参数:

is - : 下载内容字节流

saveFileName - : 显示在浏览器的下载对话框中的文件名称

FileDownloader

public FileDownloader(InputStream is,
              String contentType,
              String saveFileName)

构造函数

参数:

is - : 下载内容字节流

contentType - : 下载文件的 Mime Type，默认：DEFAULT_CONTENT_TYPE

saveFileName - : 显示在浏览器的下载对话框中的文件名称

FileDownloader

public FileDownloader(InputStream is,
              String contentType,
              String saveFileName,
              int bufferSize)

构造函数

参数:

is - : 下载内容字节流

contentType - : 下载文件的 Mime Type，默认：DEFAULT_CONTENT_TYPE

saveFileName - : 显示在浏览器的下载对话框中的文件名称

bufferSize - : 字节缓冲区大小，默认：DEFAULT_CONTENT_TYPE

方法详细资料

getFilePath

public String getFilePath()

获取下载文件的路径（包含文件名）

setFilePath

public void setFilePath(String filePath)

设置下载文件的路径（包含文件名）

参数:

filePath - : 文件路径，可能是绝对路径或相对路径
1) 绝对路径：以根目录符开始（如：'/'、'D:\'），是服务器文件系统的路径
2) 相对路径：不以根目录符开始，是相对于 WEB 应用程序 Context 的路径，（如：mydir/myfile 是指 '${WEB-APP-DIR}/mydir/myfile'）

getBytes

public byte[] getBytes()

获取下载内容字节数组

setBytes

public void setBytes(byte[] bytes)

设置下载内容字节数组

getStream

public InputStream getStream()

获取下载内容字节流

setStream

public void setStream(InputStream stream)

设置下载内容字节流

getMode

public FileDownloader.Mode getMode()

获取当前下载模式，参考：FileDownloader.Mode

getContentType

public String getContentType()

获取下载文件的 Mime Type

setContentType

public void setContentType(String contentType)

设置下载文件的 Mime Type

getSaveFileName

public String getSaveFileName()

获取显示在浏览器的下载对话框中的文件名称

setSaveFileName

public void setSaveFileName(String saveFileName)

设置显示在浏览器的下载对话框中的文件名称

getBufferSize

public int getBufferSize()

获取字节交换缓冲区的大小

setBufferSize

public void setBufferSize(int bufferSize)

设置字节交换缓冲区的大小

getCause

public Throwable getCause()

获取文件下载失败的原因（文件下载失败时使用）

download

public FileDownloader.Result download(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)

执行下载

参数:

request - : HttpServletRequest 对象

response - : HttpServletResponse 对象

返回:

: 成功：返回 FileDownloader.Result.SUCCESS ，失败：返回其他结果， 失败原因通过 getCause() 获取