您的位置: 首页  >  文章  >  openfire中开发带servlet的插件并实现免认证访问

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

分类: 文章 • 2022-10-23 17:31:42

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

原创 2015年09月11日 12:50:41

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


1、目录结构

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


2、servlet文件

   HelloServlet.java中实现如下：

[java] view plain copy
  1. package com.landsem.plugin.helloworld;  
  2.   
  3. import java.io.IOException;  
  4. import java.io.PrintWriter;  
  5.   
  6. import javax.servlet.ServletException;  
  7. import javax.servlet.http.HttpServlet;  
  8. import javax.servlet.http.HttpServletRequest;  
  9. import javax.servlet.http.HttpServletResponse;  
  10.   
  11. import org.jivesoftware.admin.AuthCheckFilter;  
  12.   
  13. public class HelloServlet extends HttpServlet {  
  14.     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>  
  15.   
  16.     /** 
  17.      *  
  18.      */  
  19.     private static final long serialVersionUID = 1L;  
  20.   
  21.     @Override  
  22.     protected void doGet(HttpServletRequest req, HttpServletResponse resp)  
  23.             throws ServletException, IOException {  
  24.         // TODO Auto-generated method stub  
  25.     //  super.doGet(req, resp);  
  26.         resp.setContentType("text/plain");  
  27.         PrintWriter out = resp.getWriter();  
  28.         System.out.println("HelloServlet GET Method");  
  29.         out.print("HelloServlet GET Method");  
  30.         out.flush();  
  31.     }  
  32.   
  33.     @Override  
  34.     protected void doPost(HttpServletRequest req, HttpServletResponse resp)  
  35.             throws ServletException, IOException {  
  36.         // TODO Auto-generated method stub  
  37.     //  super.doPost(req, resp);  
  38.         resp.setContentType("text/plain");  
  39.         PrintWriter out = resp.getWriter();  
  40.         System.out.println("HelloServlet GET Method");  
  41.         out.print("HelloServlet POST Method");  
  42.         out.flush();          
  43.     }  
  44.   
  45.     @Override  
  46.     public void init() throws ServletException {  
  47.         // TODO Auto-generated method stub  
  48.         super.init();  
  49.         AuthCheckFilter.addExclude(SERVICE_NAME);//用于免验证直接访问该servlet  
  50.     }  
  51.   
  52.     @Override  
  53.     public void destroy() {  
  54.         AuthCheckFilter.removeExclude(SERVICE_NAME);//用于免验证直接访问该servlet  
  55.         // TODO Auto-generated method stub  
  56.         super.destroy();  
  57.     }  
  58.   
  59. }  

3、web-custom.xml

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

[html] view plain copy
  1. <?xml version='1.0' encoding='ISO-8859-1'?>  
  2. <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">  
  3. <web-app>  
  4.   
  5.     <servlet>  
  6.         <servlet-class>com.landsem.plugin.helloworld.HelloServlet</servlet-class>  
  7.         <servlet-name>HelloServlet</servlet-name>  
  8.     </servlet>  
  9.      
  10.     <servlet-mapping>  
  11.         <servlet-name>HelloServlet</servlet-name>  
  12.         <url-pattern>/hello</url-pattern>  
  13.     </servlet-mapping>  
  14.   
  15. </web-app>  


4、plugin.xml

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

[html] view plain copy
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2.   
  3. <!-- 
  4.   Plugin configuration for the broadcast plugin. 
  5. -->  
  6. <plugin>  
  7.     <class>com.landsem.plugin.helloworld.HelloWorldPlugin</class>  
  8.     <name>hello</name>  
  9.     <description>The hello world plugin demo.</description>  
  10.     <author>yingxianFei</author>  
  11.     <version>1.0.0</version>  
  12.     <date>9/13/2013</date>  
  13.     <minServerVersion>3.9.0</minServerVersion>  
  14.     <licenseType>gpl</licenseType>  
  15.       
  16.   
  17.     <adminconsole>      
  18.         <tab id="tab-server">  
  19.             <sidebar id="sidebar-server-settings">  
  20.                 <item id="hello-index" name="hello" url="hello-index.jsp"  
  21.                      description="Click is trigger sample plugin" />  
  22.             </sidebar>  
  23.         </tab>  
  24.     </adminconsole>      
  25. </plugin>  

5、访问

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

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

[java] view plain copy
  1. 插件名称+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；


如下：


[html] view plain copy
  1. <filter>  
  2.     <filter-name>AuthCheck</filter-name>  
  3.     <filter-class>org.jivesoftware.admin.AuthCheckFilter</filter-class>  
  4.     <init-param>  
  5.         <param-name>excludes</param-name>  
  6.         <param-value>  
  7.             login.jsp,index.jsp?logout=true,setup/index.jsp,setup/setup-*,.gif,.png,error-serverdown.jsp,setup/clearspace-integration-prelogin.jsp,hello/hello  
  8.         </param-value>  
  9.     </init-param>  
  10. </filter>  


