openfire中开发带servlet的插件并实现免认证访问

本文实现一个带servlet的openfire 插件。

1、目录结构

2、servlet文件

   HelloServlet.java中实现如下：

package com.landsem.plugin.helloworld;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.jivesoftware.admin.AuthCheckFilter;

public class HelloServlet extends HttpServlet {
	private static final String SERVICE_NAME = "hello/hello";//用于免验证直接访问该servlet,<span style="background-color: rgb(255, 255, 255);">插件名称+servlet地址(web-custom.xml中对应servlet-mapping的url-pattern)的写法</span>

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		// TODO Auto-generated method stub
	//	super.doGet(req, resp);
		resp.setContentType("text/plain");
		PrintWriter out = resp.getWriter();
		System.out.println("HelloServlet GET Method");
		out.print("HelloServlet GET Method");
		out.flush();
	}

	@Override
	protected void doPost(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException {
		// TODO Auto-generated method stub
	//	super.doPost(req, resp);
		resp.setContentType("text/plain");
        PrintWriter out = resp.getWriter();
        System.out.println("HelloServlet GET Method");
        out.print("HelloServlet POST Method");
        out.flush();		
	}

	@Override
	public void init() throws ServletException {
		// TODO Auto-generated method stub
		super.init();
		AuthCheckFilter.addExclude(SERVICE_NAME);//用于免验证直接访问该servlet
	}

	@Override
	public void destroy() {
		AuthCheckFilter.removeExclude(SERVICE_NAME);//用于免验证直接访问该servlet
		// TODO Auto-generated method stub
		super.destroy();
	}

}

3、web-custom.xml

在其中配置对应servlet映射信息。这个文件相当于普通web工程的web.xml。Servlet的配置 url必须全部小写。有一个大写字母则找不到 对象的servlet。

<?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>

    <servlet>
        <servlet-class>com.landsem.plugin.helloworld.HelloServlet</servlet-class>
        <servlet-name>HelloServlet</servlet-name>
    </servlet>
   
    <servlet-mapping>
        <servlet-name>HelloServlet</servlet-name>
        <url-pattern>/hello</url-pattern>
    </servlet-mapping>

</web-app>

4、plugin.xml

配置JSP页面显示位置。item标签中的id是自己定义的，要保证唯一，不能与其他的插件冲突，因此我们可以将这个ID的命名规则设为（插件名-页面） 。JSP页面会根据这个ID来确定左侧菜单栏的显示位置。

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

<!--
  Plugin configuration for the broadcast plugin.
-->
<plugin>
    <class>com.landsem.plugin.helloworld.HelloWorldPlugin</class>
    <name>hello</name>
    <description>The hello world plugin demo.</description>
    <author>yingxianFei</author>
    <version>1.0.0</version>
    <date>9/13/2013</date>
    <minServerVersion>3.9.0</minServerVersion>
    <licenseType>gpl</licenseType>
    

    <adminconsole>    
        <tab id="tab-server">
            <sidebar id="sidebar-server-settings">
                <item id="hello-index" name="hello" url="hello-index.jsp"
                     description="Click is trigger sample plugin" />
            </sidebar>
        </tab>
    </adminconsole>    
</plugin>

5、访问

编译运行openfire服务器，打开浏览器输入   http://127.0.0.1:9090/plugins/hello/hello即可访问到实现的servlet。

在   HelloServlet.java中添加了相关免认证访问的代码，因此访问该servlet不需要登录认证即可访问，如果注释该部分代码则需要登录才能查看到servlet。免认证访问也可以通过将

插件名称+servlet地址(web-custom.xml中对应servlet-mapping的url-pattern)

  加入openfire的web.xml中的  AuthCheck  相关filter中来实现。该文件可以修改如下两个位置中的任意一个即可。

（1）、修改/openfire_src/src/web/WEB-INF/web.xml，修改完后，记得还要用ant编译一次并重启才能生效；

（2）、修改/openfire_src/target/openfire/plugins/admin/webapp/WEB-INF/web.xml修改完后，直接重启即可生效，也适用于安装版的openfire；

如下：

    <filter>
        <filter-name>AuthCheck</filter-name>
        <filter-class>org.jivesoftware.admin.AuthCheckFilter</filter-class>
        <init-param>
            <param-name>excludes</param-name>
            <param-value>
                login.jsp,index.jsp?logout=true,setup/index.jsp,setup/setup-*,.gif,.png,error-serverdown.jsp,setup/clearspace-integration-prelogin.jsp,hello/hello
            </param-value>
        </init-param>
    </filter>