opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/osgi/ConfigManagerActivator.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.config.manager.impl.osgi;
   9
  10 import java.lang.management.ManagementFactory;
  11 import java.util.Arrays;
  12 import java.util.Collection;
  13 import java.util.List;
  14 import javax.management.InstanceAlreadyExistsException;
  15 import javax.management.MBeanServer;
  16 import org.opendaylight.controller.config.api.ConfigRegistry;
  17 import org.opendaylight.controller.config.api.ConfigSystemService;
  18 import org.opendaylight.controller.config.manager.impl.ConfigRegistryImpl;
  19 import org.opendaylight.controller.config.manager.impl.jmx.ConfigRegistryJMXRegistrator;
  20 import org.opendaylight.controller.config.manager.impl.jmx.JMXNotifierConfigRegistry;
  21 import org.opendaylight.controller.config.manager.impl.osgi.mapping.BindingContextProvider;
  22 import org.opendaylight.controller.config.manager.impl.osgi.mapping.ModuleInfoBundleTracker;
  23 import org.opendaylight.controller.config.manager.impl.osgi.mapping.RefreshingSCPModuleInfoRegistry;
  24 import org.opendaylight.controller.config.manager.impl.util.OsgiRegistrationUtil;
  25 import org.opendaylight.controller.config.spi.ModuleFactory;
  26 import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
  27 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  28 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  29 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  30 import org.osgi.framework.Bundle;
  31 import org.osgi.framework.BundleActivator;
  32 import org.osgi.framework.BundleContext;
  33 import org.osgi.framework.BundleEvent;
  34 import org.osgi.framework.SynchronousBundleListener;
  35 import org.osgi.util.tracker.BundleTracker;
  36 import org.osgi.util.tracker.ServiceTracker;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 public class ConfigManagerActivator implements BundleActivator, SynchronousBundleListener, ConfigSystemService {
  41
  42     private static final Logger LOG = LoggerFactory.getLogger(ConfigManagerActivator.class);
  43
  44     private static final long SYSTEM_BUNDLE_ID = 0;
  45
  46     private final MBeanServer configMBeanServer = ManagementFactory.getPlatformMBeanServer();
  47
  48     private AutoCloseable autoCloseable;
  49
  50     private ConfigRegistryImpl configRegistry;
  51
  52     @Override
  53     public void start(final BundleContext context) {
  54         LOG.info("Config manager starting...");
  55         try {
  56             // the inner strategy is backed by thread context cl?
  57             final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
  58
  59             final BindingContextProvider bindingContextProvider = new BindingContextProvider();
  60
  61             final RefreshingSCPModuleInfoRegistry moduleInfoRegistryWrapper = new RefreshingSCPModuleInfoRegistry(
  62                     moduleInfoBackedContext, moduleInfoBackedContext, moduleInfoBackedContext, moduleInfoBackedContext, bindingContextProvider, context);
  63
  64             final ModuleInfoBundleTracker moduleInfoBundleTracker = new ModuleInfoBundleTracker(context, moduleInfoRegistryWrapper);
  65
  66             // start config registry
  67             final BundleContextBackedModuleFactoriesResolver bundleContextBackedModuleFactoriesResolver = new BundleContextBackedModuleFactoriesResolver(
  68                     context);
  69             this.configRegistry = new ConfigRegistryImpl(bundleContextBackedModuleFactoriesResolver, this.configMBeanServer,
  70                     bindingContextProvider);
  71
  72             // track bundles containing factories
  73             final BlankTransactionServiceTracker blankTransactionServiceTracker = new BlankTransactionServiceTracker(
  74                     this.configRegistry);
  75             final ModuleFactoryBundleTracker moduleFactoryTracker = new ModuleFactoryBundleTracker(
  76                     blankTransactionServiceTracker);
  77
  78             final boolean scanResolvedBundlesForModuleInfo = true;
  79             BundleTracker<Collection<ObjectRegistration<YangModuleInfo>>> moduleInfoResolvedBundleTracker = null;
  80             ExtensibleBundleTracker<?> moduleFactoryBundleTracker;
  81             if(scanResolvedBundlesForModuleInfo) {
  82                 moduleInfoResolvedBundleTracker = new BundleTracker<>(context, Bundle.RESOLVED | Bundle.STARTING |
  83                             Bundle.STOPPING | Bundle.ACTIVE, moduleInfoBundleTracker);
  84                 moduleFactoryBundleTracker = new ExtensibleBundleTracker<>(context, moduleFactoryTracker);
  85             } else {
  86                 moduleFactoryBundleTracker = new ExtensibleBundleTracker<>(context,
  87                         moduleFactoryTracker, moduleInfoBundleTracker);
  88             }
  89
  90             moduleInfoBundleTracker.open(moduleInfoResolvedBundleTracker);
  91
  92             // start extensible tracker
  93             moduleFactoryBundleTracker.open();
  94
  95             // Wrap config registry with JMX notification publishing adapter
  96             final JMXNotifierConfigRegistry notifyingConfigRegistry =
  97                     new JMXNotifierConfigRegistry(this.configRegistry, this.configMBeanServer);
  98
  99             // register config registry to OSGi
 100             final AutoCloseable clsReg = OsgiRegistrationUtil.registerService(context, moduleInfoBackedContext, ClassLoadingStrategy.class);
 101             final AutoCloseable configRegReg = OsgiRegistrationUtil.registerService(context, notifyingConfigRegistry, ConfigRegistry.class);
 102
 103             // register config registry to jmx
 104             final ConfigRegistryJMXRegistrator configRegistryJMXRegistrator = new ConfigRegistryJMXRegistrator(this.configMBeanServer);
 105             try {
 106                 configRegistryJMXRegistrator.registerToJMXNoNotifications(this.configRegistry);
 107             } catch (final InstanceAlreadyExistsException e) {
 108                 configRegistryJMXRegistrator.close();
 109                 throw new IllegalStateException("Config Registry was already registered to JMX", e);
 110             }
 111
 112             // register config registry to jmx
 113             final ConfigRegistryJMXRegistrator configRegistryJMXRegistratorWithNotifications = new ConfigRegistryJMXRegistrator(this.configMBeanServer);
 114             try {
 115                 configRegistryJMXRegistrator.registerToJMX(notifyingConfigRegistry);
 116             } catch (final InstanceAlreadyExistsException e) {
 117                 configRegistryJMXRegistrator.close();
 118                 configRegistryJMXRegistratorWithNotifications.close();
 119                 throw new IllegalStateException("Config Registry was already registered to JMX", e);
 120             }
 121
 122             // TODO wire directly via moduleInfoBundleTracker
 123             final ServiceTracker<ModuleFactory, Object> serviceTracker = new ServiceTracker<>(context, ModuleFactory.class,
 124                     blankTransactionServiceTracker);
 125             serviceTracker.open();
 126
 127             final AutoCloseable configMgrReg = OsgiRegistrationUtil.registerService(context, this, ConfigSystemService.class);
 128
 129             final List<AutoCloseable> list = Arrays.asList(bindingContextProvider, clsReg,
 130                     OsgiRegistrationUtil.wrap(moduleFactoryBundleTracker), moduleInfoBundleTracker,
 131                     configRegReg, configRegistryJMXRegistrator, configRegistryJMXRegistratorWithNotifications,
 132                     OsgiRegistrationUtil.wrap(serviceTracker), moduleInfoRegistryWrapper, notifyingConfigRegistry, configMgrReg);
 133             this.autoCloseable = OsgiRegistrationUtil.aggregate(list);
 134
 135             context.addBundleListener(this);
 136         } catch(final Exception e) {
 137             LOG.error("Error starting config manager", e);
 138         } catch(final Error e) {
 139             // Log JVM Error and re-throw. The OSGi container may silently fail the bundle and not always log
 140             // the exception. This has been seen on initial feature install.
 141             LOG.error("Error starting config manager", e);
 142             throw e;
 143         }
 144
 145         LOG.info("Config manager start complete");
 146     }
 147
 148     @Override
 149     public void stop(final BundleContext context) throws Exception {
 150         LOG.info("Config manager stopping");
 151         context.removeBundleListener(this);
 152         this.autoCloseable.close();
 153     }
 154
 155     @Override
 156     public void bundleChanged(final BundleEvent event) {
 157         if(this.configRegistry == null) {
 158             return;
 159         }
 160
 161         // If the system bundle (id 0) is stopping close the ConfigRegistry so it destroys all modules. On
 162         // shutdown the system bundle is stopped first.
 163         if(event.getBundle().getBundleId() == SYSTEM_BUNDLE_ID && event.getType() == BundleEvent.STOPPING) {
 164             this.configRegistry.close();
 165         }
 166     }
 167
 168     @Override
 169     public void closeAllConfigModules() {
 170         if(this.configRegistry != null) {
 171             this.configRegistry.close();
 172         }
 173     }
 174 }