com.office.office.wps

类 AbstractWPSOfficeBase

java.lang.Object

com.office.office.wps.AbstractWPSOfficeBase

直接已知子类:

WPSOfficeAPI

public abstract class AbstractWPSOfficeBase
extends Object

字段概要

字段

限定符和类型	字段和说明
protected Cache	cache 本地缓存
protected CommonConfig	configuration 公共的配置信息
protected String	EDIT
protected MessageHandle	messageHandle 回调处理
protected SDKUtil	sdkUtil wps中台接口
protected String	VIEW
protected WPSBaseInfo	wpsBaseInfo wps专属配置

构造器概要

构造器

构造器和说明
AbstractWPSOfficeBase(CommonConfig configuration)

方法概要

限定符和类型	方法和说明
abstract byte[]	convert(String fileId, String fileName, String password, String outformat)
abstract byte[]	convert(String fileId, String fileName, String password, String outformat, Integer dpi, ToPdf toPdf, ToPng toPng, EtPageZoom etPageZoom)
abstract byte[]	convertToPdf(String fileId, String fileName, String password, ToPdf toPdf)
abstract byte[]	convertToPng(String fileId, String fileName, String password, ToPng toPng)
abstract byte[]	etConvert(String fileId, String fileName, String password, String outformat, EtPageZoom etPageZoom) 表格转换
Map<String,Object>	generateConfig(Map<String,Object> fileMeta, FileInfo fileInfo, UserAcl userAcl, FileWatermark watermark, UserInfo userInfo) 生成wps 所需配置信息
Map<String,Object>	generateConfig(Map<String,Object> fileMeta, FileInfo fileInfo, UserInfo userInfo) 生成wps 所需配置信息
String	getDownlaodUrl(String fileId) 获取文件下载路径
Integer	getHistNum() 获取规定历史文件数量
protected String	getServerName()
FileMetadata	getTempFile(String fileId) 临时文件信息
abstract void	handleOnnotifyMessage(OnnotifyMessage onnotifyMessage) 处理回调消息
protected FileMetadata	handlerFile(Map<String,Object> map) 设置文件元数据
abstract String	openDocument(String fileId, String fileName, Integer _w_tokentype, Map<String,String> params) 获取打开文件的连接
abstract String	openDocument(String fileId, String fileName, PreviewMode previewMode, Integer _w_tokentype, String wpsPreview, Map<String,String> params)
abstract byte[]	pdfToImg(String fileId, String fileName, String password, String outformat, Integer dpi)
void	removeTempFile(String fileId) 删除缓存中的文件元数据
void	setCache(String key, String value) 缓存数据
protected void	verifyCustomParameter(Map<String,String> params) 校验自定义参数

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

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

字段详细资料

configuration

protected final CommonConfig configuration

公共的配置信息

cache

protected Cache cache

本地缓存

messageHandle

protected MessageHandle messageHandle

回调处理

wpsBaseInfo

protected WPSBaseInfo wpsBaseInfo

wps专属配置

sdkUtil

protected SDKUtil sdkUtil

wps中台接口

EDIT

protected String EDIT

VIEW

protected String VIEW

构造器详细资料

AbstractWPSOfficeBase

public AbstractWPSOfficeBase(CommonConfig configuration)

方法详细资料

getServerName

protected String getServerName()

返回:

服务名称

removeTempFile

public void removeTempFile(String fileId)

删除缓存中的文件元数据

参数:

fileId - 唯一标识

getDownlaodUrl

public String getDownlaodUrl(String fileId)

获取文件下载路径

参数:

fileId - 文件id

返回:

下载路径

setCache

public void setCache(String key,
                     String value)

缓存数据

参数:

key - 键

value - 值

getHistNum

public Integer getHistNum()

获取规定历史文件数量

返回:

历史文件数量

getTempFile

public FileMetadata getTempFile(String fileId)

临时文件信息

参数:

fileId - 唯一标识

返回:

文件元数据

handlerFile

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

设置文件元数据

参数:

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

返回:

文件元数据

抛出:

Exception - 返回异常

verifyCustomParameter

protected void verifyCustomParameter(Map<String,String> params)

校验自定义参数

openDocument

public abstract String openDocument(String fileId,
                                    String fileName,
                                    Integer _w_tokentype,
                                    Map<String,String> params)

获取打开文件的连接

参数:

