FileStore (鏂囦欢瀛樺偍浠撳簱 0.0.2-SNAPSHOT API)

所有已知实现类:

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

作者:

hling

方法概要

方法
限定符和类型	方法和说明
`boolean`	`deleteFile(String key)` 删除指定key的文件
`boolean`	`exist(String key)` 判断文件是否存在
`FileInfo`	`getFile(String key)` 从内容仓库获取文件。
`InputStream`	`getFileAsStream(String key)` 从内容仓库获取文件流。
`long`	`getFileSize(String key)` 获取文件大小
`FileInfo`	`putFile(File file)` 向内容仓库存储一个文件，并返回将来可用于操作文件的Key。
`FileInfo`	`putFile(File file, String fileName)` 向内容仓库存储一个文件，并返回将来可用于操作文件的Key。
`FileInfo`	`putFile(File file, String fileName, String relativePath)` 向内容仓库中的逻辑相对路径下存储一个文件，并返回将来可用于操作文件的Key 对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在相应的逻辑节点下。
`FileInfo`	`putFileAsStream(InputStream inputStream)` 向内容仓库存储一个文件流，并返回将来可用于操作文件的Key。
`FileInfo`	`putFileAsStream(InputStream inputStream, String fileName)` 向内容仓库存储一个文件流，并返回将来可用于操作文件的Key。
`FileInfo`	`putFileAsStream(InputStream inputStream, String fileName, String relativePath)` 向内容仓库中的逻辑相对路径下存储一个文件流，并返回将来可用于操作文件的Key 对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在相应的逻辑节点下。
`List<String>`	`searchFullText(String keyword)` 全文检索检索出所有匹配关键字的文件Key。
`Map<String,String>`	`searchFullTextWithExcerpt(String keyword)` 全文检索并显示摘要。
`void`	`setLoginAccount(String user, String password)` 设定访问账号和密码，必须与仓库实际一致。
`boolean`	`supportFullTextSearch()`

- 方法详细资料
  - supportFullTextSearch
```
boolean supportFullTextSearch()
```
  - setLoginAccount
```
void setLoginAccount(String user,
                   String password)
```
    设定访问账号和密码，必须与仓库实际一致。如果不设置，默认为admin/admin。 SimpleFileStore之类的存储实现不支持此方法，即使调用也什么都不做。
    
    参数:
    user - 用户名
    password - 密码
  - putFile
```
FileInfo putFile(File file,
               String fileName,
               String relativePath)
                 throws FileStoreException
```
    向内容仓库中的逻辑相对路径下存储一个文件，并返回将来可用于操作文件的Key
    对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在相应的逻辑节点下。此时通常不能往一个路径下放置太多（几万以上）文件，而应该用文件夹分开存放，否则影响性能。
    对不支持文件逻辑路径的内容仓库实现，例如SimpleFileStore会忽略第三个参数而使用内部算法生成相对路径，应用程序无需关心，通常也不存在同一节点下存储过多文件而影响性能的问题。
    
    参数:
    file - 文件对象
    fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。
    relativePath - 存储相对路径。如果为null或""视为文件要放在根目录下。如果为"a/b/c"则视为放在"根目录/a/b/c"目录下，以此类推。目录如果不存在，会自动创建。
    不一定所有的仓库实现都支持存储相对路径，也不是必要的。对仓库实现来说，Key是操作文件的唯一必要条件。
    有的存储实现例如SimpleFileStore会基于内部算法实现存储目录结构，因而会忽略该参数。
    
    返回:
    文件在内容仓库中的key。通常为UUID，但根据内容仓库的具体实现也可以是别的。调用者不必关心其内容，只要存储即可。
    
    抛出:
    
    FileStoreException
  - putFile
```
FileInfo putFile(File file)
                 throws FileStoreException
```
    向内容仓库存储一个文件，并返回将来可用于操作文件的Key。
    对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在根节点下，因此可能会产生根目录下文件过多而影响性能的问题，这需要由应用程序控制。
    对不支持文件逻辑路径的内容仓库实现，例如SimpleFileStore将使用内部算法生成相对路径，应用程序无需关心，通常也不存在同一节点下存储过多文件而影响性能的问题。内容仓库中使用的文件名为file参数所含的文件名。
    
    参数:
    file - 文件对象
    
    返回:
    文件在内容仓库中的key。通常为UUID，但根据内容仓库的具体实现也可以是别的。调用者不必关心其内容，只要存储即可。
    
    抛出:
    
    FileStoreException
  - putFile
