RTX二次开发.doc

1 19 RTXRTX二次开发二次开发 西安美林电子有限公司西安美林电子有限公司 二二 一一 年六月年六月 应用集成部应用集成部RTX 二次开发二次开发 2 19 西安美林电子有限公司西安美林电子有限公司 版本历史版本历史 日期日期版本版本说明 文档修改描述 说明 文档修改描述 作者作者审核人审核人 2010 6 10 0 1 文档编写刘俊岐 应用集成部应用集成部RTX 二次开发二次开发 3 19 西安美林电子有限公司西安美林电子有限公司 目目 录录 1引言 4 1 1目的 4 1 2背景 4 1 3适用范围 5 2腾讯 RTX 介绍 5 2 1体系架构 5 2 1 1系统整体架构 6 2 1 2软硬件部署 8 3软件安装 9 3 1安装所需软硬件环境 9 3 2最新版本及相关资料下载 10 3 3服务器防火墙配置 10 3 4RTX 服务器软件的安装 10 3 5RTX 客户端软件的安装 12 4RTX 二次开发 14 4 1RTX SERVER SDK 介绍 14 4 1 1RTX Server SDK 概述 14 4 1 2RTX Server SDK 主要功能 14 4 1 3RTX Server 应用体系整体架构 15 4 1 4RTX Server SDK 对象模型 16 4 2人员同步 18 4 3单点登录 18 4 4消息提醒 18 4 5状态感知 18 应用集成部应用集成部RTX 二次开发二次开发 4 19 西安美林电子有限公司西安美林电子有限公司 1 引言引言 1 11 1目的目的 RTX 应用开发可以有更加完善的资源文档 使更多的同事可以快速掌握 RTX 的应用开发 1 21 2背景背景 RTX 的应用在部门内的部分项目中都有涉及 而部门内关于 RTX 的应用开 发的知识资源并没有形成 由于在实际的项目中都已经开始进行了开发应用 所以有必要将此知识形成文档 以便其他同事可以共享资源 1 31 3适用范围适用范围 腾讯 RTX 服务器端及客户端 2009 版 2 腾讯腾讯 RTX 介绍介绍 RTX 腾讯通 是腾讯公司推出的企业级即时通信平台 RTX 的前身是 BQQ 企业 QQ RTX 平台的主要功能 包括企业内部实时信息交互 语音视频 交流 企业短信中心 自动存档主题讨论等等 RTX 平台具有很高的实用性 易用性和可管理性 除了底层采用 128 位对称加密技术之外 在实际应用中 RTX 可以通过员工实名制 记录交互信息等措施 确保企业应用的通信安全 RTX 包括服务器端和客户端软件 可在企业本地自建服务器 迅速搭建企业的 内部即时通信平台 同时 RTX 提供二次开发接口 支持第三方在 RTX 上进行 二次开发 2 12 1体系架构体系架构 从整体架构来讲 RTX 系统是一个开放的体系结构 是一个平台化 组件 应用集成部应用集成部RTX 二次开发二次开发 5 19 西安美林电子有限公司西安美林电子有限公司 化的可扩展平台 第三方厂商可以在 RTX 系统所提供 SDK API 的基础上 开发 具有即时通讯特性的应用 2 1 12 1 1系统整体架构系统整体架构 GroupServerDBServer 文件服务器 可多个 应用服务器 会话服务器 可多个 RTX ClientRTX ClientRTX Client R T X 应用 第三方应用 RTX Gateway RTX CONN1 TCP连接 UDP连接 企业 数据库 RTX2009 体系结构 License 服务器 图图 2 1 1 RTX 系统整体架构图系统整体架构图 应用集成部应用集成部RTX 二次开发二次开发 6 19 西安美林电子有限公司西安美林电子有限公司 Group Server RTX Conn1File ServerSession Server App Server 轻总线 重总线 控制总线 投票会议IPPBX 应用总线 RTX Conn2 RC RTX DB RTX GW LICENSE 图图 2 1 2 RTX 系统总线图系统总线图 应用集成部应用集成部RTX 二次开发二次开发 7 19 西安美林电子有限公司西安美林电子有限公司 AppServer ConnectSvr RTXClient 应用pbxSDKAPI TCP通通信信 数数 据据包包的的中中 转转 应应用用注注 册册和和管管理理等等 Sms ip1 port1 Start True Pbx ip1 port1 Start False GroupServer UDP通通信信 状状态态同同步步 DBServer UDP通通信信 验验证证 获获取取 用用户户资资料料 负负责责应应用用的的 注注册册管管理理 应应用用同同步步 数数据据中中转转等等 应用sms SDKAPI Sms ip1 port1 图图 2 1 3 RTX 应用服务架构图应用服务架构图 2 1 22 1 2软硬件部署软硬件部署 RTX 系统的软硬件部署 主要包括三个部分 RTX 用户工作台 安装 RTXClient RTX 服务器 安装 RTX 各类服务 数据 文件服务器 安装数据 库软件 文件系统 其中 在实际应用中 RTX 服务器与数据 文件服务器可以 根据实际情况整合为一台服务器 另外 整个系统通过应用网关 RTX Gateway 与 Internet 连接 所以 网关的服务器与应用服务器为同一 台服务器 如下图所示 应用集成部应用集成部RTX 二次开发二次开发 8 19 西安美林电子有限公司西安美林电子有限公司 图图 2 1 4 软硬件部署示意图软硬件部署示意图 3 软件安装软件安装 3 13 1安装所需软硬件环境安装所需软硬件环境 腾讯腾讯 RTX 服务端服务端 企业人数企业人数CPU内存内存硬盘剩余空间硬盘剩余空间操作系统操作系统 500 人以下人以下P4 2 0G 以上512M40G 以上 Windows2000 sp4 以 上 500 人以上人以上 双 P4 2 0G 以 上 2G80G 以上 Win2000Server sp4 以上 腾讯腾讯 RTX 客户端客户端 企业人数企业人数CPU内存内存硬盘剩余空间硬盘剩余空间操作系统操作系统 500 人以下人以下 PIII800 MHz 128M 以上500M 以上 Windows2000 sp4 以 上 500 人以上人以上 奔腾 1 2GHz 以上 256M1G 以上Win2000 WinXP 应用集成部应用集成部RTX 二次开发二次开发 9 19 西安美林电子有限公司西安美林电子有限公司 3 23 2最新版本及相关资料下载最新版本及相关资料下载 RTX 安装包及使用手册等详细资料除了从安装光盘获取外 也可以通过如下 网址下载安装或阅读 把下载的文件解压缩到本地硬盘目录中 获得 4 个文件 RTX 服务端安装文件 RTXSxxx exe RTX 客户端安装文件 RTXCxxx exe RTX 进行二次开发 请使用如下两个 SDK 开发包 RTX 服务端 SDK 开发包软件 RTXSSDKxxx exe RTX 客户端 SDK 开发包软件 RTXCSDKxxx exe 3 33 3服务器防火墙配置服务器防火墙配置 如果安装 RTX 服务器的机器上有防火墙 需要打开服务器如下端口 1 TCP 8000 登录端口 2 TCP 8003 小文件 多人会话文件传输端口 3 TCP 8880 大文件传输 语音视频端口 4 TCP 8009 客户端程序自动升级端口 5 TCP 8010 组织架构 资料照片 自定义标签等功能实现 6 TCP 8012 快速部署端口 3 43 4RTXRTX 服务器软件的安装服务器软件的安装 从 RTX 官方网站下载所有安装软件 下载完成后是一个压缩文件 打开后 找到 rtxserver2009formal exe 点击运行程序进行安装 安装过程中涉及 阅 读许可协议 输入服务与许可证 安装路径设置 安装后使用者限定 等问题 如图所示 应用集成部应用集成部RTX 二次开发二次开发 10 19 西安美林电子有限公司西安美林电子有限公司 图图 3 4 1 阅读软件许可协议阅读软件许可协议 图图 3 4 2 选择目标目录选择目标目录 应用集成部应用集成部RTX 二次开发二次开发 11 19 西安美林电子有限公司西安美林电子有限公司 图图 3 4 3 设置服务端界面语言设置服务端界面语言 确定了安装路径之后 点击安装即可完成安装 安装完成后 将会自动找到 RTX 服务管理器进行配置 以前出现超级管理 员帐号设置密码将在服务管理器里进行设置 第一次安装的默认密码为空 可 以通过重新设置管理员密码进行设置 3 53 5RTXRTX 客户端软件的安装客户端软件的安装 安装 RTXClient 之前 先完成 RTXServer 安装及完成其配置 已安装及配 置完成 RTXServer 的情况下 RTXClient 安装的步骤 获取 RTXClient 安装包 有如下方法 通过 RTXServer 进行获取 因为 RTXServer 安装包会自带 RTXClient 获取 方法 通过 TX 管理器中的快速部署的 URL 进行获取 如下图中的红色框中显 示的地方 应用集成部应用集成部RTX 二次开发二次开发 12 19 西安美林电子有限公司西安美林电子有限公司 图图 3 5 1 快速部署快速部署 在 IE 游览器中打开此 即可看到下载客户端安装包的界面 如下图 图图 3 5 2 快速部署网页快速部署网页 应用集成部应用集成部RTX 二次开发二次开发 13 19 西安美林电子有限公司西安美林电子有限公司 通过其它方式 如通过 tencent 的 RTX 官方网站 或服务中心等方式来进 行获取 运行 RTXClient 安装包里的 RTXC2009 exe 程序进行安装 按默认 下一步即可完成安装 通过以上的介绍大家基本是初步了解了 RTX 这个软件的应用及安装部署情 况 当然 RTX 本身提供了很多的配置操作 其中的一些配置会影响到二次开发 具体的配置及应用如果有兴趣可以查看下面的文档 文档中有比较详细的配置 说明 RTX管理员手册 doc 4 RTX 二次开发二次开发 4 14 1RTXRTX ServerServer SDKSDK 介绍介绍 4 1 14 1 1RTXRTX ServerServer SDKSDK 概述概述 RTX 本身提供了很发好的二次开发接口 API 第三方用户可以通过这些 API 进行自己的业务功能开发 首先要进行二次开发就必须安装 RTXRTX ServerServer SDKSDK 应用 Server SDK 提供 给用户一套自己开发应用的接口 让第三方在 RTX 上开发自己的业务功能 利 用 SDK 接口提供的 API 可以在服务器获取 RTX 现有的 c s 协议的消息类型的数 据包 从而第三方可以根据需要对数据包进行处理 开发出新的业务 如 IM 消 息监控 第三方短信网关 离线消息 用户详细资料等应用 4 1 24 1 2RTXRTX ServerServer SDKSDK 主要功能主要功能 1 抽取或发送各种消息类型数据包 2 接收 发送短信 应用集成部应用集成部RTX 二次开发二次开发 14 19 西安美林电子有限公司西安美林电子有限公司 3 关注某些用户或所有用户的状态变化 4 文件监控 5 部门 用户 权限管理 4 1 34 1 3RTXRTX ServerServer 应用体系整体架构应用体系整体架构 图图 4 1 3 1 应用体系架构图应用体系架构图 从上图中可以看出来 在 AppServer 服务后就是业务应用 而二次开发所 要做的就是业务应用的开发 下面的图就更加直观的说明了 RTX 客户端与 RTX Server 和 RTX Server SDK 之间的关系 应用集成部应用集成部RTX 二次开发二次开发 15 19 西安美林电子有限公司西安美林电子有限公司 图图 4 1 3 2 信息流动图信息流动图 4 1 44 1 4RTXRTX ServerServer SDKSDK 对象模型对象模型 图图 4 1 4 1 对象结构图对象结构图 应用集成部应用集成部RTX 二次开发二次开发 16 19 西安美林电子有限公司西安美林电子有限公司 4 1 4 14 1 4 1 根对象根对象 SDK 的对象体系中所有的其它对象都需要通过根对象来创建 根对象提供 接口 IRTXSAPIRootObj 该接口提供创建各其他对象的函数 另外还提供一些 通用的查询函数 如查询版本号 查询企业信息 查询用户状态等 4 1 4 24 1 4 2 应用对象应用对象 应用对象是最为通用的对象 短信对象 状态对象等都可以看作是应用对 象的特化 即具有某些特殊属性的应用对象 因而应用对象的属性最多 功能也最灵活 通过对属性的设置 可以使应用对象完成其它一些对象胜任的 功能 以状态对象为例 它本质上就是一个关注 Tencent RTX ChangeState 类 型消息和所有接收者的应用对象 4 1 4 34 1 4 3 消息对象消息对象 Server SDK 对应用和 RTX Server 之间传输的数据做了一个抽象 并封装 成为消息对象 消息对象包含了客户端和应用之间逻辑处理需要的信息 并将 它们封装成为消息对象的属性 4 1 4 44 1 4 4 文件监控对象文件监控对象 文件监控对象与以上几种对象有所不同 它不和 AppServer 进行通信 而 是和 FileServer 通信 在一个 FileServer 上 同一时间内只允许一个文件监 控对象存在 如果启动第二个文件监控对象 则第一个对象会被踢掉 文件监 控对象没有需要设置的属性 文件监控对象与 FileServer 之间有一条 TCP 的长连接 用于传输客户端文 件上传通知 以及信令协议传输 下载文件时 将建立新连接下载指定文件 应用集成部应用集成部RTX 二次开发二次开发 17 19 西安美林电子有限公司西安美林电子有限公司 4 1 4 54 1 4 5 用户管理部门管理以及权限管理用户管理部门管理以及权限管理 在 Server SDK 对象体系中 还提供了另一类对象 用于操作数据库 它们 不属于应用对象的类型 不需要向应用服务器注册 启动运行 这些对象是 RTXSAPIDeptManager RTXSAPIUserManager RTXSAPIRightManager 用于添 加 删除 更新数据库里的数据 它们作为根对象的属性 可以直接获取 并 进行各种操作 4 24 2开发准备工作开发准备工作 4 2 14 2 1安装目录文件配置安装目录文件配置 在需要调用 SDK 的机器上安装 Server SDK 包 如果 RTX Server 和 SDK 调 用端安装在不同服务器 需要配置 SDK 服务器 IP 地址限制规则 打开 RTX 服 务器安装目录下 SDKProperty XMLSDKProperty XML 中的 IP 限制选项 并指定合适的值 配置 文件中相关内容如下 红色标记的部分就是需要调用 SDK 的客户端 IP 以上的配置是由于 SDK 的 安装与 RTX Server 不在同一台服务器上 所以需要进行配置 如果在同一台服 务器上则不需要配置 如果 RTX Server 和 SDK 调用端安装在不同服务器 需要配置 Server SDK 安装目录下的 rtxServerApi ini 配置文件中相关内容如下 应用集成部应用集成部RTX 二次开发二次开发 18 19 西安美林电子有限公司西安美林电子有限公司 4 34 3JAVAJAVA 语言二次开发语言二次开发 RTX 的二次开发有多种语言平台的 而 JAVA 自然也在其中 RTX 提供了部 分 JAVA 语言的 RTX 操作接口 在进行应用开发的时候在需要的时候进行调用 RTX 对于 JAVA 提供了哪些接口 对于 JAVA 二次开发需要配置哪里环境 下面 就针对这些进行详细的说明 4 3 14 3 1JAVAJAVA 二次开发环境配置二次开发环境配置 如果需要 JAVA 的二次开发还需要配置以下的内容 进入 Server SDK 安装目录 默认路径 x Program Files Tencent RTXSSDK 把该目录下的 dll 文件及 rtxServerApi ini 拷贝 到系统的 System32 目录下 RTX2008Beta2 之后的 RTX 版本安装时已经自动拷 贝到该目录下 如果在网页调用 java 接口 需要另拷贝一份到 JDK 的 bin 目 录下 如果在 weblogic 或 Tomcat 下进行部署开发的话 需要将 SDK 安装目录