sparkplug开发人员指南

《sparkplug开发人员指南》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Sparkplug开发人员指南Sparkplugs是什么？Sparkplugs动态扩展Spark即时通讯客户端。使用Sparkplugs定制Spark，为您的企业或组织开发即时通讯系统，我们希望通过插件的API的描述，让你在开发灵活的Spark客户端变得更加简单，并充满使用乐趣。本指南提供了SparkAPI和几种常见的例子，如果想更深入的了解请直接转到Javadocs文档中。我编译了它（Spark），然后呢？当你编译了超酷的Sparkplug后，就可以很容易的发布给用户，只要将你开发的插件拖到Spark的插件安装路径下，如果你的Sparkplug是普遍有用的，我们希望您能将你

2、的插件分享到Spark社区，将你的Sparkplug插件发送到plugins@jivesoftware.org中，建立jivesoftware.org公共信息库内容本文件包含以下信息：²Spark客户端概述²SparkplugAPI概述²Sparkplug的Java文档²插件结构²准备开始写你的第一个插件²Spark例子和使用方法。在开发Spark的例子和常见的问题。Spark客户端概述Spark客户端的设计理念是让不同层次的用户熟悉和使用它，无论是Workspace还是ChatRoom，都可以根据您的需要访问它。第19页共19页第19页共19页SparkAPI概述Spark

3、API提供了一个用于添加之上的协议和/或客户端UISpark扩展框架。例如，你可以写自己的消息过滤器或添加一个按钮，一个聊天室和使用文件传输的API实现传送文件。SparkAPI具有以下特征：²通过事件监听器拦截，得到通知，并响应特定事件IM的自定义代码。允许定制用户界面，从简单的图标更改，添加按钮，以及添加自己的菜单项。²能够使用SMACKAPI添加自己的XMPP协议的功能。²管理器(Managers)：Spark客户端为开发插件提供延迟加载的接口。相关的管理器的有：nSparkManager—SparkManager的核心管理模块器。你可以使用这个管理器来获得ChatMa

4、nager，SessionManager，SoundManager和UserManager实例。nChatManager—负责处理最登记聊天听众和过滤器，以及聊天室的创建和检索。它也可以用来检索ChatFrame用户界面。nSessionManager--包含有关当前会话信息，如连接到服务器，连接的错误和个人存在变动的通知处理。nSoundManager--用于播放声音。²事件处理(EventHandlers)：Spark包含了大量的监听和处理程序，以便把更多插件可以嵌入到Sparkclient。比较常见的监听和处理程序有：nChatRoomListener（和ChatRoo

5、mListenerAdapter）-第19页共19页允许的插件监听聊天室被打开，关闭和启动。通常你会使用这个自定义的个人聊天室。nMessageListener--消息接收或发送监听器nContactGroupListener--联络组变动监听器。nContactListListener--联系人列表变动监听器。nFileTransferListener--拦截文件传输监听器。nContextMenuListener--右键弹出菜单（上下文菜单）监听器，允许添加、删除动作或添加删除菜单项。nPresenceListener–人员状态变化监听器。nContactItemHand

6、ler–ContactItem在线状态变化控制监听。²组件(Components)：Spark包含了需要在你开发插件时使用的Swing组件，较为常用的有：nMainWindow--该框架包含联系人列表。您可以使用MainWindow添加新的标签，菜单项或焦点控件。nChatRoom–聊天室基础的抽象类。它的实现是ChatRoomImpl和GroupChatRoom。nChatArea–为TranscriptWindow和ChatInputEditor的基本聊天视图控件。nContactList–Spark的联系人列表界面控件nChatRoomButton–聊天室的外观按钮，用

7、于适应聊天室的主题。Plugin的结构Plugins是JAR的压缩文件，插件的文件结构如下：PluginStructure（压缩包机构）myplugin.jar!/

8、-plugin.xml<-Plugin定义文件

9、-libs/<-运行插件（Plugin）所用到的类.plugin.xml文件中指定的主要Plugin类。样例文件如下所示：plugin.xml样例