com.actionsoft.bpms.server.fs

类 DCContext

java.lang.Object

com.actionsoft.bpms.server.fs.DCContext

所有已实现的接口:

java.lang.Cloneable

public final class DCContext
extends java.lang.Object
implements java.lang.Cloneable

DC存储控制器上下文对象。DC功能包括：主DC读写、副DC读写、多源引用

另请参阅:

当发生文件上传、下载时开放的事件接口, 发生异常或校验不通过时如果有信息要输出给用户, DC处理器接口描述对象, DC封装给开发者的常用API

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ATTR_FILE_LENGTH dc context支持的属性
static java.lang.String	ATTR_IS_ENCRYPT dc context支持的属性

构造器概要

构造器

构造器和说明
DCContext(UserContext session, DCPluginProfile dcProfile, java.lang.String groupValue, java.lang.String fileValue) 构造一个未指定文件名的DCContext
DCContext(UserContext session, DCPluginProfile dcProfile, java.lang.String appId, java.lang.String groupValue, java.lang.String fileValue) 构造一个未指定文件名的DCContext
DCContext(UserContext session, DCPluginProfile dcProfile, java.lang.String appId, java.lang.String groupValue, java.lang.String fileValue, java.lang.String fileName) 构造一个完整DCContext
DCContext(UserContext session, DCPluginProfile dcProfile, java.lang.String appId, java.lang.String groupValue, java.lang.String fileValue, java.lang.String fileName, java.lang.String extParam) 构造一个完整DCContext

方法概要

限定符和类型	方法和说明
DCContext	clone()
boolean	delete() 物理删除DC getFileName指定的文件
void	deleteByGroup() 已过时。
void	deleteByGroupName(java.io.FilenameFilter ff) 已过时。
boolean	existFile() 验证DC文档是否存在
DCContext	fileName(java.lang.String fileName)
static DCContext	fromJson(java.lang.String str) 从json结构构建一个上下文对象
java.lang.Object	get(java.lang.String k) 获得扩展参数
java.lang.String	getAppId() 获得应用Id
java.lang.String	getContentTokenId() 获得应用内可安全处理的KeyId，为网盘、美站这类非登录用户提供匿名的安全下载通道
DCMessage	getDCMessage() 处理异常时，获得发送给用户的信息，如果不设置，无返回结果
DCPluginProfile	getDCProfile() 获得DC插件的描述配置信息
java.lang.String	getDownloadURL()
java.lang.String	getExtParam() 获取扩展参数
java.util.Map<java.lang.String,java.lang.Object>	getExtParams() 获取Map类型扩展参数
long	getFileLastModified() 已过时。
java.lang.String	getFileLength() 获得附件长度值，需要null、“”判断，上传时为原始附件长度
java.lang.String	getFileName() 获得要(读/写)的文件名（原始未被加密处理的）
java.lang.String	getFileNameShow() 获得下载时显示给用户的附件名。
java.lang.String	getFilePath() 获得存储该文件
java.lang.String	getFileValue() 获得file目录标识，file目录后缀
java.lang.String	getGroupValue() 获得group目录标识，group目录后缀
java.lang.String	getPath() 获得存储该文件的目录
java.lang.String	getRepositoryName() 获得文档仓库根目录名
java.lang.String	getSecurityFileName() 获得加密后的文件名
UserContext	getSession() 获得用户上下文
java.lang.String	getStremURL() 已过时。
boolean	isCloud() 已过时。
boolean	isEncrypt() 指示附件是否加密存储的标志，包括附件名和内容，具体存储时决定是否支持该标志 如果未设置，默认通过repositoryName的DCConst.RULE_PREFIX标志位判断，特殊的场景，对于formfile，则根据UI设置判断；审核类附件，始终返回true
boolean	isUseColdPath()
void	put(java.lang.String k, java.lang.Object v) 设置扩展参数
void	setContentTokenId(java.lang.String contentTokenId) 设置应用内可安全处理的KeyId，为网盘、美站这类非登录用户提供匿名的安全下载通道
void	setDCMessage(DCMessage message) 给用户输出信息
void	setDCMessage(java.lang.String type, java.lang.String msg) 给用户输出信息
void	setDCProfile(DCPluginProfile dcProfile) 设置插件的描述配置信息
DCContext	setEncrypt(boolean encrypt) 设置附件是否加密存储的标志
void	setExtParam(java.lang.String extParam) 设置扩展参数
void	setExtParams(java.util.Map<java.lang.String,java.lang.Object> extParams)
DCContext	setFileLength(java.lang.String fl) 设置附件长度参数值
void	setFileName(java.lang.String fileName) 设置文件名（原始未被加密处理的）
void	setFileNameShow(java.lang.String fileNameShow) 设置下载时显示给用户的附件名。
void	setSecurityFileName(java.lang.String securityFileName) 设置加密后的文件名，只适用于需要高安全存储的文档仓库
void	setSession(UserContext session) 设置用户上下文
void	setUseColdPath(boolean useColdPath)
java.lang.String	toJson() 转换成简单json格式，用在需要参数化上下文的场景，如上传微信号多媒体文件

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

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

