Sun Java System Instant Messaging 7.2 管理指南

附錄 D Instant Messaging API

本章在以下章節中說明 Instant Messaging 使用的 API:

Instant Messaging API 簡介

Instant Messaging 所提供的 Java API 可以用來開發延伸或整合模組。安裝的 Instant Messenger 元件均有提供這些 API 的詳細文件,檔案形式為 Javadocs 產生的 HTML 檔案。Javadoc 檔案安裝於 im-svr-base/html/apidocs/ 目錄。若要檢視 API 文件,將瀏覽器指向 codebase/apidocs,其中 codebase 為 Instant Messenger 資源代碼庫。

以下為 Instant Messaging API:

Instant Messaging 服務 API

位於相同主機或遠端主機中的應用程式會使用 Instant Messaging API 來存取 Instant Messaging 服務,例如「線上狀態」、「會議」、「通知」、「輪詢」和「新聞」通道。

Instant Messaging 服務 API 可用於:

Messenger Bean

Messenger Bean 是一種動態載入模組,用於延伸 Instant Messenger 功能。Messenger Bean 會新增動作偵聽程式 (例如按鈕、功能表項目) 和項目偵聽程式 (例如現有 Instant Messenger 視窗中的核取方塊和切換按鈕)。當收到一般使用者輸入,且 Bean 特定的動作是根據一般使用者的輸入,則會呼叫項目偵聽程式。Bean 能夠新增自己的設定面板,並將 Bean 特定特性儲存在伺服器上。Instant Messenger 收到任何事件 (例如新警示訊息),Bean 都會得到通知。

使用 Messenger Bean 的應用程式包括以下功能:

服務提供者介面

服務提供者介面 API 提供了延伸 Instant Messaging 伺服器功能的能力。服務提供者介面包含以下獨立 API:

歸檔提供者 API

「歸檔提供者」是一個軟體模組,通常提供與歸檔或稽核系統的整合。每個配置的「歸檔提供者」會在每個伺服器程序中啟動。

「歸檔提供者」會在下列的伺服器程序中呼叫:

使用歸檔提供者 API 的應用程式如下:

訊息轉換 API

可以在每個訊息或每個經歷伺服器的訊息部份中呼叫「訊息轉換程式」。「訊息轉換程式」可能會將訊息部份保留不變,或修改或移除訊息部份。文字部分會視為 Java 字串物件予以處理。「訊息轉換程式」會將其他附件以位元組流的形式處理,並傳回潛在不同的位元組流。如果附件已刪除的話,則不傳回任何資料。

使用 Message Conversion API 的應用程式包括以下功能:

認證提供者 API

認證提供者 API 能夠在不使用 Access Manager 密碼式或記號式認證服務的環境中部署 Instant Messaging。只要一般使用者請求認證,便會呼叫此 API,此 API 可與 LDAP 認證結合使用

使用認證提供者 API 執行透過 Access Manager 進行的單次登入(SSO)。此 API 也可用於與其他認證系統整合。