com.office.office.oo

类 AbstractOOBase

java.lang.Object

com.office.office.oo.AbstractOOBase

直接已知子类:

OnlyOfficeAPI

public abstract class AbstractOOBase
extends Object

字段概要

字段

限定符和类型	字段和说明
protected Cache	cache
protected CommonConfig	configuration
protected cn.hutool.json.JSONObject	convert
protected FileCustomization	customization
protected String	EDIT ============================
protected DocumentPermission	editPermission
protected FileEmbedded	embedded
protected OnlyProperties	onlyProperties 配置信息 ============================
protected Plugins	plugins
protected SaveFileProcessor	saveFileProcessor
protected String	VIEW
protected DocumentPermission	viewPermission

构造器概要

构造器

构造器和说明
AbstractOOBase(CommonConfig configuration)

方法概要

限定符和类型	方法和说明
abstract void	close(cn.hutool.json.JSONObject jsonObject) 关闭文档
abstract String	converted(String filetype, String key, String outputtype, String title, String password) 文件转化 #简单请求参数示例:
String	getCommandServiceUrl() 保存文件回调地址
String	getDowloadUrl(String fineId) 文件下载地址
String	getFileId(String key)
Integer	getHistNum() 获取规定历史文件数量
String	getKey(String fileId) 获取打开文档时的唯一key
protected DocumentPermission	getPermission(String mode, DocumentPermission documentPermission)
protected String	getServerName()
FileMetadata	getTempFile(String key) 临时文件信息
int	getUserNum(String key) 获取文件的当前使用人数
protected FileMetadata	handlerFile(Map<String,Object> map, Boolean collaborativeEditing)
abstract void	handlerStatus(cn.hutool.json.JSONObject jsonObject) 文件保存 状态为6时调用
int	iskey(String key, Integer users) 缓存中存放文件使用人数
abstract Map	openDocument(Map<String,Object> map, String mode, boolean collaborativeEditing, DocumentPermission documentPermission)
protected FileConfig	openEditConfig(Map<String,Object> map, String mode, boolean collaborativeEditing, DocumentPermission documentPermission)
protected void	ProcessConvertServiceResponceError(int errorCode)
void	removeTempFile(cn.hutool.json.JSONObject jsonObject) 删除临时文件信息
abstract String	save(String key, String userId) 手动执行保存回调
protected String	saveMessage(Integer error)
void	setCache(String key, String value) 缓存数据

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

configuration

protected final CommonConfig configuration

cache

protected Cache cache

saveFileProcessor

protected SaveFileProcessor saveFileProcessor

onlyProperties

protected OnlyProperties onlyProperties

配置信息 ============================

viewPermission

protected DocumentPermission viewPermission

editPermission

protected DocumentPermission editPermission

customization

protected FileCustomization customization

embedded

protected FileEmbedded embedded

plugins

protected Plugins plugins

convert

protected cn.hutool.json.JSONObject convert

EDIT

protected String EDIT

============================

VIEW

protected String VIEW

构造器详细资料

AbstractOOBase

public AbstractOOBase(CommonConfig configuration)

方法详细资料

getServerName

protected String getServerName()

返回:

服务名称

setCache

public void setCache(String key,
                     String value)

缓存数据

参数:

key - 键

value - 值

getHistNum

public Integer getHistNum()

获取规定历史文件数量

返回:

历史文件数量

getCommandServiceUrl

public String getCommandServiceUrl()

保存文件回调地址

返回:

地址

getDowloadUrl

public String getDowloadUrl(String fineId)

文件下载地址

参数:

fineId - 文件id

返回:

下载地址

getKey

public String getKey(String fileId)

获取打开文档时的唯一key

参数:

fileId - 文件id

返回:

key

iskey

public int iskey(String key,
                 Integer users)

缓存中存放文件使用人数

参数:

key - 文件唯一标识

users - 用户人数

返回:

当前人数

getUserNum

public int getUserNum(String key)

获取文件的当前使用人数

参数:

key - 文件唯一标识

返回:

当前人数

getFileId

public String getFileId(String key)

参数:

key - 文件唯一标识

返回:

文件id

getTempFile

public FileMetadata getTempFile(String key)

临时文件信息

参数:

key - 文件唯一标识

返回:

文件元数据

removeTempFile

public void removeTempFile(cn.hutool.json.JSONObject jsonObject)

删除临时文件信息

参数:

jsonObject - oo服务器回调参数

handlerFile

protected FileMetadata handlerFile(Map<String,Object> map,
                                   Boolean collaborativeEditing)
                            throws Exception

参数:

map - 文件信息{ 必填 fileId 必填 fileName 必填 fileType 必填 fileSize 可用携带其它值 }

collaborativeEditing - 是否协同

返回:

文件元数据

抛出:

Exception - 返回异常

openEditConfig

protected FileConfig openEditConfig(Map<String,Object> map,
                                    String mode,
                                    boolean collaborativeEditing,
                                    DocumentPermission documentPermission)

参数:

map - 文件信息

mode - 模式

collaborativeEditing - 是否协同

documentPermission - 权限信息

返回:

配置信息

close

public abstract void close(cn.hutool.json.JSONObject jsonObject)

关闭文档

参数:

jsonObject - oo服务回调参数

openDocument

public abstract Map openDocument(Map<String,Object> map,
                                 String mode,
                                 boolean collaborativeEditing,
                                 DocumentPermission documentPermission)

参数:

map - 文件信息

map{ - 必填 fileId 必填 fileName 必填 fileType 必填 fileSize 可用携带其它信息 }

mode - 打开方式 edit/view

collaborativeEditing - 是否协同编辑

documentPermission - 权限信息 非必填

返回:

handlerStatus

public abstract void handlerStatus(cn.hutool.json.JSONObject jsonObject)
                            throws Exception

文件保存 状态为6时调用

参数:

jsonObject -

抛出:

Exception

save

public abstract String save(String key,
                            String userId)

手动执行保存回调

参数:

key - 文件唯一标识

userId - 调用接口的用户

返回:

消息

converted

public abstract String converted(String filetype,
                                 String key,
                                 String outputtype,
                                 String title,
                                 String password)

文件转化 #简单请求参数示例:

参数:

filetype - 文件类型

key - 文件key

outputtype - 输出类型

title - 输出文件名称

password - 加密文档的密码

返回:

文件路径

getPermission

protected DocumentPermission getPermission(String mode,
                                           DocumentPermission documentPermission)

ProcessConvertServiceResponceError

protected void ProcessConvertServiceResponceError(int errorCode)
                                           throws Exception

抛出:

Exception

saveMessage

protected String saveMessage(Integer error)