《Sparkplugin开发人员指南》由会员分享，可在线阅读，更多相关《Sparkplugin开发人员指南（19页珍藏版）》请在金锄头文库上搜索。
1、Sparkplug 开发人员指南Sparkplugs 是什么？Sparkplugs动态扩展Spark即时通讯客户端。使用Sparkplugs定制Spark，为您的企业或组 织开发即时通讯系统，我们希望通过插件的API的描述，让你在开发灵活的Spark客户端变 得更加简单，并充满使用乐趣。本指南提供了 SparkAPI和几种常见的例子，如果想更深入的了解请直接转到Javadocs文档 中。我编译了它（Spark），然后呢？当你编译了超酷的 Sparkplug 后，就可以很容易的发布给用户，只要将你开发的插件拖到 Spark 的插件安装路径下，如果你的 Sparkplug 是普遍有用的，我们希望您
2、能将你的插件分 享 到 Spark 社 区 ， 将 你 的 Sparkplug 插 件 发 送 到 pluginsjivesoftware.org 中 ， 建 立 jivesoftware.org 公共信息库内容本文件包含以下信息： Spark客户端概述 Sparkplug API 概述 Sparkplug 的 Java 文档 插件结构 准备开始写你的第一个插件 Spark例子和使用方法。在开发Spark的例子和常见的问题。Spark 客户端概述Spark 客户端的设计理念是让不同层次的用户熟悉和使 用它，无论是 Workspace 还是 ChatRoom，都可以根据您的需要访问它。匚剖启 M
3、att Tucker - ConversationChatFrameMatt TuckerChatContainerToolBarSend FileTranscript WindowEditorBarYo, reporting?Sendha t Inpu tEdi torBet tomPanel3Profile ConferenceorxSpark API 概述Spark API提供了一个用于添加之上的协议和/或客户端UI Spark扩展框架。例如，你可以写 自己的消息过滤器或添加一个按钮，一个聊天室和使用文件传输的API实现传送文件。Spark API 具有以下特征： 通过事件监听器拦截，得
4、到通知，并响应特定事件IM的自定义代码。 允许定制用户界面，从简单的图标更改，添加按钮，以及添加自己的菜单项。 能够使用SMACK API添加自己的XMPP协议的功能。 管理器(Managers): Spark客户端为开发插件提供延迟加载的接口。相关的管理器的有: SparkManagerSparkManager的核心管理模块器。你可以使用这个管理器来获得 ChatManager, SessionManager, SoundManager 和 UserManager 实例。 ChatManager负责处理大多数聊天Chat监听器和过滤器的注册，以及聊天室的 创建和检索。它也可以用来检索Chat
5、Frame用户界面。 SessionManager -包含有关当前会话信息，如连接到服务器，连接的错误和个人 存在(presence)变动的通知处理。 SoundManager -用于播放声音。 事件处理 (Event Handlers): Spark 包含了大量的监听和处理程序，以便把更多插件可以 嵌入到Spark client。比较常见的监听和处理程序有： ChatRoomListener (和 ChatRoomListenerAdapter)-允许的插件监听聊天室被打开， 关闭和启动。通常你会使用这个自定义的个人聊天室。 MessageListener -消息接收或发送监听器 Conta
6、ctGroupListener -联络组变动监听器。 ContactListListener -联系人列表变动监听器。 FileTransferListener -拦截文件传输监听器。 ContextMenuListener -右键弹出菜单（上下文菜单）监听器，允许添加、删除动作 或添加删除菜单项。 PresenceListener -人员状态变化监听器。 ContactltemHandler - Contactitem 在线状态变化控制监听。组件（Components）: Spark包含了需要在你开发插件时使用的Swing组件，较为常用的有： MainWindow -该框架包含联系人列表。您
7、可以使用 MainWindow 添加新的标签， 菜单项或焦点控件。 ChatRoom -聊天室基础的抽象类。它的实现是ChatRoomImpI和GroupChatRoom。 ChatArea 一为 TranscriptWindow 和 ChatInputEditor 的基本聊天视图控件。 ContactList -Spark的联系人列表界面控件 ChatRoomButton -聊天室的外观按钮，用于适应聊天室的主题。Plugin 的结构Plugins是JAR的压缩文件，插件的文件结构如下：Plugin Structure （压缩包机构）myplugin.jar!/I- plugin.xml -
8、 Plugin 定义文件|- libs/-运行插件（Plugin）所用到的类.plugin.xml文件中扌旨定的主要 Plugin 类。样例文件如下所示：plugin.xml 样例Google Desktop Plugin vclasscom.examples.plugins.GooglePluginv/class vauthorDerek DeMorov/author1.0Enables users to find files and emails relating to users using Google Desktop technology.v/v/email vminSparkVer
9、sion2.0.6v/minSparkVersion v/pluginPlugin的安装你只需要将要安装的插件JAR拖放到你的Spark客户端安装插件目录中。目录机构Spark/|- plugins/-将你的SparkPlug插件放到这里。|- lib/-运行你的插件需要的类和类库。|- resources/-资源文件夹，包括其他支持文档和类库.|- docs/-你自己的开发插件的帮助手册和的JavaDoc.你的插件类必须实现从Spark客户端API插件接口。该插件接口是用于初始化和关闭插件的 方法。开始编写 Sparkplugs为了建立自己的SparkPlugs，你需要将工程属性中的所有项目
10、设置到ClassPath中，将Sparkplug.zip 或 Sparplug.tar.gz 解压缩，你将看到以下内容：Sparkplugs/|- build/-使用ANT让你轻松的构建你的插件。|- images/-文档使用的图像文件夹。|- plugin_development_guide.htm-完整的开发指南（本文档）。|- api/-Sparkplug 包含的 Javadoc 文档。|- spark/-spark构建结构，你需要设置Classpatho|-bin-启动文件startup.bat，用于测试Spark。|-lib-包含所有Spark运行需要的包。|-logs-所有的日志存
11、储。|-plugins-所有的插件（plugins）部署到这里。|-resources-包含用于运行在具体操作系统上的本机库。要设置一个Spark项目，运行在你的IDE,您将需要以下几件事： 编译Spark，需要1.4以上版本的JRE； 将 Sparkplugs/spark/lib 和 Sparkplugs/spark/lib/windows 文件夹添加到 Classpath； 添加资源目录(Sparkplugins/spark/resource)到本地 Classpath 中； Main Class - org.jivesoftware.Spark ； VM参数-Dplugin=path_t
12、o_your_plugin.xml文件，这使您的插件可以运行在IDE以外的 环境中； 就这些。我们提供了可以轻松的构建、部署你的插件到你的的Spark测试环境中。在使用时Building a SparkplugTo easily build a Sparkplug, we have added a simple ANT script to create a deployed plug. To create, do the following:1) Copy your java source files to the src directory.2) Place any dependencies
13、 (besides Spark) into the lib directory.3) Update the plugin.xml file to represent your plugin.4) Go to the build directory, and type ant jar to build your plugin or. type ant run to build and deploy your plugin directly to Spark and have Spark startup to test your plugin right away.Your new plugin
14、will be called myplugin.jar.If you wish to deploy your plugin later, just copy your new myplugin.jar to the plugins directory of your Sparkplug distro kit.Enjoy!Spark 是如何做的呢？所有代码示例可以在 examples.jar 文件找到。如何创建一个简单的插件 如何将我自己的标签到Spark工作空间 如何添加一个上下文菜单监听到联系人列表 如何添加 ContextMenu 监听到一个聊天室 如何添加菜单到 Spark 如何添加一个按钮到聊天室 如何添加自己喜欢的 Spark 搜索，比如用户搜索或谷歌搜索在 Firefox 怎么能拦截文件传输请求 如何发送一个文件给其他用户 如何控制用户界面和事件的 ContactItem 处理 Spark 发生变化时，怎么能通知用户更改时 如何添加消息筛选器 如何创建一个人对人的聊天室 如何创建一个公共会议室 如何添加自己的首选项 当有新消息是如果进行消息提示如何创建一个简单的插件1. 实现 PluginPlugin样例 package org
