程序包 org.opoo.ootp.client

接口 FileClient

所有已知实现类:

FileClientImpl

public interface FileClient

字段概要

字段

修饰符和类型	字段	说明
static final int	DEFAULT_BUFFER_SIZE
static final String	STORAGE_DEFAULT
static final String	STORAGE_FS

方法概要

修饰符和类型	方法	说明
static int	copy(InputStream in, OutputStream out)	将数据从输入流复制到输出流。
default void	copy(String fileId, File destination)	复制到本地文件。
default void	copy(String fileId, OutputStream outputStream)	复制到本地输出。
default void	copy(String fileId, Path destination)	复制到本地文件。
default void	copy(URI uri, File destination)
default void	copy(URI uri, OutputStream outputStream)
default void	copy(URI uri, Path destination)
ExsMessage	getFile(String fileId)	获取文件及附加信息。
default InputStream	getStream(String fileId)	下载文件。
default InputStream	getStream(URI uri)	获取 URI 对应的文件的输入流，如果远程文件是解密的，这里是解密后的输入流。
ExsMessage	getUri(URI uri)	获取 URI 对应的文件的文件信息，如果远程文件是解密的，这里是解密后的文件信息。
FileInfo	put(ExsMessage message, String storage, String pathInfo)	上传文件。
default String	upload(InputStream stream, ExsMetadata metadata)	上传文件
default String	upload(InputStream stream, ExsMetadata metadata, String storage)	上传文件
default String	upload(InputStream stream, ExsMetadata metadata, String storage, String pathInfo)	上传文件
default String	upload(String storage, String to, String contentType, File file)	上传文件。
default String	upload(String storage, String to, String contentType, File file, String pathInfo)	上传文件。
default String	upload(String storage, String to, String contentType, InputStream file, String fileName, long fileSize, long lastModified)	上传文件。
default String	upload(String storage, String to, String contentType, InputStream file, String fileName, long fileSize, long lastModified, String pathInfo)	上传文件。
default String	upload(ExsMessage message)	上传文件。
default String	upload(ExsMessage message, String storage)	上传文件。
default String	upload(ExsMessage message, String storage, String pathInfo)	上传文件。
default String	uploadToCustomStorage(String storage, String contentType, File file)	上传到个性化的存储器中。
default String	uploadToCustomStorage(String storage, String contentType, File file, String pathInfo)	上传到个性化的存储器中。
default String	uploadToCustomStorage(String storage, String contentType, InputStream file, String fileName, long fileSize, long lastModified)	上传到个性化的存储器中。
default String	uploadToCustomStorage(String storage, String contentType, InputStream file, String fileName, long fileSize, long lastModified, String pathInfo)	上传到个性化的存储器中。
default String	uploadToDefaultStorage(String to, String contentType, File file)	上传文件到默认文件中转服务。
default String	uploadToDefaultStorage(String to, String contentType, File file, String pathInfo)	上传文件到默认文件中转服务。
default String	uploadToDefaultStorage(String to, String contentType, InputStream file, String fileName, long fileSize, long lastModified)	上传文件到默认文件中转服务。
default String	uploadToDefaultStorage(String to, String contentType, InputStream file, String fileName, long fileSize, long lastModified, String pathInfo)	上传文件到默认文件中转服务。
default String	uploadToFsStorage(String repo, String contentType, File file)	上传文件到文件服务文件库。
default String	uploadToFsStorage(String repo, String contentType, File file, String pathInfo)	上传文件到文件服务文件库。
default String	uploadToFsStorage(String repo, String contentType, InputStream file, String fileName, long fileSize, long lastModified)	上传文件到文件服务文件库。
default String	uploadToFsStorage(String repo, String contentType, InputStream file, String fileName, long fileSize, long lastModified, String pathInfo)	上传文件到文件服务文件库。

字段详细资料

DEFAULT_BUFFER_SIZE

static final int DEFAULT_BUFFER_SIZE

另请参阅:

• 常量字段值

STORAGE_DEFAULT

static final String STORAGE_DEFAULT

另请参阅:

• 常量字段值

STORAGE_FS

static final String STORAGE_FS

另请参阅:

• 常量字段值

方法详细资料

put

FileInfo put(ExsMessage message,
 String storage,
 String pathInfo)
      throws IOException,
OotpException

上传文件。向机构外联数据传输平台发送文件。

参数:

message - 文件消息

storage - 存储器名称

pathInfo - 后置处理路径

返回:

上传后生成的文件ID等信息

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

从以下版本开始:

1.4

upload

default String upload(ExsMessage message,
 String storage,
 String pathInfo)
               throws IOException,
OotpException

上传文件。

参数:

message - 文件消息

storage - 存储器名称

pathInfo - 后置处理路径

返回:

上传后生成的文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

