RTXServer SDK Java语言支持文档

1、RTX Server SDK Java 语言开发指导语言开发指导目目 录录RTX Server SDK Java 语言开发指导 .1一、功能说明.2二、配置环境.2三、文件说明.3四、开发向导(以 Eclipse 为例).3五、接口说明.51系统函数.52扩展函数.7六、RTX2010 与 RTX3.61 Java 语言支持的差异 .11七、BUG 解决 .12一、功能说明一、功能说明RTX2010 Java SDK 可以实现以下五大功能：1 部门用户管理(数据同步)，可以对 RTX 服务器的部门及用户进行操作，通过该操作可以实现从其他系统同步用户数据到 RTX 服务器。2 单点登录，登录 O

2、A 或 ERP 时 RTX 客户端自动登录，不需要输入密码。3 待办事宜提醒,办公提醒，邮件到达提醒、公文到达提醒等。4 手机短信，向手机发送、接收短信，群发短信。5 状态推送，在网页上显示用户状态头像，并可以对在线用户发起会话。二、配置环境二、配置环境1 在开发机器安装 RTX2010 Server SDK 包。2 进入 Server SDK 安装目录(默认路径：x:Program FilesTencentRTXSSDK)，把该目录下的 dll 文件及 rtxServerApi.ini 拷贝到系统的 System32 目录下（RTX2008Beta2 之后的 RTX 版本安装时已经自动拷贝到

3、该目录下），如果在网页调用 java 接口，需要另拷贝一份到 JDK 的 bin 目录下。3 进入 RTX 服务器安装目录下，用记事本打开 SDKPorperty.xml 文件，在里面增加开发机器地址(如下图所示)，保存后重启 RTX 服务。4 拷贝 Java 目录(默认路径：x:Program FilesTencentRTXSSDKDemo SourceServer SampleJava)下的 RTXSvrApi.java 及其他示例文件到您的工作目录下。三、文件说明三、文件说明1 RTXSvrApi.java 是一个类库，里面封装了很多方法，但没有 main 函数，因此该文件只能编译不能运

4、行，主要是提供方法给外部调用。2 RTXSvrApi.java 文件里面导入 SDKAPIJava.dll，该 dll 是在 SDKAPIC.dll 上面封装，SDK 目录下的 dll 相互有联系，因此必须把这些 dll 拷贝到 System32 下，否则编译 RTXSvrApi.java 将出错，提示找不到 SDKAPIC。3 Java 目录下的文件除了 RTXSvrApi.java，其他的都是示例文件（请参看示例文件（请参看示例文件使用各种函数）使用各种函数） 。4 RtxServerApi.ini 文件用于设置服务器的 IP 地址及端口。5 SDKPorperty.xml 文件用于 SD

5、K 访问 RTX 服务器权限管理，只有这个文件添加的IP 才能访问 RTX 服务器。四、开发向导四、开发向导(以以 Eclipse 为例为例)1.启动Eclipse ，创建一个空白的 Java Project，如下图所示：2.在工程 src 添加一个名为 rtx 的 package，并将 RTXSvrApi.java 拖进这个package，如下图所示： 注意：注意：RTXSvrApi.java 只能放进只能放进 rtx 下，下，rtx 不能有父不能有父 package，否则会，否则会报错。报错。3. 把 SetSvrIpPort.java 拖到 src，自动生成一个(defalt packa

6、ge)并放在这个目录下，SvrIP 填写正确的 RTX 服务器 IP 地址后按 Ctrl+F11 运行，如下图所示：4. 把 AddDept.Java 拖到 src，自动生成一个(defalt package)并放在这个目录下，按 Ctrl+F11 运行，如下图所示：5. 进入 RTX 用户管理器，就可以看到刚刚添加的部门，如下图所示：五、接口说明五、接口说明1系统函数系统函数语法：boolean Init()功能：初始化类参数：无调用：Init()说明：初始化 RTXSvrApi，成功返回 true，失败返回 false语法：void UnInit()功能：析构类参数：无调用：Init()说

7、明：析构 RTXSvrApi语法：int GetNewObject(String szObjectName)功能：获取一个业务对象句柄参数：szObjectName 业务对象名称调用：GetNewObject(OBJNAME_RTXSYS)说明：调用成功返回一个业务对象句柄语法：int GetNewPropertys()功能：获取属性集合句柄参数：无调用：GetNewPropertys()说明：调用成功返回一个属性合集的柄语法：int ReleaseHandle(int iHandle)功能：释放句柄参数：iHandle 句柄调用：ReleaseHandle(iHandle) /iHandle