fileId - 文件id

fileName - 文件名称

_w_tokentype - 是否传token

params - 自定义参数

返回:

link

openDocument

public abstract String openDocument(String fileId,
                                    String fileName,
                                    PreviewMode previewMode,
                                    Integer _w_tokentype,
                                    String wpsPreview,
                                    Map<String,String> params)

参数:

fileId - 文件id

fileName - 文件名称

_w_tokentype - 是否传token

previewMode - 预览类型

wpsPreview - 高清预览支持控制修订痕迹、评论是否显示等参数。 览参数wpsPreview=1111111从左到右依次代表： 第0位：格式修订：0不显示；1：显示 第1位：插入和删除：0不显示；1：显示 第2位：评论 0不显示；1：显示 第3位：以嵌入模式显示修订 第4位：以气泡模式显示修订 第5位：0不显示标记；1：显示标记 第6位：0最终状态；1：原始状态 注：(第3、4位组合：01及11为批注框方式；10是嵌入方式 00是批注框显示修订者)

params - 自定义参数

返回:

link

generateConfig

public Map<String,Object> generateConfig(Map<String,Object> fileMeta,
                                         FileInfo fileInfo,
                                         UserInfo userInfo)

生成wps 所需配置信息

参数:

fileMeta - 文件元数据

fileInfo - 文件信息

userInfo - 用户信息

返回:

配置信息

generateConfig

public Map<String,Object> generateConfig(Map<String,Object> fileMeta,
                                         FileInfo fileInfo,
                                         UserAcl userAcl,
                                         FileWatermark watermark,
                                         UserInfo userInfo)

生成wps 所需配置信息

参数:

fileMeta - 文件元数据

fileInfo - 文件信息

userAcl - 用户权限信息

watermark - 水印信息

userInfo - 用户信息

返回:

配置信息

convert

public abstract byte[] convert(String fileId,
                               String fileName,
                               String password,
                               String outformat)
                        throws Exception

参数:

fileId - 文件id

fileName - 文件名称

password - 密码

outformat - 输出格式

返回:

文件二进制

抛出:

Exception - 抛出此异常

convertToPdf

public abstract byte[] convertToPdf(String fileId,
                                    String fileName,
                                    String password,
                                    ToPdf toPdf)
                             throws Exception

参数:

fileId - 文件id

fileName - 文件名称

password - 密码

toPdf - 转pdf的配置

返回:

文件二进制

抛出:

Exception - 抛出此异常

convertToPng

public abstract byte[] convertToPng(String fileId,
                                    String fileName,
                                    String password,
                                    ToPng toPng)
                             throws Exception

参数:

fileId - 文件id

fileName - 文件名称

password - 密码

toPng - 转png的配置

返回:

文件二进制

抛出:

Exception - 抛出此异常

pdfToImg

public abstract byte[] pdfToImg(String fileId,
                                String fileName,
                                String password,
                                String outformat,
                                Integer dpi)
                         throws Exception

参数:

fileId - 文件id

fileName - 文件名称

password - 密码

outformat - 输出格式

dpi - pdf 转图片 设置转换结果图片的dpi

返回:

文件二进制

抛出:

Exception - 抛出此异常

etConvert

public abstract byte[] etConvert(String fileId,
                                 String fileName,
                                 String password,
                                 String outformat,
                                 EtPageZoom etPageZoom)
                          throws Exception

表格转换

参数:

fileId - 文件id

fileName - 文件名称

password - 密码

outformat - 输出格式

etPageZoom - 表格配置

返回:

文件二进制

抛出:

Exception - 抛出此异常

convert

public abstract byte[] convert(String fileId,
                               String fileName,
                               String password,
                               String outformat,
                               Integer dpi,
                               ToPdf toPdf,
                               ToPng toPng,
                               EtPageZoom etPageZoom)
                        throws Exception

参数:

fileId - 文件id

fileName - 文件名称

password - 密码

outformat - 输出格式

dpi - pdf 转图片 设置转换结果图片的dpi

toPdf - 转pdf的配置

toPng - 转png的配置

etPageZoom - 表格配置

返回:

文件二进制

抛出:

Exception - 抛出此异常

handleOnnotifyMessage

public abstract void handleOnnotifyMessage(OnnotifyMessage onnotifyMessage)

处理回调消息

参数:

onnotifyMessage - 消息数据