openfire 插件开发例子
2019獨(dú)角獸企業(yè)重金招聘Python工程師標(biāo)準(zhǔn)>>>
? ? 好久都沒(méi)有寫(xiě)東西了。今天總結(jié)一下之前開(kāi)發(fā)的一些openfire插件。
? ? 這次的插件需要提供一個(gè)HTTP的接口。通過(guò)HTTP來(lái)對(duì)openfire做一些操作。
? ? 插件的目錄結(jié)構(gòu):項(xiàng)目名稱“exampleplugin"
src/main/javaorg/jivesoftware/openfire/plugin/ExamplePlugin.javaorg/jivesoftware/openfire/plugin/example/ExampleServlet.java src/main/resourceslogo_large.giflogo_small.gifplugin.xml webimages/WEB-INF/web-custom.xml
ExamplePlugin.java 實(shí)現(xiàn)了openfire Plugin接口。它提供了一個(gè)handle方法。我們的主要邏輯代碼在這個(gè)方法里面實(shí)現(xiàn):
package org.jivesoftware.openfire.plugin;import java.io.File; import java.io.IOException; import java.io.PrintWriter;import org.jivesoftware.openfire.SessionManager; 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.slf4j.Logger; import org.slf4j.LoggerFactory;public class ExamplePlugin implements Plugin{private static final long serialVersionUID = 4609828712383867663L;private static final Logger log = LoggerFactory.getLogger(ExamplePlugin.class);private XMPPServer server = null;@Overridepublic void destroyPlugin() {server = null;}@Overridepublic void initializePlugin(PluginManager arg0, File arg1) {log.info("enter--initializePlugin");server = XMPPServer.getInstance();log.info("exit---initializePlugin");}public String handle(String input) {//your logic code} }ExampleServlet.java 實(shí)現(xiàn)了HttpServlet。它的主要功能是提供HTTP接口,通過(guò)HTTP接口來(lái)操作ExamplePlugin類(lèi)中的handle方法。 package org.jivesoftware.openfire.plugin.example;import java.io.IOException; import java.io.PrintWriter;import javax.servlet.ServletConfig; import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse;import org.jivesoftware.admin.AuthCheckFilter; import org.jivesoftware.openfire.XMPPServer; import org.jivesoftware.openfire.plugin.ExamplePlugin; import org.jivesoftware.openfire.user.UserAlreadyExistsException; import org.jivesoftware.openfire.user.UserNotFoundException; import org.jivesoftware.util.Log; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.xmpp.packet.JID;public class ExampleServlet extends HttpServlet {private static final long serialVersionUID = 5815016363356541081L;private static final Logger log = LoggerFactory.getLogger(ExampleServlet.class);private ExamplePlugin plugin;@Overridepublic void init(ServletConfig servletConfig) throws ServletException {super.init(servletConfig);plugin = (ExamplePlugin) XMPPServer.getInstance().getPluginManager().getPlugin("exampleplugin");AuthCheckFilter.addExclude("exampleplugin/exampleplugin");}@Overrideprotected void doGet(HttpServletRequest request,HttpServletResponse response) throws ServletException, IOException {PrintWriter out = response.getWriter();try {String input = request.getParameter("input");plugin.handle(input);} catch (Exception e) {replyError(e.toString(), response, out);}}private void replyError(String error, HttpServletResponse response,PrintWriter out) {response.setContentType("text/xml");out.println("<error>" + error + "</error>");out.flush();}@Overrideprotected void doPost(HttpServletRequest request,HttpServletResponse response) throws ServletException, IOException {doGet(request, response);}@Overridepublic void destroy() {super.destroy();AuthCheckFilter.removeExclude("exampleplugin/exampleplugin");} }
plugin.xml描述了插件的信息: <?xml version="1.0" encoding="UTF-8"?><plugin><class>org.jivesoftware.openfire.plugin.ExamplePlugin</class><name>Example</name><description>Example</description><author>ilxlf</author><version>1.0.0</version><date>06/05/2012</date><minServerVersion>3.7.1</minServerVersion> </plugin>
web-custom.xml描述了ExampleServlet的一些信息: <?xml version='1.0' encoding='ISO-8859-1'?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd"> <web-app><!-- Servlets --><servlet><servlet-name>ExampleServlet</servlet-name><servlet-class>org.jivesoftware.openfire.plugin.example.ExampleServlet</servlet-class></servlet><!-- Servlet mappings --><servlet-mapping><servlet-name>ExampleServlet</servlet-name><url-pattern>/exampleplugin</url-pattern></servlet-mapping></web-app>
項(xiàng)目的名稱叫: ”exampleplugin"
這個(gè)項(xiàng)目用gradle來(lái)提供編譯,打包。這里就不寫(xiě)了。
編譯的結(jié)果是一個(gè)exampleplugin.jar。 openfire安裝目錄下面有一個(gè)plugins目錄。把這個(gè)jar包拷貝到該目錄下就可以了。
然后我們就可以在openfire admin console界面 plugin標(biāo)簽頁(yè)里面看到我們這個(gè)插件了。
HTTP的對(duì)外接口就是:
http://your_openfire_ip:9090/plugins/exampleplugin/exampleplugin/test_input
?
?
?
?
?
?
?
轉(zhuǎn)載于:https://my.oschina.net/u/145002/blog/60617
總結(jié)
以上是生活随笔為你收集整理的openfire 插件开发例子的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 用HTML代码实现个人简历的编写
- 下一篇: TP5: 日志记录改造——4