8、 是一个句柄说明：调用成功释放句柄语法：int AddProperty(int iPropertyHandle, String szName, String szValue)功能：向属性集合添加属性参数：iPropertyHandle 属性集合句柄，szName 属性名，szValue 属性值调用：AddProperty(iProp, KEY_USERNAME, UserName)说明：调用成功向属性集合添加一个属性语法：int GetPropertysCount(int iHandle)功能：获取属性集合中属性总数参数：iHandle 属性集合句柄调用：GetPropertysCount(i

9、Handle)/iHandle 为属性句柄说明：调用成功返回属性集合中的属性总数语法：int GetPropertysItem(int iHandle, int iIndex)功能：通过索引获取属性集合中对应的属性参数：iHandle 属性集合句柄，iIndex 索引值调用：GetPropertysItem(iHandle, i)/iHandle 为属性句柄，i 为索引说明：调用成功返回属性句柄语法：int Call(int iObjectHandle, int iPropertyHandle, int iCmdID)功能：调用 SDK参数：iObjectHandle 业务对象句柄，iProp

10、ertyHandle 属性集合句柄，iCmdID 命令号调用：Call(iObjectHandle, iPropertyHandle, iCmdID)说明：调用成功返回一个结果句柄语法：int GetResultPropertys(int iResultHandle)功能：从结果句柄得到一个属性集合句柄参数：iResultHandle 结果句柄调用：GetResultPropertys(int iResultHandle)说明：调用成功返回属性集合句柄语法：String GetPropertyItemName(int iHandle)功能：获取一个属性的名称参数：iHandle 属性句柄调用：

11、GetPropertyItemName(iHandle)说明：调用成功返回属性句柄对应的属性名语法：String GetPropertyItemValue(int iHandle)功能：获取一个属性的值参数：iHandle 属性句柄调用：GetPropertyItemName(iHandle)说明：调用成功返回属性句柄对应的属性值语法：int GetResultInnerCode(int iHandle)功能：获取内部错误代码参数：iHandle 返回结果句柄调用：GetResultInnerCode(int iHandle)说明：获取返回结果错误代码,返回 0 表示调用成功，返回其他表示出错

12、语法：String GetResultErrString(int iHandle)功能：获取内部错误信息参数：iHandle 返回结果句柄调用：GetResultInnerCode(iHandle)说明：返回错误描述2扩展函数扩展函数/ 配置文件操作语法：void setServerIP(String strIP)功能：设置服务器 IP参数：strIP 为 RTX 服务器 IP 地址调用：setServerIP(“”)说明：调用成功将设置 System32 下 rtxServerApi.ini 的 host 为指定的 IP 地址语法：void setServerPort(in

13、t iPort)功能：设置服务器端口参数：iPort 为 RTX 服务器 SDK 服务器端口，默认为 6000调用：setServerPort(6000)说明：调用成功将设置 System32 下 rtxServerApi.ini 的 Port 为指定的端口语法：String getServerIP()功能：获取服务器地址参数：无调用：getServerIP()说明：调用成功将返回 System32 下 rtxServerApi.ini 的 IP 地址语法：void getServerPort()功能：设置服务器端口参数：无调用：getServerIP()说明：调用成功将设置 System32

14、 下 rtxServerApi.ini 的端口/ 部门数据操作语法：int addDept(String deptId,String DetpInfo,String DeptName,String ParentDeptId )功能：添加部门参数：deptId 部门 ID、DetpInfo 部门信息、DeptName 部门名称、ParentDeptId 父部门ID调用：addDept (“1”,”测试部门信息”,”测试部门”,”0”)说明：成功返回 0，失败返回其他。语法：setDept(String deptId,String DetpInfo,String DeptName,String P

15、arentDeptId )功能：修改部门参数：deptId 部门 ID、DetpInfo 部门信息、DeptName 部门名称、ParentDeptId 父部门ID调用：setDept (“1”,”测试部门信息”,”财务部”,”0”)说明：成功返回 0，失败返回其他。语法：deleteDept(String deptId,String type)功能：删除部门参数：deptId 部门 ID、type 删除类型（0 为不删除部门下用户，1 为删除部门下用户）调用：deleteDept (“1”,”1”)说明：成功返回 0，失败返回其他。语法：int deptIsExist(String dept

16、Id)功能：查看部门是否存在参数：deptId 部门 ID调用：deleteDept (“1”)说明：成功返回 0，失败返回其他。语法：String getDeptUsers(String DeptID)功能：获取部门下用户参数：deptId 部门 ID调用：getDeptUsers (“1”)说明：成功返回 String的用户数组，失败返回 null。语法：StringgetChildDepts(String DeptID)功能：获取子部门列表参数：deptId 部门 ID调用：getChildDepts (“0”)说明：成功返回 String的子部门 ID 数组，失败返回 null。/用户

17、数据操作语法：int addUser(String UserName, String DeptID, String ChsName, String Pwd )功能：添加用户参数：UserName 用户帐号、DeptID 部门 ID、ChsName 用户姓名、ChsName 密码调用：addUser(“herolin”, “1”, “林坚华”, “123” )说明：返回 0 表示成功，其他表示失败语法：int deleteUser(String UserName)功能：删除用户参数：UserName 用户帐号调用：deleteUser (“herolin”)说明：返回 0 表示成功，其他表示失败

