LocalJackRabbitFileStore (鏂囦欢瀛樺偍浠撳簱 1.0 API)

java.lang.Object
- com.kdgcsoft.power.filestore.AbstractFileStore
- - com.kdgcsoft.power.filestore.LocalJackRabbitFileStore

所有已实现的接口:: FileStore

public class LocalJackRabbitFileStore
extends AbstractFileStore
implements FileStore

本地JackRabbit仓库的实现类。

作者:: hling

字段概要

字段
限定符和类型	字段和说明
`protected static String`	`DEFAULT_PASS`
`protected static String`	`DEFAULT_USER`
`protected static org.slf4j.Logger`	`logger`
`protected String`	`password`
`protected javax.jcr.Repository`	`repository`
`protected String`	`rootNodeName`
`protected String`	`user`

从类继承的字段 com.kdgcsoft.power.filestore.AbstractFileStore
DEFAULT_STORE_NAME

构造器概要

构造器
构造器和说明
`LocalJackRabbitFileStore(String localStorePath)` 构造一个JackRabbit仓库实例，如果还不存在，则创建它
`LocalJackRabbitFileStore(String localStorePath, String userName, String password)` 构造一个JackRabbit仓库实例，如果还不存在，则创建它。
`LocalJackRabbitFileStore(String localStorePath, String storeName, String userName, String password)` 创建一个本地JackRabbit仓库实例，如果还不存在，则创建它
`LocalJackRabbitFileStore(String xmlFilePath, String locakStorePath, String storeName, String userName, String password)` 创建一个本地JackRabbit仓库实例，如果还不存在，则创建它

方法概要

方法
限定符和类型	方法和说明
`boolean`	`deleteFile(String uuid)` 删除指定uuid的文件
`boolean`	`exist(String uuid)` 判断文件是否存在
`FileInfo`	`getFile(String uuid)` 从内容仓库获取文件。
`InputStream`	`getFileAsStream(String uuid)` 从内容仓库获取文件流。
`long`	`getFileSize(String uuid)` 获取文件大小
`protected void`	`init(javax.jcr.Repository repository, String storeName)` 创建一个JackRabbit实例对象，使用缺省账号admin/admin。
`protected void`	`init(javax.jcr.Repository repository, String storeName, String username, String password)` 创建一个JackRabbit实例对象。
`FileInfo`	`putFile(File file, String realName, String relativePath)` 向内容仓库存储一个文件。
`FileInfo`	`putFileAsStream(InputStream inputStream, String realName, String relativePath)` 向内容仓库存储一个文件。
`List<String>`	`searchFullText(String keyword)` 全文检索检索出所有匹配关键字的uuid
`Map<String,String>`	`searchFullTextWithExcerpt(String keyword)` 全文检索并显示摘要。
`void`	`setLoginAccount(String user, String password)` 设定访问账号和密码，必须与仓库实际一致。
`boolean`	`supportFullTextSearch()`

从类继承的方法 com.kdgcsoft.power.filestore.AbstractFileStore
checkName, putFile, putFile, putFileAsStream, putFileAsStream

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

从接口继承的方法 com.kdgcsoft.power.filestore.FileStore
deleteFile, exist, getFile, getFileAsStream, getFileSize, putFile, putFile, putFile, putFileAsStream, putFileAsStream, putFileAsStream, searchFullText, searchFullTextWithExcerpt, setLoginAccount, supportFullTextSearch

- 字段详细资料
  - logger
```
protected static org.slf4j.Logger logger
```
  - DEFAULT_USER
```
protected static String DEFAULT_USER
```
  - DEFAULT_PASS
```
protected static String DEFAULT_PASS
```
  - repository
```
protected javax.jcr.Repository repository
```
  - rootNodeName
```
protected String rootNodeName
```
  - user
```
protected String user
```
  - password
```
protected String password
```
- 构造器详细资料
  - LocalJackRabbitFileStore
```
public LocalJackRabbitFileStore(String localStorePath)
                         throws FileStoreException
```
    构造一个JackRabbit仓库实例，如果还不存在，则创建它
    
    参数:
    localStorePath - 必须。内容仓库使用的磁盘根目录路径。如果目录还未创建或没有初始化过，则自动创建并初始化。
    
    抛出:
    
    FileStoreException - 存储库异常
  - LocalJackRabbitFileStore