字段详细资料

ATTR_IS_ENCRYPT

public static final java.lang.String ATTR_IS_ENCRYPT

dc context支持的属性

另请参阅:

常量字段值

ATTR_FILE_LENGTH

public static final java.lang.String ATTR_FILE_LENGTH

dc context支持的属性

另请参阅:

常量字段值

构造器详细资料

DCContext

public DCContext(UserContext session,
                 DCPluginProfile dcProfile,
                 java.lang.String appId,
                 java.lang.String groupValue,
                 java.lang.String fileValue,
                 java.lang.String fileName)

构造一个完整DCContext

参数:

session - 用户上下文对象

appId - 应用Id

dcProfile - DC配置。可使用DCAPI.getDCProfile获取

groupValue - group目录标识

fileValue - file目录标识

fileName - 未加密处理的原始文件名

另请参阅:

UserContext, DCPluginProfile, DCAPI.getDCProfile(String, String)

DCContext

public DCContext(UserContext session,
                 DCPluginProfile dcProfile,
                 java.lang.String appId,
                 java.lang.String groupValue,
                 java.lang.String fileValue,
                 java.lang.String fileName,
                 java.lang.String extParam)

构造一个完整DCContext

参数:

session - 用户上下文对象

appId - 应用Id

dcProfile - DC配置。可使用DCAPI.getDCProfile获取

groupValue - group目录标识

fileValue - file目录标识

fileName - 未加密处理的原始文件名

extParam - 扩展参数

另请参阅:

UserContext, DCPluginProfile, DCAPI.getDCProfile(String, String)

DCContext

public DCContext(UserContext session,
                 DCPluginProfile dcProfile,
                 java.lang.String appId,
                 java.lang.String groupValue,
                 java.lang.String fileValue)

构造一个未指定文件名的DCContext

参数:

session - 用户上下文对象

appId - 应用Id

dcProfile - DC配置。可使用DCAPI.getDCProfile获取

groupValue - group目录标识

fileValue - file目录标识

另请参阅:

UserContext, DCPluginProfile, DCAPI.getDCProfile(String, String)

DCContext

public DCContext(UserContext session,
                 DCPluginProfile dcProfile,
                 java.lang.String groupValue,
                 java.lang.String fileValue)

构造一个未指定文件名的DCContext

参数:

session - 用户上下文对象

dcProfile - DC配置。可使用DCAPI.getDCProfile获取

groupValue - group目录标识

fileValue - file目录标识

另请参阅:

UserContext, DCPluginProfile, DCAPI.getDCProfile(String, String)

方法详细资料

fromJson

public static DCContext fromJson(java.lang.String str)

从json结构构建一个上下文对象

参数:

str - json结构

返回:

DC处理器上下文

isCloud

@Deprecated
public boolean isCloud()

已过时。

兼容历史程序。应用层不应该判断附件的存储位置，应通过DCStoreUtil.read/write直接读写附件

getStremURL

@Deprecated
public java.lang.String getStremURL()

已过时。

兼容历史程序，使用getDownloadURL

返回:

deleteByGroup

@Deprecated
public void deleteByGroup()

已过时。

兼容DC文件存储方式下的删除

参数:

ff -

deleteByGroupName

@Deprecated
public void deleteByGroupName(java.io.FilenameFilter ff)

已过时。

兼容DC文件存储方式下的删除

参数:

ff -

getDCMessage

public DCMessage getDCMessage()

处理异常时，获得发送给用户的信息，如果不设置，无返回结果

返回:

消息对象

setDCMessage

public void setDCMessage(DCMessage message)

给用户输出信息

参数:

message - DC消息

setDCMessage

public void setDCMessage(java.lang.String type,
                         java.lang.String msg)

给用户输出信息

参数:

type - 类型，见DCMessage常量

msg - 信息，如附件已成功上传

getContentTokenId

public java.lang.String getContentTokenId()

获得应用内可安全处理的KeyId，为网盘、美站这类非登录用户提供匿名的安全下载通道

返回:

