com.kdgcsoft.power.filestore

接口 FileStore

所有已知实现类:

AbstractFileStore, SimpleFileStore, TimeStampSimpleFileStore, UUIDSimpleFileStore

public interface FileStore

内容仓库实例接口。 内容仓库的设计思想是一个接口简单，只有存储文件、获取文件等最核心功能的文件存储中心。 应用程序往里面存储文件时会得到一个key，相当于钥匙。根据key可以在仓库中查找、删除文件。
通常建议key以UUID的形式返回，但并不是必须的。 应用程序不需要关心key的内容或格式，只要内容仓库能生成、识别该key，并能根据key获取文件即可。 应用程序不需要关心文件在仓库内部的存储方式。

作者:

hling

方法概要

限定符和类型	方法和说明
boolean	deleteFile(String key) 删除指定key的文件
boolean	exist(String key) 判断文件是否存在
InputStream	getFileAsStream(String key) 从内容仓库获取文件流。
FileInfo	getFileInfo(String key) 从内容仓库获取文件信息，不包含文件流InputStream，即返回的FileInfo对象中inputStream属性为null。
long	getFileSize(String key) 获取文件大小
FileInfo	putFile(File file) 向内容仓库存储一个文件，并返回将来可用于操作文件的FileInfo，包含将来用于操作文件的Key。
FileInfo	putFile(File file, String fileName) 向内容仓库存储一个文件，并返回将来可用于操作文件的FileInfo，包含将来用于操作文件的Key。
FileInfo	putFileAsStream(InputStream inputStream) 向内容仓库存储一个文件流，并返回将来可用于操作文件的Key。
FileInfo	putFileAsStream(InputStream inputStream, String fileName) 向内容仓库存储一个文件流，并返回包含文件Key的文件信息对象FileInfo（但其内部的InputStream为null）。
List<String>	searchFullText(String keyword) 全文检索 检索出所有匹配关键字的文件Key。
Map<String,String>	searchFullTextWithExcerpt(String keyword) 全文检索并显示摘要。
void	setLoginAccount(String user, String password) 设定访问账号和密码，必须与仓库实际一致。
void	shutdown() 在不使用文件仓库或应用程序退出时，请调用shutdown()方法，以便某些仓库实现类进行清理退出工作。
boolean	supportFullTextSearch()

方法详细资料

supportFullTextSearch

boolean supportFullTextSearch()

setLoginAccount

void setLoginAccount(String user,
                     String password)

设定访问账号和密码，必须与仓库实际一致。如果不设置，默认为admin/admin。 SimpleFileStore之类的存储实现不支持此方法，即使调用也什么都不做。

参数:

user - 用户名

password - 密码

putFile

FileInfo putFile(File file)
          throws FileStoreException

向内容仓库存储一个文件，并返回将来可用于操作文件的FileInfo，包含将来用于操作文件的Key。

内容仓库中使用的文件名将基于file参数所含的文件名生成。

注意：本方法返回的FileInfo对象中inputStream为null。

参数:

file - 文件对象

返回:

文件在内容仓库中的FileInfo 文件信息对象。注意：本方法返回的FileInfo对象中inputStream为null。

抛出:

FileStoreException - 存储文件失败时抛出异常

putFile

FileInfo putFile(File file,
                 String fileName)
          throws FileStoreException

向内容仓库存储一个文件，并返回将来可用于操作文件的FileInfo，包含将来用于操作文件的Key。

注意：本方法返回的FileInfo对象中inputStream为null。

参数:

file - 文件对象

fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。

返回:

文件在内容仓库中的FileInfo 文件信息对象。注意：本方法返回的FileInfo对象中inputStream为null。

抛出:

FileStoreException - 存储文件失败时抛出异常

putFileAsStream

FileInfo putFileAsStream(InputStream inputStream,
                         String fileName)
                  throws FileStoreException

向内容仓库存储一个文件流，并返回包含文件Key的文件信息对象FileInfo（但其内部的InputStream为null）。

参数:

inputStream - 文件流对象

fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。

返回:

文件在内容仓库中的FileInfo 文件信息对象。注意：本方法返回的FileInfo对象中inputStream为null。

抛出:

FileStoreException - 存储文件失败时抛出异常

putFileAsStream

FileInfo putFileAsStream(InputStream inputStream)
                  throws FileStoreException

向内容仓库存储一个文件流，并返回将来可用于操作文件的Key。

因文件流中没有文件名，故存储后的文件名就基于Key生成文件名，且无扩展名。 可能会影响全文检索的结果（检索不出来） 通常情况下，以流方式存储且不指定文件名的场景中，获取文件也应该以流方式获取。

参数:

inputStream - 文件流对象

返回:

文件在内容仓库中的FileInfo 文件信息对象。注意：本方法返回的FileInfo对象中inputStream为null。

抛出:

FileStoreException - 存储文件失败时抛出异常

getFileInfo

FileInfo getFileInfo(String key)
              throws FileStoreException

从内容仓库获取文件信息，不包含文件流InputStream，即返回的FileInfo对象中inputStream属性为null。

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

文件对象，包含文件key、文件尺寸信息。如果没找到，返回null。

抛出:

FileStoreException - 存储库异常

getFileAsStream

InputStream getFileAsStream(String key)
                     throws FileStoreException

从内容仓库获取文件流。

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

文件流对象。如果没找到或未设置，返回null。

抛出:

FileStoreException - 存储库异常

getFileSize

long getFileSize(String key)
          throws FileStoreException

获取文件大小

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

文件字节数。如果文件不存在，返回-1。

抛出:

FileStoreException - 存储库异常

exist

boolean exist(String key)
       throws FileStoreException

判断文件是否存在

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

true/false

抛出:

FileStoreException - 存储库异常

deleteFile

boolean deleteFile(String key)
            throws FileStoreException

删除指定key的文件

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

true表示删除成功，false表示文件不存在

抛出:

FileStoreException - 存储库异常

searchFullText

List<String> searchFullText(String keyword)
                     throws FileStoreException

全文检索 检索出所有匹配关键字的文件Key。 注意：FileStore并不一定支持全文检索。如果不支持，应抛出FileStoreException异常。

参数:

keyword - 需要检索的关键字

返回:

List 与关键字匹配的文件文件Key列表

抛出:

FileStoreException - 不支持全文检索或其他异常

searchFullTextWithExcerpt

Map<String,String> searchFullTextWithExcerpt(String keyword)
                                      throws FileStoreException

全文检索并显示摘要。检索出所有匹配关键字的文件Key和摘要，并存到Map中，其中key为文件key，value为摘要。

参数:

keyword - 需要检索的关键字

返回:

Map

抛出:

FileStoreException - 不支持全文检索或其他异常

shutdown

void shutdown()

在不使用文件仓库或应用程序退出时，请调用shutdown()方法，以便某些仓库实现类进行清理退出工作。