Tomcat的org.apache.catalina.Context接口提供了动态管理注入到Catalina Web Container中的Web元素的API。在基于OSGi的Web Application中,可以利用这个接口来实现在OSGi容器中动态管理Web元素的目的。为了达到这个目的,我们还需要做一些额外的配置。请注意,以下方法仅适用于Tomcat,并非通用的实现,而且只针对5.5.28版和6.0.24版的Tomcat做过简单的测试。
首先我们要做的事情,就是将Tomcat的org.apache.catalina.Context实现类作为Service注入到OSGi容器中去。在OSGi-Web工程的WebContent/META-INF目录中,增加一个context.xml文件,内容如下:
1 <?xml version="1.0" encoding="UTF-8"?>
2 <Context privileged="true"/>
这样我们就可以使用org.apache.catalina.ContainerServlet这个接口类了,通过它可以访问Catalina的内部功能,它有Catalina被类加载器加载,而不是我们的WebApplication类加载器。它的 Setter方法在这个Servlet的新的实例被放进Service时被执行。
接下来我们写一个Servlet,这个Servlet将实现ContainerServlet接口,请注意它是怎么工作的:
1 package org.dbstar.osgi.web.launcher.tomcat;
2
3 import java.util.Properties;
4
5 import javax.servlet.ServletException;
6 import javax.servlet.UnavailableException;
7 import javax.servlet.http.HttpServlet;
8
9 import org.apache.catalina.ContainerServlet;
10 import org.apache.catalina.Context;
11 import org.apache.catalina.Wrapper;
12 import org.dbstar.osgi.web.launcher.FrameworkConfigListener;
13 import org.osgi.framework.BundleContext;
14 import org.osgi.framework.ServiceRegistration;
15 import org.osgi.framework.launch.Framework;
16
17 public final class TomcatContextServlet extends HttpServlet implements ContainerServlet {
18 private static final long serialVersionUID = -3977062987005392657L;
19
20 private Wrapper wrapper;
21 private Context context;
22
23 private ServiceRegistration registration;
24
25 public Wrapper getWrapper() {
26 return wrapper;
27 }
28
29 public void setWrapper(Wrapper wrapper) {
30 this.wrapper = wrapper;
31 if (wrapper == null) context = null;
32 else context = (Context) wrapper.getParent();
33 }
34
35 @Override
36 public void init() throws ServletException {
37 // Ensure that our ContainerServlet properties have been set
38 if ((wrapper == null) || (context == null)) throw new UnavailableException("Wrapper not set.");
39
40 // Ensure that Framework have been set
41 Framework framework = FrameworkConfigListener.getFramework();
42 if (framework == null) throw new UnavailableException("Framework not set.");
43
44 // 将context注册为服务
45 registration = registerContext(framework.getBundleContext(), context);
46 }
47
48 private static ServiceRegistration registerContext(BundleContext bundleContext, Context context) {
49 Properties properties = new Properties();
50 properties.setProperty("DisplayName", context.getDisplayName());
51 properties.setProperty("ContextPath", context.getPath());
52 return bundleContext.registerService(Context.class.getName(), context, properties);
53 }
54
55 @Override
56 public void destroy() {
57 if (registration == null) return;
58
59 Framework framework = FrameworkConfigListener.getFramework();
60 if (framework == null) return;
61
62 if (framework.getState() == Framework.ACTIVE) registration.unregister();
63 registration = null;
64 }
65 }
通过ContainerServlet接口提供的setWrapper方法,我们获得了一个Wrapper实例,这个实例对应于TomcatContextServlet部署到Tomcat中的封装类,通过其getParent方法我们就可以获得Servlet所在的Context了。
接下来在init方法中,我们将获得的Context实例,通过Framework注册到OSGi容器中去。在destroy方法中,注销Context的注册,这样形成了一个完整的生命周期。
然后,将这个TomcatContextServlet部署到web.xml中去:
1 <!-- register a org.apache.catalina.Context to OSGi Container -->
2 <servlet>
3 <servlet-name>TomcatContextServlet</servlet-name>
4 <servlet-class>org.dbstar.osgi.web.launcher.tomcat.TomcatContextServlet</servlet-class>
5 <load-on-startup>1</load-on-startup>
6 </servlet>
设置<load-on-startup>使这个Servlet在WebContainer初始化时加载,否则它将没有加载的机会,因为我们在应用中不会直接使用到这个Servlet。
最后还有一件事情不要忘记了,我们需要将org.apache.catalina及其相关的package export到OSGi容器中去,这样才能在OSGi容器中供给bundle来import。参照《
打造一个基于OSGi的Web Application——为OSGi容器提供Web Application环境》一文中提到的方式,我们将catalina.jar作为extension Fragment的方式,引入到OSGi容器中去。
Catalina的MANIFEST.MF:
1 Manifest-Version: 1.0
2 Bundle-ManifestVersion: 2
3 Bundle-Name: Catalina Extension Fragment
4 Bundle-SymbolicName: org.apache.catalina_extension;singleton:=true
5 Bundle-Version: 5.5.28
6 Bundle-Vendor: dbstar
7 Fragment-Host: system.bundle; extension:=framework
8 Bundle-RequiredExecutionEnvironment: J2SE-1.5
9 Export-Package: org.apache.catalina,org.apache.catalina.authenticator,
10 org.apache.catalina.connector,org.apache.catalina.core,org.apache.cat
11 alina.deploy,org.apache.catalina.loader,org.apache.catalina.mbeans,or
12 g.apache.catalina.realm,org.apache.catalina.security,org.apache.catal
13 ina.session,org.apache.catalina.startup,org.apache.catalina.users,org
14 .apache.catalina.util,org.apache.catalina.valves
在接下来的章节中,我会逐一描述如何在基于Tomcat的OSGi容器中,如何实现各种Web元素的动态管理,尽请期待哦:)
最后提供几个本章提到的bundle给大家下载,大家就不用自己再起生成一个了。
org.apache.catalina_extension_5.5.28.jar