Method Detail

• Integer delete(List<String> saveNames, List<String> syncIds)

  删除转储的附件，并返回删除的附件数量

  删除失败时，务必调用 deleteFailed 方法记录下来。

  Returns:

  成功删除的附件数量

  Parameters:

  saveNames - 本系统中的文件唯一标识

  syncIds - 目标系统中的文件唯一标识（save 的返回值），和 saveNames 一一对应；使用时注意非空判断

• protected void deleteFailed(List<String> saveNames, List<String> syncIds)

  删除失败时，记录并自动重试

• @bropen.toolkit.annotation.Internal final void deleteRetry()

• boolean exists(String saveName, String syncId)

  判断文件是否存在

• EncodedInputStreamWrapper getEncodedInputStream(javax.servlet.http.HttpServletRequest request, String saveName, String syncId)

  获得可用于下载的压缩附件流

  Returns:

  压缩附件流对象，注意所有属性都不能为空；如果不支持则返回 null 即可

  Parameters:

  request - 请求对象，可以根据 Accept-Encoding 头来判断是否支持压缩

• java.io.InputStream getInputStream(String saveName, String syncId)

  获得附件流，用于附件下载、内容解析（Search）等

  Parameters:

  saveName - 本系统中的文件唯一标识

  syncId - 目标系统中的文件唯一标识（save 的返回值）

• Long getLength(String saveName, String syncId, Long length)

  获得文件大小

  仅当 bropen.framework.resource.attachment.validate 启用，并且在下载文件的时候，校验文件是否被篡改。

  因此，如果未启用校验、或无需校验、或不支持获取文件大小，可以直接返回参数 length 即可。

• String getUrl(String saveName, String syncId, String fileName, Long length, String contentType, Date expiration)

  获得文件的下载地址

  如果返回 null，则通过 getInputStream 下载。

  需要注意设置下载的文件名（如果支持的话）。

  Returns:

  文件的下载地址，如果不支持则返回 null 即可。

  Parameters:

  fileName - 下载的文件名，通常应该设置到下载的 Content-Disposition 响应头中

  contentType - 文件的 contentType，默认为空（需要自行计算）

  expiration - 链接失效时间，默认为一天，即 new Date() + 1。

• boolean isEnabled()

  附件存储服务是否启用

  Returns:

  如果未调用过 setEnabled，则返回 null

• String save(String saveName, java.io.InputStream is, String fileName, Long length, String md5)

  附件转储

  oaram:

  fileName 文件名

  throws:

  Exception 如果转储失败，并抛出异常，则会自动通知用户、并删除上传的临时文件。

  Returns:

  返回目标系统中的文件唯一标识，即可作为 syncId 的字符串，不能超过 200 个字符；
  可以为空，此时其他接口方法就只能通过 saveName 来进行查询；
  如果为 null 则表示转储失败，但不通知用户、并仍将附件保存在本系统中，否则都表示转储成功。

  Parameters:

  saveName - 本系统中的文件唯一标识

  is - 文件的输入流，转储结束后，务必执行关闭（close）操作

  length - 文件长度

  md5 - 文件 md5 值

• void setEnabled(Boolean enabled)

  启用、禁用附件存储服务

• boolean shouldKeepLocalCopy(String fileName, Long length)

  附件上传时，是否有必要在本地保存一份副本

  比如某些类型、或者小于一定大小的文件，才保存到第三方存储中。

  Parameters:

  fileName - 文件名

  length - 文件大小

• @grails.transaction.Transactional Integer transfer(List<Attachment> attachments, boolean deleteFile)

  工具方法：迁移本地存储中的附件、并删除本地存储中的文件

  throws:

  Exception 转储失败时的异常

  Returns:

  迁移的附件数量。

  Parameters:

  attachments - 附件列表

  deleteFile - 迁移后是否删除本地存储中的文件，请谨慎设置