Extend Spring DM web extender in order to fix issue when undeploying
authorMathieu Baudier <mbaudier@argeo.org>
Fri, 25 Feb 2011 19:37:46 +0000 (19:37 +0000)
committerMathieu Baudier <mbaudier@argeo.org>
Fri, 25 Feb 2011 19:37:46 +0000 (19:37 +0000)
git-svn-id: https://svn.argeo.org/commons/trunk@4211 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc

server/modules/org.argeo.server.webextender/.project [deleted file]
server/modules/org.argeo.server.webextender/.settings/org.eclipse.pde.core.prefs [deleted file]
server/modules/org.argeo.server.webextender/META-INF/MANIFEST.MF [deleted file]
server/modules/org.argeo.server.webextender/META-INF/spring/extender/webextender.xml [deleted file]
server/modules/org.argeo.server.webextender/build.properties [deleted file]
server/runtime/org.argeo.server.webextender/META-INF/spring/extender/webextender.xml [new file with mode: 0644]
server/runtime/org.argeo.server.webextender/pom.xml
server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/catalina/CatalinaServer.java [deleted file]
server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/catalina/OsgiCatalina.java [deleted file]
server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/catalina/TomcatDeployer.java [deleted file]
server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/webextender/TomcatDeployer.java [new file with mode: 0644]

diff --git a/server/modules/org.argeo.server.webextender/.project b/server/modules/org.argeo.server.webextender/.project
deleted file mode 100644 (file)
index a8e485f..0000000
+++ /dev/null
@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
-       <name>org.argeo.server.webextender</name>
-       <comment></comment>
-       <projects>
-       </projects>
-       <buildSpec>
-               <buildCommand>
-                       <name>org.eclipse.pde.ManifestBuilder</name>
-                       <arguments>
-                       </arguments>
-               </buildCommand>
-               <buildCommand>
-                       <name>org.eclipse.pde.SchemaBuilder</name>
-                       <arguments>
-                       </arguments>
-               </buildCommand>
-       </buildSpec>
-       <natures>
-               <nature>org.eclipse.pde.PluginNature</nature>
-       </natures>
-</projectDescription>
diff --git a/server/modules/org.argeo.server.webextender/.settings/org.eclipse.pde.core.prefs b/server/modules/org.argeo.server.webextender/.settings/org.eclipse.pde.core.prefs
deleted file mode 100644 (file)
index bd6f9ba..0000000
+++ /dev/null
@@ -1,4 +0,0 @@
-#Fri Feb 25 14:51:26 CET 2011
-eclipse.preferences.version=1
-pluginProject.extensions=false
-resolve.requirebundle=false
diff --git a/server/modules/org.argeo.server.webextender/META-INF/MANIFEST.MF b/server/modules/org.argeo.server.webextender/META-INF/MANIFEST.MF
deleted file mode 100644 (file)
index ba6ebbf..0000000
+++ /dev/null
@@ -1,11 +0,0 @@
-Manifest-Version: 1.0
-Bundle-ManifestVersion: 2
-Bundle-Name: Webextender
-Bundle-SymbolicName: org.argeo.server.webextender
-Bundle-Version: 1.0.0.qualifier
-Bundle-Vendor: Argeo
-Fragment-Host: org.springframework.osgi.web.extender
-Import-Package: org.apache.catalina,
- org.apache.catalina.connector,
- org.argeo.server.catalina,
- org.springframework.osgi.web.deployer.tomcat;version="1.2.1"
diff --git a/server/modules/org.argeo.server.webextender/META-INF/spring/extender/webextender.xml b/server/modules/org.argeo.server.webextender/META-INF/spring/extender/webextender.xml
deleted file mode 100644 (file)
index 6e87783..0000000
+++ /dev/null
@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<beans xmlns="http://www.springframework.org/schema/beans"
-       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:osgi="http://www.springframework.org/schema/osgi"
-       xmlns:p="http://www.springframework.org/schema/p"
-       xsi:schemaLocation="http://www.springframework.org/schema/beans   
-     http://www.springframework.org/schema/beans/spring-beans.xsd
-     http://www.springframework.org/schema/osgi
-     http://www.springframework.org/schema/osgi/spring-osgi.xsd">
-
-       <!-- we leave 5 mins to Tomcat to start -->
-       <osgi:reference id="tomcatServer" interface="org.apache.catalina.Service"
-               cardinality="0..1" timeout="300000" />
-
-       <bean id="warDeployer" class="org.argeo.server.catalina.TomcatDeployer"
-               p:service-ref="tomcatServer" />
-
-</beans>
\ No newline at end of file
diff --git a/server/modules/org.argeo.server.webextender/build.properties b/server/modules/org.argeo.server.webextender/build.properties
deleted file mode 100644 (file)
index 5f22cdd..0000000
+++ /dev/null
@@ -1 +0,0 @@
-bin.includes = META-INF/
diff --git a/server/runtime/org.argeo.server.webextender/META-INF/spring/extender/webextender.xml b/server/runtime/org.argeo.server.webextender/META-INF/spring/extender/webextender.xml
new file mode 100644 (file)
index 0000000..9df865d
--- /dev/null
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:osgi="http://www.springframework.org/schema/osgi"
+       xmlns:p="http://www.springframework.org/schema/p"
+       xsi:schemaLocation="http://www.springframework.org/schema/beans   
+     http://www.springframework.org/schema/beans/spring-beans.xsd
+     http://www.springframework.org/schema/osgi
+     http://www.springframework.org/schema/osgi/spring-osgi.xsd">
+
+       <!-- we leave 5 mins to Tomcat to start -->
+       <osgi:reference id="tomcatServer" interface="org.apache.catalina.Service"
+               cardinality="0..1" timeout="300000" />
+
+       <bean id="warDeployer" class="org.argeo.server.webextender.TomcatDeployer"
+               p:service-ref="tomcatServer" />
+
+</beans>
\ No newline at end of file
index 08adbeefc3b3ccfff9a4925994d8132c5a96a35d..da4b0ba11f6d83cb4f0578556fbfa99009899428 100644 (file)
                                <version>${version.maven-bundle-plugin}</version>
                                <configuration>
                                        <instructions>