upload

default String upload(ExsMessage message,
 String storage)
               throws IOException,
OotpException

上传文件。

参数:

message - 文件消息

storage - 存储器名称

返回:

上传后生成的文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

upload

default String upload(ExsMessage message)
               throws IOException,
OotpException

上传文件。

参数:

message - 文件消息

返回:

上传后生成的文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

upload

default String upload(InputStream stream,
 ExsMetadata metadata,
 String storage,
 String pathInfo)
               throws IOException,
OotpException

上传文件

参数:

stream - 文件内容

metadata - 元数据

storage - 存储器

pathInfo - 后置处理路径

返回:

文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

upload

default String upload(InputStream stream,
 ExsMetadata metadata,
 String storage)
               throws IOException,
OotpException

上传文件

参数:

stream - 文件内容

metadata - 元数据

storage - 存储器

返回:

文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

upload

default String upload(InputStream stream,
 ExsMetadata metadata)
               throws IOException,
OotpException

上传文件

参数:

stream - 文件内容

metadata - 元数据

返回:

文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

uploadToFsStorage

default String uploadToFsStorage(String repo,
 String contentType,
 File file)
                          throws IOException,
OotpException

上传文件到文件服务文件库。

参数:

repo - 目标文件库

contentType - 文件内容类型

file - 文件

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

uploadToFsStorage

default String uploadToFsStorage(String repo,
 String contentType,
 File file,
 String pathInfo)
                          throws IOException,
OotpException

上传文件到文件服务文件库。

参数:

repo - 目标文件库

contentType - 文件内容类型

file - 文件

pathInfo - 文件上传的后置处理

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

uploadToFsStorage

default String uploadToFsStorage(String repo,
 String contentType,
 InputStream file,
 String fileName,
 long fileSize,
 long lastModified)
                          throws IOException,
OotpException

上传文件到文件服务文件库。

参数:

repo - 目标文件库

contentType - 文件内容类型

file - 文件内容

fileName - 文件名

fileSize - 文件大小，未知大小传 -1

lastModified - 文件最后更新时间

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

uploadToFsStorage

default String uploadToFsStorage(String repo,
 String contentType,
 InputStream file,
 String fileName,
 long fileSize,
 long lastModified,
 String pathInfo)
                          throws IOException,
OotpException

上传文件到文件服务文件库。

参数:

repo - 目标文件库

contentType - 文件内容类型

file - 文件内容

fileName - 文件名

fileSize - 文件大小，未知大小传 -1

lastModified - 文件最后更新时间

pathInfo - 文件上传的后置处理

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

uploadToDefaultStorage

default String uploadToDefaultStorage(String to,
 String contentType,
 File file)
                               throws IOException,
OotpException

上传文件到默认文件中转服务。

参数:

to - 目标接收方

contentType - 文件内容类型

file - 文件

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

uploadToDefaultStorage

default String uploadToDefaultStorage(String to,
 String contentType,
 File file,
 String pathInfo)
                               throws IOException,
OotpException

上传文件到默认文件中转服务。

参数:

to - 目标接收方

contentType - 文件内容类型

file - 文件

pathInfo - 文件上传的后置处理

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

uploadToDefaultStorage

default String uploadToDefaultStorage(String to,
 String contentType,
 InputStream file,
 String fileName,
 long fileSize,
 long lastModified)
                               throws IOException,
OotpException

上传文件到默认文件中转服务。

参数:

to - 目标接收方

contentType - 文件内容类型

file - 文件内容

fileName - 文件名

fileSize - 文件大小，未知大小传 -1

lastModified - 文件最后更新时间

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

uploadToDefaultStorage

default String uploadToDefaultStorage(String to,
 String contentType,
 InputStream file,
 String fileName,
 long fileSize,
 long lastModified,
 String pathInfo)
                               throws IOException,
OotpException

上传文件到默认文件中转服务。

参数:

to - 目标接收方

contentType - 文件内容类型

file - 文件内容

fileName - 文件名

fileSize - 文件大小，未知大小传 -1

lastModified - 文件最后更新时间

pathInfo - 文件上传的后置处理

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

uploadToCustomStorage

default String uploadToCustomStorage(String storage,
 String contentType,
 File file)
                              throws IOException,
OotpException

上传到个性化的存储器中。

参数:

storage - 存储器名称

contentType - 文件内容类型

file - 文件

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

uploadToCustomStorage

default String uploadToCustomStorage(String storage,
 String contentType,
 File file,
 String pathInfo)
                              throws IOException,
OotpException

上传到个性化的存储器中。

参数:

storage - 存储器名称

contentType - 文件内容类型

file - 文件

pathInfo - 文件上传的后置处理

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

uploadToCustomStorage

