opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/osgi/mapping/ModuleInfoBundleTracker.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.mapping;
   9
  10 import org.apache.commons.io.IOUtils;
  11 import org.opendaylight.yangtools.concepts.Registration;
  12 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
  13 import org.opendaylight.yangtools.sal.binding.generator.impl.ModuleInfoBackedContext;
  14 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
  15 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  16 import org.osgi.framework.Bundle;
  17 import org.osgi.framework.BundleEvent;
  18 import org.osgi.util.tracker.BundleTrackerCustomizer;
  19 import org.slf4j.Logger;
  20 import org.slf4j.LoggerFactory;
  21
  22 import java.io.InputStream;
  23 import java.lang.reflect.InvocationTargetException;
  24 import java.net.URL;
  25 import java.util.Collection;
  26 import java.util.LinkedList;
  27 import java.util.List;
  28
  29 import static java.lang.String.format;
  30
  31 /**
  32  * Tracks bundles and attempts to retrieve YangModuleInfo.
  33  */
  34 public final class ModuleInfoBundleTracker implements BundleTrackerCustomizer<Collection<Registration<YangModuleInfo>>> {
  35
  36     private static final Logger logger = LoggerFactory.getLogger(ModuleInfoBundleTracker.class);
  37     public static final String GET_MODULE_INFO_METHOD = "getModuleInfo";
  38
  39     public static final String MODULE_INFO_PROVIDER_PATH_PREFIX = "META-INF/services/";
  40
  41     private ModuleInfoBackedContext moduleInfoLoadingStrategy = ModuleInfoBackedContext.create();
  42
  43     public GeneratedClassLoadingStrategy getModuleInfoLoadingStrategy() {
  44         return moduleInfoLoadingStrategy;
  45     }
  46
  47     @Override
  48     public Collection<Registration<YangModuleInfo>> addingBundle(Bundle bundle, BundleEvent event) {
  49         URL resource = bundle.getEntry(MODULE_INFO_PROVIDER_PATH_PREFIX + YangModelBindingProvider.class.getName());
  50
  51         if(resource==null) {
  52             return null;
  53         }
  54
  55         List<Registration<YangModuleInfo>> registrations = new LinkedList<>();
  56
  57         try (InputStream inputStream = resource.openStream()) {
  58             List<String> lines = IOUtils.readLines(inputStream);
  59             for (String moduleInfoName : lines) {
  60                 YangModuleInfo moduleInfo = retrieveModuleInfo(moduleInfoName, bundle);
  61                 registrations.add(moduleInfoLoadingStrategy.registerModuleInfo(moduleInfo));
  62             }
  63
  64
  65         } catch (Exception e) {
  66             logger.error("Error while reading {}", resource, e);
  67             throw new RuntimeException(e);
  68         }
  69
  70         return registrations;
  71     }
  72
  73     @Override
  74     public void modifiedBundle(Bundle bundle, BundleEvent event, Collection<Registration<YangModuleInfo>> object) {
  75         // NOOP
  76     }
  77
  78     @Override
  79     public void removedBundle(Bundle bundle, BundleEvent event, Collection<Registration<YangModuleInfo>> regs) {
  80         if(regs == null) {
  81             return;
  82         }
  83
  84         for (Registration<YangModuleInfo> reg : regs) {
  85             try {
  86                 reg.close();
  87             } catch (Exception e) {
  88                 throw new RuntimeException("Unable to unregister YangModuleInfo " + reg.getInstance(), e);
  89             }
  90         }
  91     }
  92
  93     private static YangModuleInfo retrieveModuleInfo(String moduleInfoClass, Bundle bundle) {
  94         String errorMessage;
  95         Class<?> clazz = loadClass(moduleInfoClass, bundle);
  96
  97         if (YangModelBindingProvider.class.isAssignableFrom(clazz) == false) {
  98             errorMessage = logMessage("Class {} does not implement {} in bundle {}", clazz, YangModelBindingProvider.class, bundle);
  99             throw new IllegalStateException(errorMessage);
 100         }
 101
 102         try {
 103             Object instance = clazz.newInstance();
 104             Object result = clazz.getMethod(GET_MODULE_INFO_METHOD).invoke(instance);
 105
 106             if (YangModuleInfo.class.isAssignableFrom(result.getClass()) == false) {
 107                 errorMessage = logMessage("Error invoking method not found {} in bundle {}, reason {}",
 108                         GET_MODULE_INFO_METHOD, bundle, "Not assignable from " + YangModuleInfo.class);
 109             } else {
 110                 return (YangModuleInfo) result;
 111             }
 112
 113         } catch (InstantiationException e) {
 114             errorMessage = logMessage("Could not instantiate {} in bundle {}, reason {}", moduleInfoClass, bundle, e);
 115         } catch (IllegalAccessException e) {
 116             errorMessage = logMessage("Illegal access during instatiation of class {} in bundle {}, reason {}",
 117                     moduleInfoClass, bundle, e);
 118         } catch (NoSuchMethodException e) {
 119             errorMessage = logMessage("Method not found {} in bundle {}, reason {}", GET_MODULE_INFO_METHOD, bundle, e);
 120         } catch (InvocationTargetException e) {
 121             errorMessage = logMessage("Error invoking method {} in bundle {}, reason {}", GET_MODULE_INFO_METHOD,
 122                     bundle, e);
 123         }
 124
 125         throw new IllegalStateException(errorMessage);
 126     }
 127
 128     private static Class<?> loadClass(String moduleInfoClass, Bundle bundle) {
 129         try {
 130             return bundle.loadClass(moduleInfoClass);
 131         } catch (ClassNotFoundException e) {
 132             String errorMessage = logMessage("Could not find class {} in bunde {}, reason {}", moduleInfoClass, bundle, e);
 133             throw new IllegalStateException(errorMessage);
 134         }
 135     }
 136
 137     public static String logMessage(String slfMessage, Object... params) {
 138         logger.info(slfMessage, params);
 139         String formatMessage = slfMessage.replaceAll("\\{\\}", "%s");
 140         return format(formatMessage, params);
 141     }
 142 }