```
public LocalJackRabbitFileStore(String localStorePath,
                        String userName,
                        String password)
                         throws FileStoreException
```
    构造一个JackRabbit仓库实例，如果还不存在，则创建它。
    
    参数:
    localStorePath - 必须。内容仓库的根目录对象。如果目录还未创建或没有初始化过，则自动创建并初始化。
    userName - 用于访问仓库的用户名。
    password - 用于访问仓库的密码。注意用户名和密码的设置是在JackRabbit的配置文件中，这里设置的只能用于访问仓库，不能用于创建仓库账户。如果仓库还不存在且未指定JackRabbit配置文件，则调用本构造函数生成的账号密码为admin/admin，相应的userName和password必须也为admin/admin，否则无法访问。
    
    抛出:
    
    FileStoreException - 存储库异常
  - LocalJackRabbitFileStore
```
public LocalJackRabbitFileStore(String localStorePath,
                        String storeName,
                        String userName,
                        String password)
                         throws FileStoreException
```
    创建一个本地JackRabbit仓库实例，如果还不存在，则创建它
    
    参数:
    localStorePath - 必须。内容仓库的根目录对象。如果目录还未创建或没有初始化过，则自动创建并初始化。
    storeName - 给仓库实例起的名字，后面需要根据这个名字来获取仓库实例。该名字也会成为仓库的根节点目录名。文字中不能含有特殊字符如斜杠等。
    userName - 用于访问仓库的用户名。
    password - 用于访问仓库的密码。注意用户名和密码的设置是在JackRabbit的配置文件中，这里设置的只能用于访问仓库，不能用于创建仓库账户。如果仓库还不存在且未指定JackRabbit配置文件，则调用本构造函数生成的账号密码为admin/admin，相应的userName和password必须也为admin/admin，否则无法访问。
    
    抛出:
    
    FileStoreException - 存储库异常
  - LocalJackRabbitFileStore
```
public LocalJackRabbitFileStore(String xmlFilePath,
                        String locakStorePath,
                        String storeName,
                        String userName,
                        String password)
                         throws FileStoreException
```
    创建一个本地JackRabbit仓库实例，如果还不存在，则创建它
    
    参数:
    xmlFilePath - 内容仓库模板respository.xml文件对象。如果文件不存在，则使用jackrabbit默认配置。
    locakStorePath - 必须。内容仓库的根目录对象。如果目录还未创建或没有初始化过，则自动创建并初始化。
    storeName - 给仓库实例起的名字，后面需要根据这个名字来获取仓库实例。该名字也会成为仓库的根节点目录名。文字中不能含有特殊字符如斜杠等。
    userName - 用于访问仓库的用户名。
    password - 用于访问仓库的密码。注意用户名和密码的设置是在JackRabbit的配置文件中，这里设置的只能用于访问仓库，不能用于创建仓库账户。如果仓库还不存在且未指定JackRabbit配置文件，则调用本构造函数生成的账号密码为admin/admin，相应的userName和password必须也为admin/admin，否则无法访问。
    
    抛出:
    
    FileStoreException - 存储库异常
- 方法详细资料
  - init
```
protected void init(javax.jcr.Repository repository,
        String storeName)
             throws FileStoreException
```
    创建一个JackRabbit实例对象，使用缺省账号admin/admin。
    
    参数:
    repository - JackRabbit仓库对象
    storeName - 存储名，对应该仓库中根目录下的一个子目录。一个JackRabbit仓库的根目录下可以有多个子目录，一个JackRabbitFileStore实例只操作一个特定子目录。
    
    抛出:
    
    FileStoreException
  - init
```
protected void init(javax.jcr.Repository repository,
        String storeName,
        String username,
        String password)
             throws FileStoreException
```
    创建一个JackRabbit实例对象。
    
    参数:
    repository - JackRabbit仓库对象
    storeName - 存储名，对应该仓库中根目录下的一个子目录。一个JackRabbit仓库的根目录下可以有多个子目录，一个JackRabbitFileStore实例只操作一个特定子目录。
    username - 访问仓库的用户名
    password - 访问仓库的密码
    
    抛出:
    
    FileStoreException
  - setLoginAccount
```
public void setLoginAccount(String user,
                   String password)
```
    设定访问账号和密码，必须与仓库实际一致。如果不设置，默认为admin/admin。
    
    指定者:
    
    setLoginAccount 在接口中 FileStore
    
    参数:
    user - 用户名
    password - 密码
  - putFile
```
public FileInfo putFile(File file,
               String realName,
               String relativePath)
                 throws FileStoreException
```
    向内容仓库存储一个文件。
    需要注意不能往一个节点位置放置太多（几万以上）平行文件，而应该用文件夹分开存放，否则影响性能。
    
    指定者:
    
    putFile 在接口中 FileStore
    
    参数:
    file - 文件对象
    realName - 存储库中使用的文件名。如果为null或空，则使用file参数所含的文件名。
    relativePath - 存储相对路径。如放在根目录为""，要放在"根目录/a/b/c"目录下则参数为"a/b/c"，以此类推。目录如果不存在，会自动创建。
    
    返回:
    文件在存储库中的uuid
    
    抛出:
    
    FileStoreException
  - putFileAsStream
