TUSCANY-3149 - Generally be more careful about removing object references in host-webapp. Specifically there is a problem with the axis ws binding (JIRA 3732 in the Axis project) where a shutdown hook is registered but not removed. This is fixed in Axis2 1.5 but as we are still in 1.4.1 I've worked round it here.

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@795364 13f79535-47bb-0310-9956-ffa450edef68

8 files changed, 210 insertions, 9 deletions

diff --git a/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2BindingProviderFactory.java b/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2BindingProviderFactory.java
index e6ca8e20a8..b1923bdf3c 100644
--- a/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2BindingProviderFactory.java
+++ b/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2BindingProviderFactory.java
@@ -46,17 +46,15 @@ import org.apache.tuscany.sca.work.WorkScheduler;
 public class Axis2BindingProviderFactory implements BindingProviderFactory<WebServiceBinding> {
 
     private ModelFactoryExtensionPoint modelFactories;
-    private ServletHost servletHost;
+    private List<ServletHost> hosts;
     private List<PolicyHandlerTuple> policyHandlerClassnames = null;
     private DataBindingExtensionPoint dataBindings;
     private WorkScheduler workScheduler;
 
     public Axis2BindingProviderFactory(ExtensionPointRegistry extensionPoints) {
         ServletHostExtensionPoint servletHosts = extensionPoints.getExtensionPoint(ServletHostExtensionPoint.class);
-        List<ServletHost> hosts = servletHosts.getServletHosts();
-        if (!hosts.isEmpty()) {
-            this.servletHost = hosts.get(0);
-        }
+        hosts = servletHosts.getServletHosts();
+
         modelFactories = extensionPoints.getExtensionPoint(ModelFactoryExtensionPoint.class);
         policyHandlerClassnames = PolicyHandlerDefinitionsLoader.loadPolicyHandlerClassnames();
         dataBindings = extensionPoints.getExtensionPoint(DataBindingExtensionPoint.class);
@@ -74,6 +72,12 @@ public class Axis2BindingProviderFactory implements BindingProviderFactory<WebSe
     public ServiceBindingProvider createServiceBindingProvider(RuntimeComponent component,
                                                                RuntimeComponentService service,
                                                                WebServiceBinding binding) {
+    	ServletHost servletHost = null;
+    	
+        if (!hosts.isEmpty()) {
+            servletHost = hosts.get(0);
+        }
+    	
         return new Axis2ServiceBindingProvider(component, service, binding,
                                                servletHost, modelFactories,
                                                policyHandlerClassnames, dataBindings, workScheduler);
diff --git a/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2ServiceProvider.java b/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2ServiceProvider.java
index 64c0c66a2e..62a18d62ac 100644
--- a/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2ServiceProvider.java
+++ b/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2ServiceProvider.java
@@ -392,6 +392,8 @@ public class Axis2ServiceProvider {
                 servletHost.removeServletMapping(endpointURL);
             }
         }
+        
+        servletHost = null;
 
         if ( jmsSender != null )
             jmsSender.stop();
diff --git a/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2ServiceServlet.java b/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2ServiceServlet.java
index 746b850ff0..debb2c5764 100644
--- a/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2ServiceServlet.java
+++ b/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/Axis2ServiceServlet.java
@@ -20,6 +20,7 @@ package org.apache.tuscany.sca.binding.ws.axis2;
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.lang.reflect.Field;
 import java.net.MalformedURLException;
 import java.net.SocketException;
 import java.net.URI;
@@ -29,6 +30,7 @@ import java.util.Enumeration;
 import java.util.Set;
 import java.util.Vector;
 
+import javax.servlet.GenericServlet;
 import javax.servlet.RequestDispatcher;
 import javax.servlet.Servlet;
 import javax.servlet.ServletConfig;
@@ -38,8 +40,11 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.axis2.AxisFault;
+import org.apache.axis2.Constants;
 import org.apache.axis2.addressing.EndpointReference;
 import org.apache.axis2.context.ConfigurationContext;
+import org.apache.axis2.description.TransportInDescription;
+import org.apache.axis2.engine.ListenerManager;
 import org.apache.axis2.transport.http.AxisServlet;
 import org.apache.axis2.transport.http.ListingAgent;
 import org.apache.axis2.transport.http.server.HttpUtils;
@@ -59,13 +64,16 @@ public class Axis2ServiceServlet extends AxisServlet {
     private static final long serialVersionUID = 1L;
     private static final ServletConfig DUMMY_CONFIG = createDummyServletConfig();
     
+    private boolean initCalled = false;
+    
 //JIRA TUSCANY-1561 Port to Axis2 1.3    
     private ConfigurationContext tmpconfigContext;
 
     public void init(ConfigurationContext configContext) {
         this.tmpconfigContext = configContext;
         try {
-            super.init(DUMMY_CONFIG);
+            //super.init(DUMMY_CONFIG);
+        	init(DUMMY_CONFIG);
         } catch (ServletException e) {
             throw new RuntimeException(e);
         }
@@ -85,7 +93,55 @@ public class Axis2ServiceServlet extends AxisServlet {
     public void init(ServletConfig config) throws ServletException {
         ServletContext servletContext = config.getServletContext();
         servletContext.setAttribute(CONFIGURATION_CONTEXT, tmpconfigContext);
-        super.init(config);
+       
+        //super.init(config);
+        
+        // A copy of the init method from the base class because we need to replace the 
+        // version of the ListenerManager that is used so that we can get it's 
+        // shutdown hook removed properly. 
+        
+        // prevent this method from being called more than once per instance
+        if (initCalled == false) {
+	        initCalled = true;
+	        // We can't call super.init() as it will just call the AxisServlet version
+	        // which we are replacing here. So reflect on the base class and
+	        // set the private config field in the base class. 
+	        //super.init(config);
+	        try {
+	        	Field field = GenericServlet.class.getDeclaredField("config");
+	        	field.setAccessible(true);
+	        	field.set(this, config);
+	        } catch (Exception ex){
+	        	ex.printStackTrace();
+	        }
+	        
+	        try {
+	            this.servletConfig = config;
+	            //ServletContext servletContext = servletConfig.getServletContext();
+	            this.configContext =
+	                    (ConfigurationContext) servletContext.getAttribute(CONFIGURATION_CONTEXT);
+	            if(configContext == null){
+	                configContext = initConfigContext(config);
+	                config.getServletContext().setAttribute(CONFIGURATION_CONTEXT, configContext);
+	            }
+	            axisConfiguration = configContext.getAxisConfiguration();
+	
+	            ListenerManager listenerManager = new TuscanyListenerManager();
+	            listenerManager.init(configContext);
+	            TransportInDescription transportInDescription = new TransportInDescription(
+	                    Constants.TRANSPORT_HTTP);
+	            transportInDescription.setReceiver(this);
+	            listenerManager.addListener(transportInDescription, true);
+	            listenerManager.start();
+	            ListenerManager.defaultConfigurationContext = configContext;
+	            super.agent = new ListingAgent(configContext);
+	
+	            initParams();
+	
+	        } catch (Exception e) {
+	            throw new ServletException(e);
+	        }
+        }
     }
 
     /**
@@ -237,9 +293,14 @@ public class Axis2ServiceServlet extends AxisServlet {
     public void destroy() {
         try {
             super.destroy();
+            servletConfig = null;
+            if (tmpconfigContext.getListenerManager() != null){
+            	tmpconfigContext.getListenerManager().destroy();
+            }
         } catch (Exception e) {
             e.printStackTrace();
         }
+    
     }
 
     /**
diff --git a/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/TuscanyListenerManager.java b/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/TuscanyListenerManager.java
new file mode 100644
index 0000000000..7d331aa6c8
--- /dev/null
+++ b/branches/sca-java-1.x/modules/binding-ws-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/TuscanyListenerManager.java
@@ -0,0 +1,107 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.    
+ */
+
+package org.apache.tuscany.sca.binding.ws.axis2;
+
+import java.lang.reflect.Field;
+import java.util.HashMap;
+import java.util.Iterator;
+
+import org.apache.axis2.AxisFault;
+import org.apache.axis2.context.ConfigurationContext;
+import org.apache.axis2.description.TransportInDescription;
+import org.apache.axis2.engine.ListenerManager;
+import org.apache.axis2.transport.TransportListener;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
+/**
+ * A Tuscany specific Axis2 ListenerManager. Created purely as part of
+ * TUSCANY-3149 to unregister the ListenerManager from the runtime
+ * shutown hook
+ */
+public class TuscanyListenerManager extends ListenerManager {
+	private static final Log log = LogFactory.getLog(TuscanyListenerManager.class);
+	
+	private ListenerManagerShutdownThread shutdownThread = null;
+	
+    /**
+     * To start all the transports
+     */
+    public synchronized void start() {
+    	
+    	ConfigurationContext configctx = getConfigctx();
+    	
+    	// very nasty! but this is in order to get someone running who keeps 
+    	// getting perm gen errors. This will all go away when we move up to Axis2 1.5
+    	HashMap startedTransports = null;
+    	
+    	try {
+    		Field field = ListenerManager.class.getDeclaredField("startedTransports");
+    		field.setAccessible(true);
+    		startedTransports = (HashMap)field.get(this);
+    	} catch (Exception ex){
+    		ex.printStackTrace();
+    	}
+
+        for (Iterator transportNames =
+                configctx.getAxisConfiguration().getTransportsIn().values().iterator();
+             transportNames.hasNext();) {
+            try {
+                TransportInDescription transportIn = (TransportInDescription) transportNames.next();
+                TransportListener listener = transportIn.getReceiver();
+                if (listener != null &&
+                    startedTransports.get(transportIn.getName()) == null) {
+                    listener.init(configctx, transportIn);
+                    listener.start();
+                    if (startedTransports.get(transportIn.getName()) == null) {
+                        startedTransports.put(transportIn.getName(), listener);
+                    }
+                }
+            } catch (Exception e) {
+                log.info(e.getMessage(), e);
+            }
+        }
+        shutdownThread = new ListenerManagerShutdownThread(this);
+        Runtime.getRuntime().addShutdownHook(shutdownThread);
+    }
+    
+    public synchronized void stop() throws AxisFault {
+    	super.stop();
+    	Runtime.getRuntime().removeShutdownHook(shutdownThread);
+    }
+    
+    static class ListenerManagerShutdownThread extends Thread {
+        ListenerManager listenerManager;
+
+        public ListenerManagerShutdownThread(ListenerManager listenerManager) {
+            super();
+            this.listenerManager = listenerManager;
+        }
+
+        public void run() {
+            try {                
+            	listenerManager.stop();
+            } catch (AxisFault axisFault) {
+                log.error(axisFault.getMessage(), axisFault);
+            }
+        }
+    }    
+
+}
diff --git a/branches/sca-java-1.x/modules/host-embedded/src/main/java/org/apache/tuscany/sca/host/embedded/impl/DefaultSCADomain.java b/branches/sca-java-1.x/modules/host-embedded/src/main/java/org/apache/tuscany/sca/host/embedded/impl/DefaultSCADomain.java
index 080a60f575..9b02ee9fa2 100644
--- a/branches/sca-java-1.x/modules/host-embedded/src/main/java/org/apache/tuscany/sca/host/embedded/impl/DefaultSCADomain.java
+++ b/branches/sca-java-1.x/modules/host-embedded/src/main/java/org/apache/tuscany/sca/host/embedded/impl/DefaultSCADomain.java
@@ -213,7 +213,12 @@ public class DefaultSCADomain extends SCADomain {
     public void close() {
         super.close();
         node.stop();
-
+        node = null;
+        client = null;
+        components.clear();
+        compositeActivator = null;
+        applicationClassLoader = null;
+        componentManager = null;
     }
 
     @Override
diff --git a/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java b/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java
index a5a3745d7f..2395ba0c66 100644
--- a/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java
+++ b/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java
@@ -70,6 +70,7 @@ public class TuscanyServletFilter implements Filter {
 
     public void destroy() {
         WebAppServletHost.getInstance().destroy();
+        servletHost = null;
     }
 
     public void doFilter(ServletRequest request, ServletResponse response, javax.servlet.FilterChain chain)
diff --git a/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppModuleActivator.java b/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppModuleActivator.java
index dbe8a523f9..c10e5e7b5a 100644
--- a/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppModuleActivator.java
+++ b/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppModuleActivator.java
@@ -48,6 +48,12 @@ public class WebAppModuleActivator implements ModuleActivator {
     }
 
     public void stop(ExtensionPointRegistry registry) {
+    	// as we know we are running in a webapp remove all of the servlet
+    	// hosts. There will just be one - see start method
+        ServletHostExtensionPoint servletHosts =
+        	registry.getExtensionPoint(ServletHostExtensionPoint.class);
+        List<ServletHost> hosts = servletHosts.getServletHosts();
+        hosts.clear();
     }
 
     /**
diff --git a/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java b/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java
index 26114ab8b2..045cae4e75 100644
--- a/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java
+++ b/branches/sca-java-1.x/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java
@@ -19,7 +19,9 @@
 
 package org.apache.tuscany.sca.host.webapp;
 
+import java.beans.Introspector;
 import java.io.File;
+import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.net.InetAddress;
 import java.net.MalformedURLException;
@@ -28,6 +30,7 @@ import java.net.URL;
 import java.net.UnknownHostException;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.IdentityHashMap;
 import java.util.Map;
 import java.util.logging.Logger;
 
@@ -39,6 +42,7 @@ import javax.servlet.ServletConfig;
 import javax.servlet.ServletContext;
 import javax.servlet.ServletException;
 
+import org.apache.commons.logging.LogFactory;
 import org.apache.tuscany.sca.host.embedded.SCADomain;
 import org.apache.tuscany.sca.host.http.SecurityContext;
 import org.apache.tuscany.sca.host.http.ServletHost;
@@ -57,7 +61,7 @@ public class WebAppServletHost implements ServletHost {
 
     public static final String SCA_DOMAIN_ATTRIBUTE = "org.apache.tuscany.sca.SCADomain";
 
-    private static final WebAppServletHost instance = new WebAppServletHost();
+    private static WebAppServletHost instance = null;
 
     private Map<String, Servlet> servlets;
     private SCADomain scaDomain;
@@ -210,6 +214,9 @@ public class WebAppServletHost implements ServletHost {
     }
 
     public static WebAppServletHost getInstance() {
+    	if (instance == null){
+    		instance = new WebAppServletHost();
+    	}
         return instance;
     }
 
@@ -309,7 +316,15 @@ public class WebAppServletHost implements ServletHost {
             if (scaDomain instanceof WebSCADomain) {
                 ((WebSCADomain)scaDomain).destroy();
             }
+            servletContext.setAttribute(SCA_DOMAIN_ATTRIBUTE, null);
+            scaDomain = null;
         }
+        
+        servletContext = null;
+        instance = null;
+        servlets.clear();
+        LogFactory.release(this.getClass().getClassLoader());
+        Introspector.flushCaches();      
     }
 
     public String getContextPath() {