Sun Java System Instant Messaging 6 2004Q2 管理ガイド |
付録 C
Instant Messaging APIInstant Messaging で使用される API について説明します。
Instant Messaging API の概要Instant Messaging には、拡張モジュールや統合化モジュールの開発に役立つ Java API が各種用意されています。それらの API の詳細なマニュアルは、Javadoc によって生成された HTML ファイルとして、インストールされた Instant Messenger コンポーネントに付属しています。これらの Javadoc ファイルは、instant-messaging-resource-directory/apidocs/ ディレクトリ内にインストールされています。これらの API マニュアルを参照するには、ブラウザから imcodebase/apidocs をポイントします。ここで、codebase は、Instant Messenger リソースのコードベースを表します。
Instant Messaging API は、次のとおりです。
Instant Messaging サービス APIInstant Messaging API は、同一ホスト上またはリモートホスト上に存在するアプリケーションが、プレゼンス、会議室、通知、調査、ニュースチャネルなどといった Instant Messaging の各種サービスにアクセスする際に使用されます。
Instant Messaging サービス API を使うと、次のことが行えます。
メッセンジャ Beanメッセンジャ Bean は、動的に読み込まれるモジュールであり、その目的は、メッセンジャの機能を拡張することにあります。メッセンジャ Bean を使うと、既存の Instant Messenger ウィンドウ内にボタンやメニュー項目などのアクションリスナーを追加したり、チェックボックスやトグルボタンなどのアイテムリスナーを追加したりできます。アイテムリスナーは、エンドユーザー入力の受信時に起動されます。また、Bean 固有のアクションは、エンドユーザーの入力に基づきます。これらの Bean は、独自の設定パネルを追加したり、Bean 固有のプロパティをサーバー上に保存したりする能力を備えています。これらの Bean には、Instant Messenger が受信する任意のイベント (新しいアラートメッセージなど) を通知できます。
メッセンジャ Bean を使用したアプリケーションでは、次のことが行えます。
サービスプロバイダインタフェースサービスプロバイダインタフェース API を使うと、Instant Messaging のサーバー機能を拡張できます。サービスプロバイダインタフェースは、次の独立した API から構成されています。
アーカイブプロバイダ API
アーカイブプロバイダはソフトウェアモジュールの一種であり、通常、アーカイブシステムや監査システムとの統合化機能を提供します。特定のサーバー処理が実行されると、その処理用に設定されたアーカイブプロバイダが起動されます。
アーカイブプロバイダは、次のサーバー処理に対して起動されます。
アーカイブプロバイダ API を使用したアプリケーションとしては、次のものがあります。
- Instant Messaging アーカイブ
Instant Messaging のデフォルトの Instant Messaging アーカイブは、アーカイブプロバイダ API に基づいています。Instant Messaging アーカイブの詳細については、「Instant Messaging アーカイブの管理」を参照してください。
- リソースの使用量を制御する目的でその使用統計を記録するアプリケーション
メッセージ変換 API
メッセージコンバータは、個々のメッセージまたはその一部がサーバーを通過する際に起動されます。メッセージコンバータは、対象のメッセージ部分をまったく変更しない場合もありますし、それらのメッセージ部分を変更または削除する場合もあります。テキスト部分は、Java の String オブジェクトとして処理されます。メッセージコンバータは、それ以外の添付ファイルをバイトストリームとして処理し、処理済みのバイトストリーム (オリジナルとは異なる可能性がある) を返します。ただし、削除する必要のある添付ファイルに対しては、何も返しません。
メッセージ変換 API を使用したアプリケーションでは、次のことが行えます。
認証プロバイダ API認証プロバイダ API を使えば、Identity Server のパスワードベースまたはトークンベースの認証サービスを使用しない環境下で、Instant Messaging を配備できます。この API はエンドユーザーが認証を要求するたびに起動されます。また、この API は LDAP 認証と組み合わせて使用できます。
Identity Server によるシングルサインオン (SSO) は、認証プロバイダ API を使って実現されています。また、この API を使えば、ほかの認証システムとの統合化を図ることも可能です。