]> git.argeo.org Git - gpl/argeo-slc.git/blobdiff - runtime/org.argeo.slc.support.osgi/src/main/java/org/argeo/slc/osgi/OsgiExecutionModulesManager.java
Make services lookup more robust
[gpl/argeo-slc.git] / runtime / org.argeo.slc.support.osgi / src / main / java / org / argeo / slc / osgi / OsgiExecutionModulesManager.java
index f2fc44f810f19bbf6d90617442030d7cc4c868ce..5a8d3da5437ac728876c78a536c9910dad0c6ab4 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2010 Mathieu Baudier <mbaudier@argeo.org>
+ * Copyright (C) 2007-2012 Mathieu Baudier
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.argeo.slc.osgi;
 
 import java.lang.management.ManagementFactory;
 import java.util.ArrayList;
+import java.util.Dictionary;
+import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
@@ -46,14 +47,18 @@ import org.argeo.slc.execution.ExecutionModuleDescriptor;
 import org.argeo.slc.execution.ExecutionModulesListener;
 import org.argeo.slc.process.RealizedFlow;
 import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleEvent;
 import org.osgi.framework.BundleException;
+import org.osgi.framework.BundleListener;
 import org.osgi.framework.Constants;
 import org.osgi.framework.launch.Framework;
+import org.springframework.context.ApplicationContext;
 import org.springframework.osgi.service.importer.OsgiServiceLifecycleListener;
 
 /** Execution modules manager implementation based on an OSGi runtime. */
 public class OsgiExecutionModulesManager extends