安全处理的KeyId

setContentTokenId

public void setContentTokenId(java.lang.String contentTokenId)

设置应用内可安全处理的KeyId，为网盘、美站这类非登录用户提供匿名的安全下载通道

参数:

contentTokenId - 系统不再验证sid、groupValue、fileValue值，转交给开发者实现的DC处理器的#downloadContent()方法，根据contentTokenId自己处理

getDownloadURL

public java.lang.String getDownloadURL()

isUseColdPath

public boolean isUseColdPath()

setUseColdPath

public void setUseColdPath(boolean useColdPath)

getFileLastModified

@Deprecated
public long getFileLastModified()

已过时。

existFile

public boolean existFile()

验证DC文档是否存在

抛出:

java.io.IOException

delete

public boolean delete()

物理删除DC getFileName指定的文件

抛出:

java.io.IOException

getSecurityFileName

public java.lang.String getSecurityFileName()

获得加密后的文件名

返回:

加密后的文件名

setSecurityFileName

public void setSecurityFileName(java.lang.String securityFileName)

设置加密后的文件名，只适用于需要高安全存储的文档仓库

参数:

securityFileName - 加密后的文件名

getDCProfile

public DCPluginProfile getDCProfile()

获得DC插件的描述配置信息

返回:

DC插件的描述配置信息

setDCProfile

public final void setDCProfile(DCPluginProfile dcProfile)

设置插件的描述配置信息

参数:

dcProfile - 插件的描述配置信息

getSession

public UserContext getSession()

获得用户上下文

返回:

用户上下文

setSession

public final void setSession(UserContext session)

设置用户上下文

参数:

session - 用户上下文

getAppId

public java.lang.String getAppId()

获得应用Id

返回:

应用Id

getRepositoryName

public java.lang.String getRepositoryName()

获得文档仓库根目录名

返回:

文档仓库根目录名

getGroupValue

public java.lang.String getGroupValue()

获得group目录标识，group目录后缀

返回:

group目录后缀

getFileValue

public java.lang.String getFileValue()

获得file目录标识，file目录后缀

返回:

file目录后缀

getFileName

public java.lang.String getFileName()

获得要(读/写)的文件名（原始未被加密处理的）

返回:

文件名

setFileName

public void setFileName(java.lang.String fileName)

设置文件名（原始未被加密处理的）

参数:

fileName - 文件名

fileName

public DCContext fileName(java.lang.String fileName)

getFileNameShow

public java.lang.String getFileNameShow()

获得下载时显示给用户的附件名。仅用于附件下载时

返回:

显示附件名

setFileNameShow

public void setFileNameShow(java.lang.String fileNameShow)

设置下载时显示给用户的附件名。仅用于附件下载时

参数:

fileNameShow - 显示附件名

getExtParam

public java.lang.String getExtParam()

获取扩展参数

返回:

扩展参数

getExtParams

public java.util.Map<java.lang.String,java.lang.Object> getExtParams()

获取Map类型扩展参数

返回:

扩展参数

setExtParam

public void setExtParam(java.lang.String extParam)

设置扩展参数

参数:

extParam - 扩展参数

setExtParams

public void setExtParams(java.util.Map<java.lang.String,java.lang.Object> extParams)

put

public void put(java.lang.String k,
                java.lang.Object v)

设置扩展参数

参数:

k -

v -

get

public java.lang.Object get(java.lang.String k)

获得扩展参数

参数:

k -

返回:

toJson

public java.lang.String toJson()

转换成简单json格式，用在需要参数化上下文的场景，如上传微信号多媒体文件

getFilePath

public java.lang.String getFilePath()

获得存储该文件

返回:

getPath

public java.lang.String getPath()

获得存储该文件的目录

返回:

路径

setFileLength

public DCContext setFileLength(java.lang.String fl)

设置附件长度参数值

参数:

encrypt -

返回:

getFileLength

public java.lang.String getFileLength()

获得附件长度值，需要null、“”判断，上传时为原始附件长度

参数:

encrypt -

返回:

setEncrypt

public DCContext setEncrypt(boolean encrypt)

设置附件是否加密存储的标志

参数:

encrypt -

返回:

isEncrypt

public boolean isEncrypt()

指示附件是否加密存储的标志，包括附件名和内容，具体存储时决定是否支持该标志
如果未设置，默认通过repositoryName的DCConst.RULE_PREFIX标志位判断，特殊的场景，对于formfile，则根据UI设置判断；审核类附件，始终返回true

返回:

clone

public DCContext clone()

覆盖:

clone 在类中 java.lang.Object