版权声明：本文为博主原创文章，转载请声明原文出处http://blog.****.net/smilefyx https://blog.****.net/yxtouch/article/details/48370989

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


1、目录结构

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


2、servlet文件

   HelloServlet.java中实现如下：

[java] view plain copy
  1. package com.landsem.plugin.helloworld;  
  2.   
  3. import java.io.IOException;  
  4. import java.io.PrintWriter;  
  5.   
  6. import javax.servlet.ServletException;  
  7. import javax.servlet.http.HttpServlet;  
  8. import javax.servlet.http.HttpServletRequest;  
  9. import javax.servlet.http.HttpServletResponse;  
  10.   
  11. import org.jivesoftware.admin.AuthCheckFilter;  
  12.   
  13. public class HelloServlet extends HttpServlet {  
  14.     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>  
  15.   
  16.     /** 
  17.      *  
  18.      */  
  19.     private static final long serialVersionUID = 1L;  
  20.   
  21.     @Override  
  22.     protected void doGet(HttpServletRequest req, HttpServletResponse resp)  
  23.             throws ServletException, IOException {  
  24.         // TODO Auto-generated method stub  
  25.     //  super.doGet(req, resp);  
  26.         resp.setContentType("text/plain");  
  27.         PrintWriter out = resp.getWriter();  
  28.         System.out.println("HelloServlet GET Method");  
  29.         out.print("HelloServlet GET Method");  
  30.         out.flush();  
  31.     }  
  32.   
  33.     @Override  
  34.     protected void doPost(HttpServletRequest req, HttpServletResponse resp)  
  35.             throws ServletException, IOException {  
  36.         // TODO Auto-generated method stub  
  37.     //  super.doPost(req, resp);  
  38.         resp.setContentType("text/plain");  
  39.         PrintWriter out = resp.getWriter();  
  40.         System.out.println("HelloServlet GET Method");  
  41.         out.print("HelloServlet POST Method");  
  42.         out.flush();          
  43.     }  
  44.   
  45.     @Override  
  46.     public void init() throws ServletException {  
  47.         // TODO Auto-generated method stub  
  48.         super.init();  
  49.         AuthCheckFilter.addExclude(SERVICE_NAME);//用于免验证直接访问该servlet  
  50.     }  
  51.   
  52.     @Override  
  53.     public void destroy() {  
  54.         AuthCheckFilter.removeExclude(SERVICE_NAME);//用于免验证直接访问该servlet  
  55.         // TODO Auto-generated method stub  
  56.         super.destroy();  
  57.     }  
  58.   
  59. }  

3、web-custom.xml

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

[html] view plain copy
  1. <?xml version='1.0' encoding='ISO-8859-1'?>  
  2. <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">  
  3. <web-app>  
  4.   
  5.     <servlet>  
  6.         <servlet-class>com.landsem.plugin.helloworld.HelloServlet</servlet-class>  
  7.         <servlet-name>HelloServlet</servlet-name>  
  8.     </servlet>  
  9.      
  10.     <servlet-mapping>  
  11.         <servlet-name>HelloServlet</servlet-name>  
  12.         <url-pattern>/hello</url-pattern>  
  13.     </servlet-mapping>  
  14.   
  15. </web-app>  


4、plugin.xml

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

[html] view plain copy
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2.   
  3. <!-- 
  4.   Plugin configuration for the broadcast plugin. 
  5. -->  
  6. <plugin>  
  7.     <class>com.landsem.plugin.helloworld.HelloWorldPlugin</class>  
  8.     <name>hello</name>  
  9.     <description>The hello world plugin demo.</description>  
  10.     <author>yingxianFei</author>  
  11.     <version>1.0.0</version>  
  12.     <date>9/13/2013</date>  
  13.     <minServerVersion>3.9.0</minServerVersion>  
  14.     <licenseType>gpl</licenseType>  
  15.       
  16.   
  17.     <adminconsole>      
  18.         <tab id="tab-server">  
  19.             <sidebar id="sidebar-server-settings">  
  20.                 <item id="hello-index" name="hello" url="hello-index.jsp"  
  21.                      description="Click is trigger sample plugin" />  
  22.             </sidebar>  
  23.         </tab>  
  24.     </adminconsole>      
  25. </plugin>  

5、访问

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

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

[java] view plain copy
  1. 插件名称+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；


如下：


[html] view plain copy
  1. <filter>  
  2.     <filter-name>AuthCheck</filter-name>  
  3.     <filter-class>org.jivesoftware.admin.AuthCheckFilter</filter-class>  
  4.     <init-param>  
  5.         <param-name>excludes</param-name>  
  6.         <param-value>  
  7.             login.jsp,index.jsp?logout=true,setup/index.jsp,setup/setup-*,.gif,.png,error-serverdown.jsp,setup/clearspace-integration-prelogin.jsp,hello/hello  
  8.         </param-value>  
  9.     </init-param>  
  10. </filter>  


相关推荐