opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/AbstractBrokerAwareActivator.java

   1 /*
   2  * Copyright (c) 2014 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.sal.binding.api;
   9
  10 import java.util.concurrent.ExecutorService;
  11 import java.util.concurrent.Executors;
  12 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
  13 import org.osgi.framework.BundleActivator;
  14 import org.osgi.framework.BundleContext;
  15 import org.osgi.framework.ServiceReference;
  16 import org.osgi.util.tracker.ServiceTracker;
  17 import org.osgi.util.tracker.ServiceTrackerCustomizer;
  18
  19 public abstract class AbstractBrokerAwareActivator implements BundleActivator {
  20
  21     private static final ExecutorService MD_ACTIVATION_POOL = Executors.newCachedThreadPool();
  22     private BundleContext context;
  23     private ServiceTracker<BindingAwareBroker, BindingAwareBroker> tracker;
  24     private BindingAwareBroker broker;
  25     private final ServiceTrackerCustomizer<BindingAwareBroker, BindingAwareBroker> customizer =
  26             new ServiceTrackerCustomizer<BindingAwareBroker, BindingAwareBroker>() {
  27
  28         @Override
  29         public BindingAwareBroker addingService(ServiceReference<BindingAwareBroker> reference) {
  30             broker = context.getService(reference);
  31             MD_ACTIVATION_POOL.execute(() -> onBrokerAvailable(broker, context));
  32             return broker;
  33         }
  34
  35         @Override
  36         public void modifiedService(ServiceReference<BindingAwareBroker> reference, BindingAwareBroker service) {
  37             removedService(reference, service);
  38             addingService(reference);
  39         }
  40
  41         @Override
  42         public void removedService(ServiceReference<BindingAwareBroker> reference, BindingAwareBroker service) {
  43             broker = context.getService(reference);
  44             MD_ACTIVATION_POOL.execute(() -> onBrokerRemoved(broker, context));
  45         }
  46
  47     };
  48
  49
  50     @Override
  51     public final void start(BundleContext bundleContext) throws Exception {
  52         this.context = bundleContext;
  53         startImpl(bundleContext);
  54         tracker = new ServiceTracker<>(bundleContext, BindingAwareBroker.class, customizer);
  55         tracker.open();
  56
  57     }
  58
  59
  60
  61     @Override
  62     public final  void stop(BundleContext bundleContext) throws Exception {
  63         tracker.close();
  64         stopImpl(bundleContext);
  65     }
  66
  67     /**
  68      * Called when this bundle is started (before
  69      * {@link BindingAwareProvider#onSessionInitiated(ProviderContext)} so the Framework can perform
  70      * the bundle-specific activities necessary to start this bundle. This
  71      * method can be used to register services or to allocate any resources that
  72      * this bundle needs.
  73      *
  74      * <p>
  75      * This method must complete and return to its caller in a timely manner.
  76      *
  77      * @param bundleContext
  78      *            The execution context of the bundle being started.
  79      * @throws RuntimeException
  80      *             If this method throws an exception, this bundle is marked as
  81      *             stopped and the Framework will remove this bundle's
  82      *             listeners, unregister all services registered by this bundle,
  83      *             and release all services used by this bundle.
  84      */
  85     protected void startImpl(BundleContext bundleContext) {
  86         // NOOP
  87     }
  88
  89     /**
  90      * Called when this bundle is stopped so the Framework can perform the
  91      * bundle-specific activities necessary to stop the bundle. In general, this
  92      * method should undo the work that the {@code BundleActivator.start} method
  93      * started. There should be no active threads that were started by this
  94      * bundle when this bundle returns. A stopped bundle must not call any
  95      * Framework objects.
  96      *
  97      * <p>
  98      * This method must complete and return to its caller in a timely manner.
  99      *
 100      * @param bundleContext The execution context of the bundle being stopped.
 101      * @throws RuntimeException If this method throws an exception, the bundle is still
 102      *         marked as stopped, and the Framework will remove the bundle's
 103      *         listeners, unregister all services registered by the bundle, and
 104      *         release all services used by the bundle.
 105      */
 106     protected void stopImpl(BundleContext bundleContext) {
 107         // NOOP
 108     }
 109
 110     protected abstract void onBrokerAvailable(BindingAwareBroker bindingBroker, BundleContext bundleContext);
 111
 112     protected void onBrokerRemoved(BindingAwareBroker bindingBroker, BundleContext bundleContext) {
 113         stopImpl(bundleContext);
 114     }
 115 }