|
客户端API » Java 语言接口定义
com.bitanswer.library
|
构造方法摘要 |
---|
BitAnswer() |
BitAnswer(String url, String sn, byte[] option, LoginMode mode) |
方法摘要 | |
---|---|
void |
login(String url, String sn, LoginMode mode)
授权登录。初始化运行环境,获取操作句柄。必须在除升级函数之外的其它操作前执行。根据登录模式的不同可能需要连接授权服务器。 |
void |
loginEx(String url, String sn, int featureId, String xmlScope, LoginMode mode)
授权登录的增强版本。允许应用程序在登录时指定授权中所需包含的特征项,以缩小登录范围。 |
void |
logout()
此函数用于释放上下文句柄,退出登录状态。 |
int |
readFeature(int featureId)
此函数用于读取特征项的数据内容,可用于“只读”和“读写”特征类型。 |
void |
writeFeature(int featureId, int featureValue)
此函数用于更新“读写”类型的特征项的数据内容。 |
int |
convertFeature(int featureId, int para1, int para2, int para3, int para4)
此函数用于使用“算法”类型的特征项对输入参数进行变换操作,得到唯一对应的4字节结果。 |
byte[] |
encryptFeature(int featureId, byte[] pPlainBuffer)
此函数用于使用“密钥”类型的特征项对输入的明文进行加密,返回密文结果。 |
byte[] |
decryptFeature(int featureId, byte[] pCipherBuffer)
此函数用于使用“密钥”类型的特征项对输入的密文进行解密,返回明文结果。 |
int |
queryFeature(int featureId)
请求特征项,检查特征项是否存在并可用。可用于任意特征项类型。对于集团授权,函数执行成功后会占用一个模块用户数。 |
int |
queryFeatureEx(int featureId, int mode, int required, String xmlScope)
集团授权,通过featureId和version来占用特征项的用户数。 |
byte[] |
queryFeatureEx2(String featureName, int mode, int required, String xmlScope)
集团授权,通过featureName和version来占用特征项的用户数。 |
int |
releaseFeature(int featureId)
释放特征项。集团授权会释放模块用户数。 |
int |
releaseFeatureEx(int featureId, int consumed, String xmlScope)
集团授权,释放指定版本的特征项下的用户数。 |
void |
releaseFeatureEx2(byte[] ticket, int consumed)
集团授权,释放指定ticket下的特征项的所有用户数。 |
void |
setDataItem(String dataItemName, byte[] dataItemValue)
创建或更新配置项。如果相同名称的配置项存在,则会更新其中的数据;否则将添加新的授权码配置项。 |
void |
removeDataItem(String dataItemName)
删除指定的配置项。该操作无法删除通过控制台设置的产品配置项或模版配置项。 |
byte[] |
getDataItem(String dataItemName)
读取指定的配置项数据。 |
int |
getDataItemNum()
此函数用于获取可访问配置项的数量,一般用于配置项的枚举操作。 |
String |
getDataItemName(int index)
根据配置项索引获取其名称,一般用于配置项的枚举操作。 |
String |
getSessionInfo(SessionType type)
获取当前会话信息,以字符串形式返回。根据获取的内容不同,返回结果可能是XML格式或非XML格式。 返回数据中的日期项已根据客户端的本地时区进行调整。如果Login时未指定SN,返回串为当前系统所有可用SN的综合结果。 |
String |
getRequestInfo(String sn, BindingType type)
获取当前运行环境的升级请求码,用于发起本地授权激活及升级请求。 |
String |
getUpdateInfo(String url, String sn, String requestInfo)
使用请求码与授权服务器进行连接,获取升级码。本函数需要进行网络连接。 |
String |
applyUpdateInfo(String updateInfo)
应用升级码完成本地授权激活或升级。本函数必须在获取请求码的同一环境下执行。 |
void |
updateOnline(String url, String sn)
此函数用于与授权服务器在线连接,自动完成本地授权的升级操作。本函数需要进行网络连接。 |
String |
revoke(String sn)
获取用于迁出浮动授权码的请求码,以实现离线迁出操作。执行本函数后该授权码将不可用。 |
void |
revokeOnline(String url, String sn)
从客户端迁出已激活的浮动授权码。授权码迁出后,可以用于其它的客户端。本函数需要进行网络连接。 |
void |
checkOutSn(String url, int featureId)
从集团授权服务器借出一个完整的授权码,以允许客户端脱离集团服务器单独使用。被借出的集团授权码必须具有可借出属性,并在客户端成功借出后减少一个可用用户数。被借出的用户数在到期后将自动返还给集团服务器。 |
void |
checkOutSnEx(String url, int featureId, String xmlScope)
从授权服务器借出一个完整的授权码,以允许客户端服务器单独使用。被借出的授权码必须具有可借出属性,并在客户端成功借出后减少一个可用用户数。被借出的用户数在到期后将自动返还给服务器。 |
void |
checkOutFeatures(String url)
从集团授权服务器借出一组特征项,这些特征项必须包含在同一个授权码中。被借出的集团授权码必须具有可借出属性,并在客户端成功借出后减少一个可用用户数。被借出的用户数在到期后将自动返还给集团服务器。 |
void |
checkIn(String url, int featureId)
提前返还从集团授权服务器借出的授权。要提前返还授权,该授权码必须具有允许提前返还属性。 |
void |
checkInEx(String url, int featureId, String xmlScope)
提前返还从授权服务器借出的授权。要提前返还授权,该授权码必须具有允许提前返还属性。 |
String |
getInfo(String sn, InfoType type)
获取授权信息及使用环境信息,数据以XML格式返回。调用此函数前客户端不需要执行登录操作。 |
void |
removeSn(String sn)
删除指定授权码在本机的授权数据,可用于测试或当授权数据出现问题而不能通过升级解决时的故障处理。 |
int |
getVersion()
获取客户端安全库版本号。 |
String |
getTicketInfo(byte[] ticket, int type)
查看指定ticket的相关信息。 |
void |
setAttr(int type, byte[] pValue)
设置回调函数、阻塞队列超时时间、心跳重试次数、心跳重试间隔等。 |
int |
getFeatureInfo2(String featureName, String xmlScope)
检查特征项是否存在,不会占用授权码或特征项的用户数,获取特征项的剩余有效期。 |
void |
setSessionState(int state, byte[] pReserved)
设置客户端的状态为空闲状态或繁忙状态或激活状态。 |
void |
setLocalServer(String szHostName, int nPort, int nTimeoutSecondes)
设置集团服务的地址和端口。 |
void |
testBitService(String url, String sn, int featureId)
测试集团授权的特征项是否可用,不会占用授权码或特征项的用户数。 |
void |
setRootPath(String szPath)
设置授权文件的存储路径。 |
String |
getProductPath(int lenBuf)
获取授权存储目录。 |
void |
setProxy(String szHostName, int nPort, String szUserID, String szPassword)
设置代理服务的地址和端口。 |
构造方法详细信息 |
---|
public BitAnswer() public BitAnswer(String url, String sn, LoginMode mode)
方法详细信息 |
---|
void login ( String url, String sn, LoginMode mode)
void loginEx ( String url, String sn, int featureId, String xmlScope, LoginMode mode)
int readFeature ( int featureId)
void writeFeature ( int featureId, int featureValue)
int convertFeature ( int featureId, int para1, int para2, int para3, int para4)
byte[] encryptFeature ( int featureId, byte[] pPlainBuffer)
byte[] decryptFeature ( int featureId, byte[] pCipherBuffer)
int queryFeature ( int featureId)
int queryFeatureEx ( int featureId, int mode, int required, String xmlScope)
byte[] queryFeatureEx2 ( String featureName, int mode, int required, String xmlScope)
int releaseFeature ( int featureId)
int releaseFeatureEx ( int featureId, int consumed, String xmlScope)
void releaseFeatureEx2 ( byte[] ticket, int consumed)
void setDataItem ( String dataItemName, byte[] dataItemValue)
void removeDataItem ( String dataItemName)
byte[] getDataItem ( String dataItemName)
int getDataItemNum ()
String getDataItemName ( int index)
String getSessionInfo ( SessionType type)
String getRequestInfo ( String sn, BindingType type)
String getUpdateInfo ( String url, String sn, String requestInfo)
String applyUpdateInfo ( String updateInfo)
void updateOnline ( String url, String sn)
String revoke ( String sn)
void revokeOnline ( String url, String sn)
void checkOutSn ( String url, int featureId)
void checkOutSnEx ( String url, int featureId, String xmlScope)
void checkOutFeatures ( String url)
void checkIn ( String url, int featureId)
void checkInEx ( String url, int featureId, String xmlScope)
String getInfo ( String sn, InfoType type)
void removeSn ( String sn)
String getTicketInfo ( byte[] ticket, int type)
void setAttr ( int type, byte[] pValue)
int getFeatureInfo2 ( String featureName, String xmlScope)
void setSessionState ( int state, byte[] pReserved)
void setLocalServer ( String szHostName, int nPort, int nTimeoutSecondes)
void testBitService ( String url, String sn, int featureId)
void setRootPath ( String szPath)