default String uploadToCustomStorage(String storage,
 String contentType,
 InputStream file,
 String fileName,
 long fileSize,
 long lastModified)
                              throws IOException,
OotpException

上传到个性化的存储器中。

参数:

storage - 存储器名称

contentType - 文件内容类型

file - 文件内容

fileName - 文件名

fileSize - 文件大小，未知大小传 -1

lastModified - 文件最后更新时间

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

uploadToCustomStorage

default String uploadToCustomStorage(String storage,
 String contentType,
 InputStream file,
 String fileName,
 long fileSize,
 long lastModified,
 String pathInfo)
                              throws IOException,
OotpException

上传到个性化的存储器中。

参数:

storage - 存储器名称

contentType - 文件内容类型

file - 文件内容

fileName - 文件名

fileSize - 文件大小，未知大小传 -1

lastModified - 文件最后更新时间

pathInfo - 文件上传的后置处理

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

upload

default String upload(String storage,
 String to,
 String contentType,
 File file)
               throws IOException,
OotpException

上传文件。

参数:

storage - 存储器的名称

to - 目标接收方

contentType - 文件内容类型

file - 文件

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

upload

default String upload(String storage,
 String to,
 String contentType,
 File file,
 String pathInfo)
               throws IOException,
OotpException

上传文件。

参数:

storage - 存储器的名称

to - 目标接收方

contentType - 文件内容类型

file - 文件

pathInfo - 文件上传的后置处理

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

upload

default String upload(String storage,
 String to,
 String contentType,
 InputStream file,
 String fileName,
 long fileSize,
 long lastModified)
               throws IOException,
OotpException

上传文件。

参数:

storage - 存储器的名称

to - 目标接收方，接收方ID或者文件库ID

contentType - 文件内容类型

file - 文件内容

fileName - 文件名

fileSize - 文件大小，未知大小传 -1

lastModified - 文件最后更新时间

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

upload

default String upload(String storage,
 String to,
 String contentType,
 InputStream file,
 String fileName,
 long fileSize,
 long lastModified,
 String pathInfo)
               throws IOException,
OotpException

上传文件。

参数:

storage - 存储器的名称

to - 目标接收方，接收方ID或者文件库ID

contentType - 文件内容类型

file - 文件内容

fileName - 文件名

fileSize - 文件大小，未知大小传 -1

lastModified - 文件最后更新时间

pathInfo - 文件后置处理路径

返回:

上传后返回的文件ID

抛出:

IOException - 文件处理异常

OotpException - 其它异常

getFile

ExsMessage getFile(String fileId)
            throws IOException

获取文件及附加信息。

参数:

fileId - 文件ID

返回:

文件及附加信息

抛出:

IOException - 文件处理异常

getStream

default InputStream getStream(String fileId)
                       throws IOException

下载文件。仅上传到默认中转服务的文件可以下载。

参数:

fileId - 文件ID

返回:

文件流

抛出:

IOException - 文件处理异常

copy

default void copy(String fileId,
 File destination)
           throws IOException

复制到本地文件。仅上传到默认中转服务的文件可以复制。

参数:

fileId - 文件ID

destination - 本地文件

抛出:

IOException - io 异常

copy

default void copy(String fileId,
 Path destination)
           throws IOException

复制到本地文件。仅上传到默认中转服务的文件可以复制。

参数:

fileId - 文件ID

destination - 本地文件

抛出:

IOException - io 异常

copy

default void copy(String fileId,
 OutputStream outputStream)
           throws IOException

复制到本地输出。仅上传到默认中转服务的文件可以复制。

参数:

fileId - 文件ID

outputStream - 输出流

抛出:

IOException - io 异常

getUri

ExsMessage getUri(URI uri)
           throws IOException

获取 URI 对应的文件的文件信息，如果远程文件是解密的，这里是解密后的文件信息。

参数:

uri - 远程文件资源地址。一般是预签名的S3对象的URI地址。

返回:

解密/解码后的输入流

抛出:

IOException - io 异常

getStream

default InputStream getStream(URI uri)
                       throws IOException

获取 URI 对应的文件的输入流，如果远程文件是解密的，这里是解密后的输入流。

参数:

uri - 远程文件资源地址。一般是预签名的S3对象的URI地址。

返回:

解密/解码后的输入流

抛出:

IOException - io 异常

copy

default void copy(URI uri,
 OutputStream outputStream)
           throws IOException

抛出:

IOException

copy

default void copy(URI uri,
 File destination)
           throws IOException

抛出:

IOException

copy

default void copy(URI uri,
 Path destination)
           throws IOException

抛出:

IOException

copy

static int copy(InputStream in,
 OutputStream out)
         throws IOException

将数据从输入流复制到输出流。

参数:

in - 输入流

out - 输出流

返回:

字节数

抛出:

IOException - IO异常