附录 D Instant Messaging API

本章在以下各节中说明 Instant Messaging 使用的 API：

• Instant Messaging API 概述

• Instant Messaging 服务 API

• Messenger Bean

• 服务提供者接口

Instant Messaging API 概述

Instant Messaging 提供可以用来开发扩展或集成模块的 Java API。这些 API 的详细文档以 Javadocs 生成的 HTML 文件格式随安装的 Instant Messenger 组件提供。Javadoc 文件安装在 im-svr-base/html/apidocs/ 目录中。要查看 API 文档，可将浏览器指向 codebase/apidocs，其中 codebase 是 Instant Messenger 资源代码库。

以下是 Instant Messaging API：

• Instant Messaging 服务 API

• Messenger Bean

• 服务提供者接口

Instant Messaging 服务 API

Instant Messaging API 供位于同一主机或远程主机中的应用程序使用，以访问 Instant Messaging 服务，如“在线状态”、“会议”、“通知”、“轮询”和“新闻频道”。

Instant Messaging 服务 API 可用于：

• 基于 Java 或基于 Web 的客户机，例如门户通道。

• 启用另一类客户机的网桥或网关。

• 将 Instant Messenger 和 Presence 集成到现有的应用程序。

• 将新内容显示为 Instant Messenger 新闻。

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

“归档提供者”是一个软件模块，通常提供与归档或审计系统的集成。每个服务器进程均分别调用各自配置的“归档提供者”。

以下服务器进程可调用“归档提供者”：

• 当发送即时消息时，如警报、轮询、聊天、新闻或会议消息时。

• 验证事件（例如登录或注销）时。

• 在线状态发生变化时。

• 订阅事件时。例如，有人加入或离开会议、订阅或取消订阅新闻频道时。

使用“归档提供者 API”的应用程序如下：

• Instant Messaging 归档

  Instant Messaging 中默认的 Instant Messaging 归档基于“归档提供者 API”。有关 Instant Messaging 归档的更多信息，参见第 18 章，管理 Instant Messaging 的归档。

• 为调整大小而记录使用统计资料的应用程序

消息转换 API

“消息转换器”将被调用以用于通过服务器的每条消息或每个消息部分。“消息转换器”可能将消息部分完整保留，也可能会修改或删除消息部分。文本部分作为“Java 字符串对象”处理。“消息转换器”将其他附件作为字节流处理，并返回可能不同的字节流；如果要删除附件，则不返回任何内容。

使用“消息转换 API”的应用程序包括：

• 病毒检查和清除

• 转换引擎集成

• 消息内容过滤

验证提供者 API

“验证提供者 API”提供在不使用基于 Access Manager 密码或令牌的验证服务环境中部署 Instant Messaging 的能力。当最终用户请求验证时会调用此 API，并且它可以与 LDAP 验证结合使用。

通过 Access Manager 进行单点登录 (SSO) 可使用“验证提供者 API”执行。此 API 还可用于与其他验证系统的集成。