-               AbstractExecutionModulesManager implements OsgiServiceLifecycleListener {
+               AbstractExecutionModulesManager implements
+               OsgiServiceLifecycleListener, BundleListener {
 
        private final static Log log = LogFactory
                        .getLog(OsgiExecutionModulesManager.class);
@@ -66,9 +71,11 @@ public class OsgiExecutionModulesManager extends
 
        private List<ExecutionModulesListener> executionModulesListeners = new ArrayList<ExecutionModulesListener>();
 
-       private Boolean registerFlowsToJmx = true;
+       private Boolean registerFlowsToJmx = false;
 
        public void init() throws Exception {
+               bundlesManager.getBundleContext().addBundleListener(this);
+
                final String module = System.getProperty(UNIQUE_LAUNCH_MODULE_PROPERTY);
                final String flow = System.getProperty(UNIQUE_LAUNCH_FLOW_PROPERTY);
                if (module != null) {
@@ -76,48 +83,51 @@ public class OsgiExecutionModulesManager extends
                        new Thread("Unique Flow") {
                                @Override
                                public void run() {
-                                       if (log.isDebugEnabled())
-                                               log.debug("Launch unique flow " + flow
-                                                               + " from module " + module);
-                                       try {
-                                               OsgiBundle osgiBundle = bundlesManager
-                                                               .findFromPattern(module);
-                                               Bundle moduleBundle = bundlesManager
-                                                               .findRelatedBundle(osgiBundle);
-                                               bundlesManager.startSynchronous(moduleBundle);
-                                               RealizedFlow lastLaunch = findRealizedFlow(module, flow);
-                                               if (lastLaunch == null)
-                                                       throw new SlcException("Cannot find launch for "
-                                                                       + module + " " + flow);
-                                               execute(lastLaunch);
-                                       } catch (Exception e) {
-                                               log.error("Error in unique flow " + flow
-                                                               + " from module " + module, e);
-                                       } finally {
-                                               if (log.isDebugEnabled())
-                                                       log.debug("Shutdown OSGi runtime...");
-                                               Framework framework = (Framework) bundlesManager
-                                                               .getBundleContext().getBundle(0);
-                                               try {
-                                                       // shutdown framework
-                                                       framework.stop();
-                                                       // wait 1 min for shutdown
-                                                       framework.waitForStop(60 * 1000);
-                                                       // close VM
-                                                       System.exit(0);
-                                               } catch (Exception e) {
-                                                       e.printStackTrace();
-                                                       System.exit(1);
-                                               }
-                                       }
+                                       executeFlowAndExit(module, null, flow);
                                }
                        }.start();
                }
-
        }
 
        public void destroy() {
+               bundlesManager.getBundleContext().removeBundleListener(this);
+       }
 
+       /** Executes a single flow and <b>stops the JVM</b> */
+       protected void executeFlowAndExit(final String module,
+                       final String version, final String flow) {
+               if (log.isDebugEnabled())
+                       log.debug("Launch unique flow " + flow + " from module " + module);
+               try {
+                       OsgiBundle osgiBundle = bundlesManager.findFromPattern(module);
+                       Bundle moduleBundle = bundlesManager.findRelatedBundle(osgiBundle);
+                       bundlesManager.startSynchronous(moduleBundle);
+                       RealizedFlow lastLaunch = findRealizedFlow(module, flow);
+                       if (lastLaunch == null)
+                               throw new SlcException("Cannot find launch for " + module + " "
+                                               + flow);
+                       execute(lastLaunch);
+               } catch (Exception e) {
+                       log.error(
+                                       "Error in unique flow " + flow + " from module " + module,
+                                       e);
+               } finally {
+                       if (log.isDebugEnabled())
+                               log.debug("Shutdown OSGi runtime...");
+                       Framework framework = (Framework) bundlesManager.getBundleContext()
+                                       .getBundle(0);
+                       try {
+                               // shutdown framework
+                               framework.stop();
+                               // wait 1 min for shutdown
+                               framework.waitForStop(60 * 1000);
+                               // close VM
+                               System.exit(0);
+                       } catch (Exception e) {
+                               e.printStackTrace();
+                               System.exit(1);
+                       }
+               }
        }
 
        public synchronized ExecutionModuleDescriptor getExecutionModuleDescriptor(
@@ -179,28 +189,41 @@ public class OsgiExecutionModulesManager extends
 
        protected ExecutionFlow findExecutionFlow(String moduleName,
                        String moduleVersion, String flowName) {
-               String filter = "(&(Bundle-SymbolicName=" + moduleName
-                               + ")(org.springframework.osgi.bean.name=" + flowName + "))";
+               String filter = moduleVersion == null || moduleVersion.equals("0.0.0") ? "(&(Bundle-SymbolicName="
+                               + moduleName
+                               + ")(org.springframework.osgi.bean.name="
+                               + flowName + "))"
+                               : "(&(Bundle-SymbolicName=" + moduleName + ")(Bundle-Version="
+                                               + moduleVersion
+                                               + ")(org.springframework.osgi.bean.name=" + flowName
+                                               + "))";
                return bundlesManager.getSingleServiceStrict(ExecutionFlow.class,
                                filter, true);
        }
 
        protected ExecutionContext findExecutionContext(String moduleName,
                        String moduleVersion) {
-               String filter = "(&(Bundle-SymbolicName=" + moduleName
-                               + ")(Bundle-Version=" + moduleVersion + "))";
+               String filter = moduleFilter(moduleName, moduleVersion);
                return bundlesManager.getSingleServiceStrict(ExecutionContext.class,
                                filter, true);
        }
 
        protected ExecutionFlowDescriptorConverter findExecutionFlowDescriptorConverter(
                        String moduleName, String moduleVersion) {
-               String filter = "(&(Bundle-SymbolicName=" + moduleName
-                               + ")(Bundle-Version=" + moduleVersion + "))";
+               String filter = moduleFilter(moduleName, moduleVersion);
                return bundlesManager.getSingleService(
                                ExecutionFlowDescriptorConverter.class, filter, false);
        }
 
+       /** Only based on symbolic name if version is null or "0.0.0" */
+       protected String moduleFilter(String moduleName, String moduleVersion) {
+               return moduleVersion == null || moduleVersion.equals("0.0.0") ? "(Bundle-SymbolicName="
+                               + moduleName + ")"
+                               : "(&(Bundle-SymbolicName=" + moduleName + ")(Bundle-Version="
+                                               + moduleVersion + "))";
+
+       }
+
        /**
         * Builds a minimal realized flow, based on the provided information
         * (typically from the command line).
@@ -281,12 +304,41 @@ public class OsgiExecutionModulesManager extends
                try {
                        Bundle bundle = bundlesManager.findRelatedBundle(new OsgiBundle(
                                        nameVersion));
+                       if (bundle == null)
+                               throw new SlcException("Counld not find bundle for "
+                                               + nameVersion);
+
                        bundlesManager.startSynchronous(bundle);
-               } catch (BundleException e) {
+                       if (isSpringInstrumented(bundle)) {
+                               // Wait for Spring application context to be ready
+                               String filter = "(Bundle-SymbolicName="
+                                               + bundle.getSymbolicName() + ")";
+                               try {
+                                       bundlesManager.getServiceRefSynchronous(
+                                                       ApplicationContext.class.getName(), filter);
+                               } catch (Exception e) {
+                                       // stop if application context not found
+                                       bundle.stop();
+                                       throw e;
+                               }
+                       }
+               } catch (Exception e) {
                        throw new SlcException("Cannot start " + nameVersion, e);
                }
        }
 
+       /** Do it calmly in order to avoid NPE */
+       private Boolean isSpringInstrumented(Bundle bundle) {
+               Dictionary<?, ?> headers = bundle.getHeaders();
+               if (headers != null && headers.get("Spring-Context") != null)
+                       return true;
+               Enumeration<?> springEntryPaths = bundle
+                               .getEntryPaths("/META-INF/spring");
+               if (springEntryPaths != null && springEntryPaths.hasMoreElements())
+                       return true;
+               return false;
+       }
+
        public void stop(NameVersion nameVersion) {
                try {
                        Bundle bundle = bundlesManager.findRelatedBundle(new OsgiBundle(
@@ -322,6 +374,23 @@ public class OsgiExecutionModulesManager extends
                md.setVersion(getHeaderSafe(bdl, Constants.BUNDLE_VERSION));
                md.setTitle(getHeaderSafe(bdl, Constants.BUNDLE_NAME));
                md.setDescription(getHeaderSafe(bdl, Constants.BUNDLE_DESCRIPTION));
+
+               // copy manifets header to meta data
+               Dictionary<?, ?> headers = bundle.getHeaders();
+               Enumeration<?> keys = headers.keys();
+               while (keys.hasMoreElements()) {
+                       Object key = keys.nextElement();
+                       Object value = headers.get(key);
+                       if (value != null)
+                               md.getMetadata().put(key.toString(), value.toString());
+               }
+
+               // check if started
+               if (bundle.getState() == Bundle.ACTIVE
+                               || bundle.getState() == Bundle.STARTING)
+                       md.setStarted(true);
+               else
+                       md.setStarted(false);
        }
 
        private String getHeaderSafe(Bundle bundle, Object key) {
@@ -348,8 +417,10 @@ public class OsgiExecutionModulesManager extends
                if (log.isTraceEnabled())
                        log.trace("Registered execution context from " + osgiBundle);
                // Notify
+               ModuleDescriptor md = osgiBundle.getModuleDescriptor();
+               md.setStarted(true);
                for (ExecutionModulesListener listener : executionModulesListeners)
-                       listener.executionModuleAdded(osgiBundle.getModuleDescriptor());
+                       listener.executionModuleAdded(md);
        }
 
        /** Unregisters an execution context. */
@@ -361,9 +432,10 @@ public class OsgiExecutionModulesManager extends
                        if (log.isTraceEnabled())
                                log.trace("Removed execution context from " + osgiBundle);
                        // Notify
+                       ModuleDescriptor md = osgiBundle.getModuleDescriptor();
+                       md.setStarted(false);
                        for (ExecutionModulesListener listener : executionModulesListeners)
-                               listener.executionModuleRemoved(osgiBundle
-                                               .getModuleDescriptor());
+                               listener.executionModuleRemoved(md);
                }
        }
 
@@ -438,6 +510,27 @@ public class OsgiExecutionModulesManager extends
                executionModulesListeners.remove(executionModulesListener);
        }
 
+       /*
+        * INTERFACE IMPLEMENTATIONS
+        */
+
+       public void bundleChanged(BundleEvent evt) {
+               Bundle bundle = evt.getBundle();
+               if (bundle.getHeaders().get(
+                               ExecutionModuleDescriptor.SLC_EXECUTION_MODULE) != null) {
+                       OsgiBundle osgiBundle = new OsgiBundle(bundle);
+                       if (evt.getType() == BundleEvent.INSTALLED)
+                               for (ExecutionModulesListener listener : executionModulesListeners)
+                                       listener.executionModuleAdded(osgiBundle
+                                                       .getModuleDescriptor());
+                       else if (evt.getType() == BundleEvent.UNINSTALLED)
+                               for (ExecutionModulesListener listener : executionModulesListeners)
+                                       listener.executionModuleRemoved(osgiBundle
+                                                       .getModuleDescriptor());
+               }
+
+       }
+
        @SuppressWarnings({ "rawtypes" })
        public synchronized void bind(Object service, Map properties)
                        throws Exception {