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