```
FileInfo putFile(File file,
               String fileName)
                 throws FileStoreException
```
    向内容仓库存储一个文件，并返回将来可用于操作文件的Key。
    对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在根节点下，因此可能会产生根目录下文件过多而影响性能的问题，这需要由应用程序控制。
    对不支持文件逻辑路径的内容仓库实现，例如SimpleFileStore将使用内部算法生成相对路径，应用程序无需关心，通常也不存在同一节点下存储过多文件而影响性能的问题。
    
    参数:
    file - 文件对象
    fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。
    
    返回:
    文件在内容仓库中的key。通常为UUID，但根据内容仓库的具体实现也可以是别的。调用者不必关心其内容，只要存储即可。
    
    抛出:
    
    FileStoreException
  - putFileAsStream
```
FileInfo putFileAsStream(InputStream inputStream,
                       String fileName,
                       String relativePath)
                         throws FileStoreException
```
    向内容仓库中的逻辑相对路径下存储一个文件流，并返回将来可用于操作文件的Key
    对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在相应的逻辑节点下。此时通常不能往一个路径下放置太多（几万以上）文件，而应该用文件夹分开存放，否则影响性能。
    对不支持文件逻辑路径的内容仓库实现，例如SimpleFileStore会忽略第三个参数而使用内部算法生成相对路径，应用程序无需关心，通常也不存在同一节点下存储过多文件而影响性能的问题。
    
    参数:
    inputStream - 文件流对象
    fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。
    relativePath - 存储的相对路径，目前仅JackRabbit仓库支持。如果为null或""视为文件要放在根目录下。如果为"a/b/c"则视为放在"根目录/a/b/c"目录下，以此类推。目录如果不存在，会自动创建。
    指定相对路径仅仅是目前为了优化JackRabbit仓库的内部存储结构（未来可能会删除该参数），如果应用系统需要记录相对路径，请自行记录该信息而不要依靠仓库实现。对仓库实现来说，Key是操作文件的唯一必要条件。
    基于本地文件的存储实现例如SimpleFileStore会基于内部算法实现优化的存储目录结构，因而会忽略该参数。
    
    返回:
    文件在内容仓库中的key。通常为UUID，但根据内容仓库的具体实现也可以是别的。调用者不必关心其内容，只要存储即可。
    
    抛出:
    
    FileStoreException
  - putFileAsStream
```
FileInfo putFileAsStream(InputStream inputStream,
                       String fileName)
                         throws FileStoreException
```
    向内容仓库存储一个文件流，并返回将来可用于操作文件的Key。
    对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在根节点下，因此可能会产生根目录下文件过多而影响性能的问题，这需要由应用程序控制。
    对不支持文件逻辑路径的内容仓库实现，例如SimpleFileStore将使用内部算法生成相对路径，应用程序无需关心，通常也不存在同一节点下存储过多文件而影响性能的问题。
    
    参数:
    InputStream - 文件流对象
    fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。
    
    返回:
    文件在内容仓库中的key。通常为UUID，但根据内容仓库的具体实现也可以是别的。调用者不必关心其内容，只要存储即可。
    
    抛出:
    
    FileStoreException
  - putFileAsStream
```
FileInfo putFileAsStream(InputStream inputStream)
                         throws FileStoreException
```
    向内容仓库存储一个文件流，并返回将来可用于操作文件的Key。
    对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在根节点下，因此可能会产生根目录下文件过多而影响性能的问题，这需要由应用程序控制。
    对不支持文件逻辑路径的内容仓库实现，例如SimpleFileStore将使用内部算法生成相对路径，应用程序无需关心，通常也不存在同一节点下存储过多文件而影响性能的问题。
    因文件流中没有文件名，故存储后的文件名就使用UUID作为文件名，且无扩展名。通常情况下，以流方式存储且不指定文件名的场景中，获取文件也应该以流方式获取。
    
    参数:
    InputStream - 文件流对象
    
    返回:
    文件在内容仓库中的key。通常为UUID，但根据内容仓库的具体实现也可以是别的。调用者不必关心其内容，只要存储即可。
    
    抛出:
    
    FileStoreException
  - getFile
```
FileInfo getFile(String key)
                 throws FileStoreException
```
    从内容仓库获取文件。
    
    参数:
    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 - 不支持全文检索或其他异常
    
    Exception
  - searchFullTextWithExcerpt
```
Map<String,String> searchFullTextWithExcerpt(String keyword)
                                             throws FileStoreException
```
    全文检索并显示摘要。检索出所有匹配关键字的文件Key和摘要，并存到Map中，其中key为文件key，value为摘要。
    
    参数:
    keyword - 需要检索的关键字
    
    返回:
    Map
    
    抛出:
    
    FileStoreException

接口 FileStore

方法概要

方法详细资料

supportFullTextSearch

setLoginAccount

putFile

putFile

putFile

putFileAsStream

putFileAsStream

putFileAsStream

getFile

getFileAsStream

getFileSize

exist

deleteFile

searchFullText

searchFullTextWithExcerpt