声明:只是一个菜鸟的学习笔记,以供日后使用
开发openfire插件其实很简单,在openfire/documentation/docs/index.html的这个页面中也有详细的Plugin Develper Guide 插件开发指南。
一、开发插件的目的
在实际需求中,可能会需要一些openfire本身没有提供的功能,比如没有QQ或者MSN的个性签名。如果需要为openfire用户提供个性签名,目前所知有两种做法:第一种修改openfire源码,继承BasicModule或者实现Module,然后在XMPPServer的loadModules方法中启动自定义的Module;第二种做法那当然是插件做法,这样既方便同事之间的合作,又方便以后的openfire升级。
二、插件的目录结构
PluginDir
| -- plugin.xml 必不可少
| -- classes 用于存放class文件,跟lib是互为可选
| -- lib 跟lib是互为可选
| -- web 可选
| -- database可选
| -- i18n可选
lib存放你的插件用到的一些jar文件。你可以把自己的class文件打包成jar文件放在lib目录下,这时也就没有必要有classes文件夹了。lib文件夹可以没有,但此时必须要有classes文件夹。
web文件夹下目录结构必须与正常的web应用有一样的结构。
Database下存放的是*.sql文件,而且sql文件名的格式必须是PluginName_DBtype.sql。pluginName就是你的插件名称,与上文的pluginDir名字一样。
其实也可以在plugin.xml文件中的databaseKey配置它,配置后就可以为databaseKey_DBtype.sql。DBtype则是数据库的类型,比如mysql,oracle,db2,sqlserver,postgresql,hsqldb和sysbse。一般情况下,我们只需布置一个sql文件。如果你想让你的插件能够适用多种数据库,那应该编写多个文件,毕竟各种数据库间的sql写法还是多少有点区别,而且openfire会判断你配置的数据库类型选择合适的sql文件。
i18n 下存放的是国际化资源和一些硬性配置的properties文件。
当然该目录下还可以放其他的乱七八糟的东西,但是openfire加载插件时是不会理会的。
三、 plugin.xml配置文件的结构
该文件只是配置一些openfire加载该插件时必须的东西,所以也不用写什么dtd或者shema,只要是份良好有效的xml文档就行。Openfire使用SAXReader来解析该文件。
简单示例:
<?xml version="1.0" encoding="UTF-8"?>
<plugin>
<!-- Main plugin class -->
<class>org.example.ExamplePlugin</class><!—- 必须 -->
<!-- Plugin meta-data -->
<name>Example Plugin</name> <! –- 可选 -->
<description>This is an example plugin.</description><! –- 可选 -->
<author>Jive Software</author><! –- 可选 -->
<version>1.0</version><! –- 可选 -->
<date>07/01/2006</date><! –- 可选 -->
<url>http://www.igniterealtime.org/projects/openfire/plugins.jsp</url>
<minServerVersion>3.0.0</minServerVersion><! –- 可选 -->
<licenseType>gpl</licenseType><! –- 可选 -->
< parentPlugin/><! –- 设置父插件,其实就是共用该插件的classLoader,有点类似类的继承,所以子插件可以使用父插件中的任何class -->
<!-- Admin console entries -->
<adminconsole><! –- 可选 -->
<!-- More on this below -->
</adminconsole>
</plugin>
class定义的是插件的入口,必须实现org.jivesofware.openfire.container.Plugin接口。
minServerVersion 则是你的插件要求openfire的最低版本
四、管理控制台添加页面
如果你的插件需要在控制台配置,则可以修改 the Admin Console。看下文档就应该很容易做到了。你也许发现了,当你登陆http://localhost:9090/后会发现它使用了jsp页面,你可能会认为openfire也是一个web服务器,能够处理http请求,能够解析jsp页面?其实不是的,openfire中要使用的jsp页面事先已经使用jsper-compile.jar编译好了,并且把编译成的servlet配置在web.xml中。运行时根据请求的路径来实例化那些servlet,再调用service方法,处理http请求。
你自己的插件如果有jsp页面也可以把jsp页面先编译好,放到classes根目录下。 或者打包成jar文件放到lib下。Openfire源码提供了的build文件,可以帮助你自动打
包,并且自动帮你在web.xml文件中映射这些servlet。
五、实现自己的插件plugin类
你的plugin可以走四条路:
1. 拦截器方式,在你的插件中添加包拦截器,在拦截器中实现你的功能。通过InterceptorManager.getInstance().addInterceptor()添加。
2. component方式,在插件中添加component。通过ComponentManager.getInstance().addComponent()添加。
3. Handler方式,通过XMPPServer.getInstance().getIQRouter().addHandler(yourHandler);
4. PropertyEventListener方式:通过
PropertyEventDispatcher.addListener(yourPropertyEventListner)添加。
简单拦截器方式示例:
public class ArtWeaverPlugin implements Plugin
{
private PacketInterceptor ic = null;
@Override
public void initializePlugin(PluginManager pluginManager, File pluginDirectory)
{
ic = new PresenceSignatureInterceptor();
InterceptorManager.getInstance().addInterceptor(ic);
}
@Override
public void destroyPlugin()
{
if(ic != null)
{
InterceptorManager.getInstance().removeInterceptor(ic);
}
}
private class PresenceSignatureInterceptor implements PacketInterceptor
{
@Override
public void interceptPacket(Packet packet, Session session,
boolean incoming, boolean processed) throws PacketRejectedException
{
if(!processed && packet instanceof Presence && incoming)
{
//在这添加你自己的对packet的处理
}
}
}
六、最后打包成jar或者war文件
示例使用ant:
<target name = "release" depends="init,clean">
<jar destfile="${target.plugin}/artweaver.jar"
basedir="work">
</jar>
<antcall target="clean-all"></antcall>
<antcall target = "copy2openfire"/>
<antcall target = "copyAll2openfirePlugin"/>
</target>
解释一下:先把classes、plugin.xml、lib等一些东西copy到work文件夹下,jar后删掉work目录。然后把做好的jar文件copy到openfire的目录下。如果你的openfire是启动的开发模式,则openfire会马上把你插件解压,然后马上启动,不用重启服务器就能测试你的plugin了。
打完收工!!!^_^