-
-                                               <Export-Package>
-                                                       org.argeo.server.*
-                                               </Export-Package>
+                                               <Fragment-Host>org.springframework.osgi.web.extender</Fragment-Host>
+                                               <Export-Package>org.argeo.server.webextender.*</Export-Package>
+                                               <Import-Package>org.springframework.beans.factory,*</Import-Package>
                                        </instructions>
                                </configuration>
                        </plugin>
                <!-- Spring -->
                <dependency>
                        <groupId>org.springframework.osgi</groupId>
-                       <artifactId>org.springframework.web.extender</artifactId>
+                       <artifactId>org.springframework.osgi.web.extender</artifactId>
+               </dependency>
+               <dependency>
+                       <groupId>org.apache.catalina</groupId>
+                       <artifactId>com.springsource.org.apache.catalina</artifactId>
+               </dependency>
+               <dependency>
+                       <groupId>org.springframework</groupId>
+                       <artifactId>org.springframework.beans</artifactId>
                </dependency>
        </dependencies>
 </project>
diff --git a/server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/catalina/CatalinaServer.java b/server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/catalina/CatalinaServer.java
deleted file mode 100644 (file)
index 392bbfa..0000000
+++ /dev/null
@@ -1,219 +0,0 @@
-package org.argeo.server.catalina;
-
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.net.URL;
-import java.net.URLConnection;
-import java.net.URLStreamHandler;
-import java.util.Properties;
-
-import javax.management.MBeanRegistration;
-
-import org.apache.catalina.Lifecycle;
-import org.apache.catalina.Server;
-import org.apache.catalina.Service;
-import org.apache.catalina.connector.Connector;
-import org.apache.catalina.core.StandardService;
-import org.apache.catalina.util.ServerInfo;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-import org.apache.naming.resources.DirContextURLStreamHandler;
-import org.osgi.framework.Bundle;
-import org.osgi.framework.BundleContext;
-import org.osgi.framework.Constants;
-import org.osgi.framework.ServiceRegistration;
-import org.osgi.service.url.AbstractURLStreamHandlerService;
-import org.osgi.service.url.URLConstants;
-import org.osgi.service.url.URLStreamHandlerService;
-import org.springframework.beans.factory.DisposableBean;
-import org.springframework.beans.factory.InitializingBean;
-
-public class CatalinaServer implements DisposableBean,InitializingBean{
-       /** logger */
-       private static final Log log = LogFactory.getLog(CatalinaServer.class);
-
-       /** default XML configuration */
-       private static final String DEFAULT_XML_CONF_LOCATION = "conf/default-server.xml";
-
-       /** user-configurable XML configuration */
-       private static final String XML_CONF_LOCATION = "conf/server.xml";
-
-       private BundleContext bundleContext;
-
-       private StandardService server;
-
-       private ServiceRegistration registration, urlRegistration;
-
-       public void afterPropertiesSet() throws Exception {
-               log.info("Starting " + ServerInfo.getServerInfo() + " ...");
-
-               // default startup procedure
-               ClassLoader cl = CatalinaServer.class.getClassLoader();
-               Thread current = Thread.currentThread();
-               ClassLoader old = current.getContextClassLoader();
-
-               try {
-                       current.setContextClassLoader(cl);
-
-                       server = createCatalinaServer(bundleContext.getBundle());
-
-                       server.start();
-
-                       Connector[] connectors = server.findConnectors();
-                       for (int i = 0; i < connectors.length; i++) {
-                               Connector conn = connectors[i];
-                               log.info("Succesfully started " + ServerInfo.getServerInfo() + " @ " + conn.getDomain() + ":"
-                                               + conn.getPort());
-                       }
-
-                       // register URL service
-                       urlRegistration = registerTomcatJNDIUrlService();
-                       // publish server as an OSGi service
-                       registration = publishServerAsAService(server);
-                       log.info("Published " + ServerInfo.getServerInfo() + " as an OSGi service");
-               }
-               catch (Exception ex) {
-                       String msg = "Cannot start " + ServerInfo.getServerInfo();
-                       log.error(msg, ex);
-                       throw new RuntimeException(msg, ex);
-               }
-               finally {
-                       current.setContextClassLoader(old);
-               }
-       }
-
-       public void destroy() throws Exception {
-               // unpublish service first
-               registration.unregister();
-               urlRegistration.unregister();
-
-               log.info("Unpublished  " + ServerInfo.getServerInfo() + " OSGi service");
-
-               // default startup procedure
-               ClassLoader cl = CatalinaServer.class.getClassLoader();
-               Thread current = Thread.currentThread();
-               ClassLoader old = current.getContextClassLoader();
-
-               try {
-                       current.setContextClassLoader(cl);
-                       //reset CCL 
-                       // current.setContextClassLoader(null);
-                       log.info("Stopping " + ServerInfo.getServerInfo() + " ...");
-                       server.stop();
-                       log.info("Succesfully stopped " + ServerInfo.getServerInfo());
-               }
-               catch (Exception ex) {
-                       log.error("Cannot stop " + ServerInfo.getServerInfo(), ex);
-                       throw ex;
-               }
-               finally {
-                       current.setContextClassLoader(old);
-               }
-       }
-
-       private StandardService createCatalinaServer(Bundle bundle) throws Exception {
-               // first try to use the XML file
-               URL xmlConfiguration = bundle.getResource(XML_CONF_LOCATION);
-
-               if (xmlConfiguration != null) {
-                       log.info("Using custom XML configuration " + xmlConfiguration);
-               }
-               else {
-                       xmlConfiguration = bundle.getResource(DEFAULT_XML_CONF_LOCATION);
-                       if (xmlConfiguration == null)
-                               log.error("No XML configuration found; bailing out...");
-                       else
-                               log.info("Using default XML configuration " + xmlConfiguration);
-               }
-
-               return createServerFromXML(xmlConfiguration);
-       }
-
-       private StandardService createServerFromXML(URL xmlConfiguration) throws IOException {
-               OsgiCatalina catalina = new OsgiCatalina();
-               catalina.setAwait(false);
-               catalina.setUseShutdownHook(false);
-               catalina.setName("Catalina");
-               catalina.setParentClassLoader(Thread.currentThread().getContextClassLoader());
-
-               // copy the URL file to a local temporary file (since Catalina doesn't use URL unfortunately)
-               File configTempFile = File.createTempFile("dm.catalina", ".cfg.xml");
-               configTempFile.deleteOnExit();
-
-               // copy URL to temporary file
-               copyURLToFile(xmlConfiguration.openStream(), new FileOutputStream(configTempFile));
-               log.debug("Copied configuration " + xmlConfiguration + " to temporary file " + configTempFile);
-
-               catalina.setConfigFile(configTempFile.getAbsolutePath());
-
-               catalina.load();
-
-               Server server = catalina.getServer();
-
-               return (StandardService) server.findServices()[0];
-       }
-
-       private void copyURLToFile(InputStream inStream, FileOutputStream outStream) {
-
-               int bytesRead;
-               byte[] buf = new byte[4096];
-               try {
-                       while ((bytesRead = inStream.read(buf)) >= 0) {
-                               outStream.write(buf, 0, bytesRead);
-                       }
-               }
-               catch (IOException ex) {
-                       throw (RuntimeException) new IllegalStateException("Cannot copy URL to file").initCause(ex);
-               }
-               finally {
-                       try {
-                               inStream.close();
-                       }
-                       catch (IOException ignore) {
-                       }
-                       try {
-                               outStream.close();
-                       }
-                       catch (IOException ignore) {
-                       }
-               }
-       }
-
-       private ServiceRegistration publishServerAsAService(StandardService server) {
-               Properties props = new Properties();
-               // put some extra properties to easily identify the service
-               props.put(Constants.SERVICE_VENDOR, "Spring Dynamic Modules");
-               props.put(Constants.SERVICE_DESCRIPTION, ServerInfo.getServerInfo());
-               props.put(Constants.BUNDLE_VERSION, ServerInfo.getServerNumber());
-               props.put(Constants.BUNDLE_NAME, bundleContext.getBundle().getSymbolicName());
-
-               // spring-dm specific property
-               props.put("org.springframework.osgi.bean.name", "tomcat-server");
-
-               // publish just the interfaces and the major classes (server/handlerWrapper)
-               String[] classes = new String[] { StandardService.class.getName(), Service.class.getName(),
-                       MBeanRegistration.class.getName(), Lifecycle.class.getName() };
-
-               return bundleContext.registerService(classes, server, props);
-       }
-
-       private ServiceRegistration registerTomcatJNDIUrlService() {
-               Properties properties = new Properties();
-               properties.put(URLConstants.URL_HANDLER_PROTOCOL, "jndi");
-               final URLStreamHandler handler = new DirContextURLStreamHandler();
-
-               return bundleContext.registerService(URLStreamHandlerService.class.getName(),
-                       new AbstractURLStreamHandlerService() {
-
-                               private final static String EMPTY_STRING = "";
-
-
-                               public URLConnection openConnection(URL u) throws IOException {
-                                       return new URL(u, EMPTY_STRING, handler).openConnection();
-                               }
-                       }, properties);
-       }
-
-}
diff --git a/server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/catalina/OsgiCatalina.java b/server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/catalina/OsgiCatalina.java
deleted file mode 100644 (file)
index f07b9c5..0000000
+++ /dev/null
@@ -1,34 +0,0 @@
-/*\r
- * Copyright 2006-2008 the original author or authors.\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- * \r
- *      http://www.apache.org/licenses/LICENSE-2.0\r
- * \r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-package org.argeo.server.catalina;\r
-\r
-import org.apache.catalina.Server;\r
-import org.apache.catalina.startup.Catalina;\r
-\r
-/**\r
- * OSGi extension of Catalina class used for easy access to the underlying\r
- * configuration.\r
- * \r
- * @author Costin Leau\r
- * \r
- */\r
-public class OsgiCatalina extends Catalina {\r
-\r
-       public Server getServer() {\r
-               return server;\r
-       }\r
-}\r
diff --git a/server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/catalina/TomcatDeployer.java b/server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/catalina/TomcatDeployer.java
deleted file mode 100644 (file)
index 3cc16bc..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-package org.argeo.server.catalina;
-
-import org.apache.catalina.Service;
-import org.springframework.osgi.web.deployer.tomcat.TomcatWarDeployer;
-
-/**
- * Wraps the Spring DM Tomcate deployer in order to avoid issue with call to
- * getServerInfo() when undeployed.
- */
-public class TomcatDeployer extends TomcatWarDeployer {
-       private String serverInfo;
-
-       @Override
-       public void setService(Object service) {
-               super.setService(service);
-
-               serverInfo = ((Service) service).getInfo();
-       }
-
-       @Override
-       protected String getServerInfo() {
-               return serverInfo;
-       }
-
-       
-}
diff --git a/server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/webextender/TomcatDeployer.java b/server/runtime/org.argeo.server.webextender/src/main/java/org/argeo/server/webextender/TomcatDeployer.java
new file mode 100644 (file)
index 0000000..f93a5f3
--- /dev/null
@@ -0,0 +1,28 @@
+package org.argeo.server.webextender;
+
+import org.apache.catalina.Service;
+import org.springframework.osgi.web.deployer.tomcat.TomcatWarDeployer;
+
+/**
+ * Wraps the Spring DM Tomcat deployer in order to avoid issue with call to
+ * getServerInfo() when undeployed.
+ */
+public class TomcatDeployer extends TomcatWarDeployer {
+       private String serverInfo;
+
+       @Override
+       public void setService(Object service) {
+               super.setService(service);
+               // TODO: listen to OSGi service so that we get notified in the
+               // (unlikely) cae the underlying service is update
+               serverInfo = ((Service) service).getInfo();
+               if (log.isDebugEnabled())
+                       log.debug("Argeo modified Tomcat deployer used");
+       }
+
+       @Override
+       protected String getServerInfo() {
+               return serverInfo;
+       }
+
+}