```
public FileInfo putFileAsStream(InputStream inputStream,
                       String realName,
                       String relativePath)
                         throws FileStoreException
```
    向内容仓库存储一个文件。
    需要注意的时不能往一个节点位置放置太多（几万以上）平行文件，而应该用文件夹分开存放，否则影响性能。
    
    指定者:
    
    putFileAsStream 在接口中 FileStore
    
    参数:
    inputStream - 文件流对象
    realName - 存储库中使用的文件名。如果为null或空，则使用file参数所含的文件名。
    relativePath - 存储相对路径。如放在根目录为""，要放在"根目录/a/b/c"目录下则参数为"a/b/c"，以此类推。目录如果不存在，会自动创建。
    
    返回:
    文件在存储库中的uuid
    
    抛出:
    
    FileStoreException
  - getFile
```
public FileInfo getFile(String uuid)
                 throws FileStoreException
```
    从内容仓库获取文件。
    
    指定者:
    
    getFile 在接口中 FileStore
    
    参数:
    uuid - 文件uuid
    
    返回:
    文件对象，包含文件uuid、输入流、文件尺寸信息。如果没找到，返回null。
    
    抛出:
    
    FileStoreException
  - getFileAsStream
```
public InputStream getFileAsStream(String uuid)
                            throws FileStoreException
```
    从接口复制的说明: FileStore
    
    从内容仓库获取文件流。
    
    指定者:
    
    getFileAsStream 在接口中 FileStore
    
    参数:
    uuid - 在往内容仓库存放文件时获得的文件key。
    
    返回:
    文件流对象。如果没找到，返回null。
    
    抛出:
    
    FileStoreException - 存储库异常
  - getFileSize
```
public long getFileSize(String uuid)
                 throws FileStoreException
```
    获取文件大小
    
    指定者:
    
    getFileSize 在接口中 FileStore
    
    参数:
    uuid - 文件uuid
    
    返回:
    文件字节数。如果文件不存在，返回-1。
    
    抛出:
    
    FileStoreException
  - exist
```
public boolean exist(String uuid)
              throws FileStoreException
```
    判断文件是否存在
    
    指定者:
    
    exist 在接口中 FileStore
    
    参数:
    uuid - 文件uuid
    
    返回:
    true/false
    
    抛出:
    
    FileStoreException
  - deleteFile
```
public boolean deleteFile(String uuid)
                   throws FileStoreException
```
    删除指定uuid的文件
    
    指定者:
    
    deleteFile 在接口中 FileStore
    
    参数:
    uuid -
    
    返回:
    true表示删除成功，false表示文件不存在
    
    抛出:
    
    FileStoreException
  - searchFullText
```
public List<String> searchFullText(String keyword)
                            throws FileStoreException
```
    全文检索检索出所有匹配关键字的uuid
    
    指定者:
    
    searchFullText 在接口中 FileStore
    
    参数:
    keyword - 需要检索的关键字
    
    返回:
    List 与关键字匹配的文件uuid列表
    
    抛出:
    
    FileStoreException
    
    Exception
  - searchFullTextWithExcerpt
```
public Map<String,String> searchFullTextWithExcerpt(String keyword)
                                             throws FileStoreException
```
    全文检索并显示摘要。检索出所有匹配关键字的uuid和摘要，并存到Map中其中key为uuid，value为摘要
    
    指定者:
    
    searchFullTextWithExcerpt 在接口中 FileStore
    
    参数:
    keyword - 需要检索的关键字
    
    返回:
    Map
    
    抛出:
    
    FileStoreException
  - supportFullTextSearch
```
public boolean supportFullTextSearch()
```
    指定者:
    
    supportFullTextSearch 在接口中 FileStore

类 LocalJackRabbitFileStore

字段概要

从类继承的字段 com.kdgcsoft.power.filestore.AbstractFileStore

构造器概要

方法概要

从类继承的方法 com.kdgcsoft.power.filestore.AbstractFileStore

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

从接口继承的方法 com.kdgcsoft.power.filestore.FileStore

字段详细资料

logger

DEFAULT_USER

DEFAULT_PASS

repository

rootNodeName

user

password

构造器详细资料

LocalJackRabbitFileStore

LocalJackRabbitFileStore

LocalJackRabbitFileStore

LocalJackRabbitFileStore

方法详细资料

init

init

setLoginAccount

putFile

putFileAsStream

getFile

getFileAsStream

getFileSize

exist

deleteFile

searchFullText

searchFullTextWithExcerpt

supportFullTextSearch