RTXServer SDK Java語言支持文檔

1、RTX Server SDK Java 語言開發(fā)指導語言開發(fā)指導目目 錄錄RTX Server SDK Java 語言開發(fā)指導 .1一、功能說明.2二、配置環(huán)境.2三、文件說明.3四、開發(fā)向導(以 Eclipse 為例).3五、接口說明.51系統(tǒng)函數.52擴展函數.7六、RTX2010 與 RTX3.61 Java 語言支持的差異 .11七、BUG 解決 .12一、功能說明一、功能說明RTX2010 Java SDK 可以實現以下五大功能：1 部門用戶管理(數據同步)，可以對 RTX 服務器的部門及用戶進行操作，通過該操作可以實現從其他系統(tǒng)同步用戶數據到 RTX 服務器。2 單點登錄，登錄 O

2、A 或 ERP 時 RTX 客戶端自動登錄，不需要輸入密碼。3 待辦事宜提醒,辦公提醒，郵件到達提醒、公文到達提醒等。4 手機短信，向手機發(fā)送、接收短信，群發(fā)短信。5 狀態(tài)推送，在網頁上顯示用戶狀態(tài)頭像，并可以對在線用戶發(fā)起會話。二、配置環(huán)境二、配置環(huán)境1 在開發(fā)機器安裝 RTX2010 Server SDK 包。2 進入 Server SDK 安裝目錄(默認路徑：x:Program FilesTencentRTXSSDK)，把該目錄下的 dll 文件及 rtxServerApi.ini 拷貝到系統(tǒng)的 System32 目錄下（RTX2008Beta2 之后的 RTX 版本安裝時已經自動拷貝到

3、該目錄下），如果在網頁調用 java 接口，需要另拷貝一份到 JDK 的 bin 目錄下。3 進入 RTX 服務器安裝目錄下，用記事本打開 SDKPorperty.xml 文件，在里面增加開發(fā)機器地址(如下圖所示)，保存后重啟 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 服務器。四、開發(fā)向導四、開發(fā)向導(以以 Eclipse 為例為例)1.啟動Eclipse ，創(chuàng)建一個空白的 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系統(tǒng)函數系統(tǒng)函數語法：boolean Init()功能：初始化類參數：無調用：Init()說明：初始化 RTXSvrApi，成功返回 true，失敗返回 false語法：void UnInit()功能：析構類參數：無調用：Init()說

7、明：析構 RTXSvrApi語法：int GetNewObject(String szObjectName)功能：獲取一個業(yè)務對象句柄參數：szObjectName 業(yè)務對象名稱調用：GetNewObject(OBJNAME_RTXSYS)說明：調用成功返回一個業(yè)務對象句柄語法：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 業(yè)務對象句柄，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)功能：發(fā)送消息提醒 參數：receivers 接收者、title 標題、msg 信息內容、type 消息類型、delayTime 顯示時間調用：sendNotify (“herolin”,”公司公文”,”xx 同事升級 xx 部門總經理”,”0”,”0”)說明：成功返

25、回 0，失敗返回其他。/發(fā)送短信語法：int sendSms(String sender, String receiver, String smsInfo,int autoCut, int noTitle)功能：發(fā)送手機短信 參數：sender 發(fā)送者、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。/查看用戶在線狀態(tài)語法：int QueryUserState(String UserName)功能：查看用戶狀態(tài)參數：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 帶有 “；”，主要用于區(qū)分多個部門 ID。2 RTX 2010 Server 強加了 SDK 訪問安性,因此通過 http 方式訪問 cgi