18、语法：int userIsExist (String UserName)功能：查看用户是否存在参数：UserName 用户帐号调用：userIsExist (“herolin”)说明：成功返回 0，失败返回其他。语法：String GetUserSimpleInfo(String UserName)功能：查看用户简单资料参数：UserName 用户帐号调用：GetUserSimpleInfo (“herolin” )说明：调用成功返回一个 String 类型的二维数组，失败返回 null语法：int SetUserSimpleInfo(String UserName,String ChsNam

19、e,String email,String gender,String mobile,String phone,String pwd)功能：设置用户简单资料参数：UserName 用户帐号、ChsName 用户姓名、email 邮箱地址、gender 性别、mobile 手机、pwd 密码调用：SetUserSimpleInfo(“herolin”, “林坚华”, “”,”0”,”135101435x”, 4”, “123”)说明：成功返回 0，失败返回其他。语法：int SetUserSimpleInfoEx(String UserName, String De

20、ptID, String ChsName,String email,String gender,String mobile,String phone,String pwd)功能：设置用户简单资料参数：UserName 用户帐号、DeptID 部门 ID、ChsName 用户姓名、email 邮箱地址、gender 性别、mobile 手机、pwd 密码调用：SetUserSimpleInfo(“herolin”, 2,“林坚华”, “”,”0”,”135101435x”, 4”, “123”)说明：成功返回 0，失败返回其他。语法：StringGetUserDet

21、ailInfo (String UserName)功能：查看用户详细资料参数：UserName 用户帐号调用：GetUserDetailInfo (“herolin” )说明：调用成功返回一个 String 类型的二维数组，失败返回 null语法：int setUserDetailInfo(String UserName,String ADDRESS,String AGE,String BIRTHDAY, String BLOODTYPE,String CITY,String COLLAGE,String CONSTELLATION,String COUNTRY,String FAX, Str

22、ing HOMEPAGE,String MEMO,String POSITION,String POSTCODE,String PROVINCE,String STREET, String PHONE,String MOBILE)功能：设置用户详细资料参数：UserName 用户帐号、ADDRESS 地址、AGE 年龄、BIRTHDAY 生日、BLOODTYPE 血型、CITY 城市、COLLAGE 大学、CONSTELLATION 星座、COUNTRY国家、FAX 传真、HOMEPAGE 个人主页、MEMO 个人说明、POSITION 职位、PROVINCE 省份、STREET 街道、PHO

23、NE 电话、MOBILE 手机调用：setUserDetailInfo(“herolin”, “深圳市 xx 街道”, “23”, “19840201”, “1”,”深圳”, “深大”, “9”, “中国”, 9”, “”, “没有个人说明”, “员工”, “510650”, “广东省”, “xx 街”, 4”, “1351014353x”)说明：成功返回 0，失败返回其他。/SessionKey操作语法：String getSessionKey(String UserName)功能：获取 SessionKey参数：UserName

24、用户帐号调用：getSessionKey (“herolin”)说明：成功返回 String 类型的 SessionKey，失败返回 null。/消息提醒语法：int sendNotify(String receivers,String title,String msg, String type,String delayTime)功能：发送消息提醒 参数：receivers 接收者、title 标题、msg 信息内容、type 消息类型、delayTime 显示时间调用：sendNotify (“herolin”,”公司公文”,”xx 同事升级 xx 部门总经理”,”0”,”0”)说明：成功返

25、回 0，失败返回其他。/发送短信语法：int sendSms(String sender, String receiver, String smsInfo,int autoCut, int noTitle)功能：发送手机短信 参数：sender 发送者、receiver 接收者、smsInfo 短信内容、autoCut 是否自动拆分、noTitle 是否有标题调用：sendSms(“herolin”, , “SDK 短信测试”, “1”, “0”)说明：成功返回 0，失败返回其他。/导入导出用户数据语法：int exportXmldata ()功能：导出 RTX 用户

26、数据为 xml 参数：无调用：exportXmldata ()说明：成功返回 String 类弄的 xml 字符串，失败返回 null。语法：int importXmldata(String xmldata)功能：导入 xml 用户数据到 RTX 服务器参数：xmldata xml 格式用户数据调用：importXmldata(xmldata)/xmldata 为 xml 格式的 RTX 用户数据说明：成功返回 String 类弄的 xml 字符串，失败返回 null。/查看用户在线状态语法：int QueryUserState(String UserName)功能：查看用户状态参数：User

27、Name 用户帐号调用：QueryUserState(“herolin”)说明：返回 0 离线、1 在线、2 离开、-984 用户不存在，其他表示调用失败/根据部门ID查部门名称语法：String GetDeptName(String deptID)功能：查部门名称参数：deptID 用户帐号调用：GetDeptName(“2”)说明：成功返回 String 类型的部门名称，失败返回 null。六、六、RTX2010 与与 RTX3.61 Java 语言支持的差异语言支持的差异1 RTX2010 支持一个用户所属多个部门， 因此有可能出现用户所属部门 ID 为两个以上,所以通过 SDK 查看用户简单资料时，返回 DeptID 带有 “；”，主要用于区分多个部门 ID。2 RTX 2010 Server 强加了 SDK 访问安性,因此通过 http 方式访问 cgi