openfire插件开发

昨天说了怎么配置openfire的开发环境。今天写一点openfire的插件开发。我这里做了一个例子主要是针对于XMPP的通信。后边会说一点smack和openfire通信的实现。

 

注：这里的例子中的注释纯属个人理解。

 

在openfire的源码里有很多插件。我这里实际就是拷贝了其中的一个插件。重名了一下名字。目录结构如下：

 

 

貌似图片传不上来了。如果看不到图，就看看源码中的其他插件的例子。跟其他插件的目录结构是一样一样的。

 

在这些文件里最重要的就是plugin.xml文件。因为有这个文件openfire才认识这个插件。在这个文件里会配置插件的入口类。我这里简单写了一个plugin.xml.示例如下。

<?xml version="1.0" encoding="UTF-8"?>

<plugin>
    <class>org.yangzc.testplugin.TestPlugin</class>
    <name>test Plugin</name>
    <description>test Plugin descript</description>
    <author>yangzc</author>
    <version>1.0.0</version>
    <date>20/6/2011</date>
    <minServerVersion>3.7.0</minServerVersion>
    <databaseKey>testPlugin</databaseKey>
    <databaseVersion>0</databaseVersion>
	
    <adminconsole>
    </adminconsole>
</plugin>

 

class部分就是插件的实现类。气的名字什么的就不用说了，根据英文基本可以猜个差不多。

 

具体TestPlugin的实现。这里也有一个例子：

package org.yangzc.testplugin;

import java.io.File;

import org.dom4j.Element;
import org.jivesoftware.openfire.IQHandlerInfo;
import org.jivesoftware.openfire.XMPPServer;
import org.jivesoftware.openfire.auth.UnauthorizedException;
import org.jivesoftware.openfire.container.Plugin;
import org.jivesoftware.openfire.container.PluginManager;
import org.jivesoftware.openfire.handler.IQHandler;
import org.xmpp.packet.IQ;
import org.xmpp.packet.PacketError;

public class TestPlugin implements Plugin{

	@Override
	public void destroyPlugin() {
	}

	@Override
	public void initializePlugin(PluginManager manager, File pluginDirectory) {
		XMPPServer service = XMPPServer.getInstance();
		service.getIQRouter().addHandler(new MyIQHandler());
	}

	class MyIQHandler extends IQHandler{

		public static final String moduleName = "testPlugin";
		
		private IQHandlerInfo info;
		public MyIQHandler(){
			super(moduleName);
			info = new IQHandlerInfo("group", "com:im:group");//设置监听的命名空间
		}
		
		@Override
		public IQHandlerInfo getInfo() {
			return info;//取得指定监听命名空间的IQHandeler
		}

		@Override
		public IQ handleIQ(IQ packet) throws UnauthorizedException {
			IQ reply = IQ.createResultIQ(packet);
			Element groups = packet.getChildElement();//取得客户端发送过来的xml
			
			if (!IQ.Type.get.equals(packet.getType())){
				System.out.println("非法的请求类型");
				reply.setChildElement(groups.createCopy());
				reply.setError(PacketError.Condition.bad_request);
				return reply;
			}

			//String userName = StringUtils.substringBefore(packet.getFrom().toString(),"@");
			//GroupManager.getInstance().initElement(groups,userName);
			//reply.setChildElement(groups.createCopy());//2
			//System.out.println("返回的最终XML" reply.toXML());
			return reply;
		}
		
	}
}

 

在这个实现类中需要实现接口plugin。这个接口包含两个方法。一个是初始化插件，一个是销毁插件动作。

这个例子里在初始化插件的时候通过service添加了一个监听。这里我理解为监听。这个监听可以监听指定命名空间的消息。这个例子里代码很简单。

 

 

明天写点smack和openfire通信的例子。敬请期待...

<!--EndFragment-->

评论

2 楼 bluky999 2011-08-19  

LZ的这个好像也只是其他文章的转述，哈哈，没有太大差别；

@LS  ant编译部署插件比较麻烦； 不过个人建议你把写好的插件，从src的上次目录拷贝到openfire_src的src/plugins目录下，然后在openfire_src里执行 ant plugins ，即可编译出来插件来；之后从target目录找到插件的JAR，部署到运行openfire的plugins里即可。

1 楼 yourancao520 2011-07-05  

你好，请问自己写的插件如何打包呢？我最近也是在写openfire插件，但是关于打包不是很会。网上说用install4j.但是我用install4j打包老是出问题。