2 * Copyright (c) 2013, 2017 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.config.manager.impl.osgi;
10 import java.util.AbstractMap;
11 import java.util.Collection;
12 import java.util.HashMap;
14 import org.opendaylight.controller.config.manager.impl.factoriesresolver.ModuleFactoriesResolver;
15 import org.opendaylight.controller.config.spi.ModuleFactory;
16 import org.osgi.framework.BundleContext;
17 import org.osgi.framework.InvalidSyntaxException;
18 import org.osgi.framework.ServiceReference;
19 import org.slf4j.Logger;
20 import org.slf4j.LoggerFactory;
23 * Retrieves list of currently registered Module Factories using bundlecontext.
25 public class BundleContextBackedModuleFactoriesResolver implements ModuleFactoriesResolver {
26 private static final Logger LOG = LoggerFactory.getLogger(BundleContextBackedModuleFactoriesResolver.class);
27 private final BundleContext bundleContext;
29 public BundleContextBackedModuleFactoriesResolver(final BundleContext bundleContext) {
30 this.bundleContext = bundleContext;
34 public Map<String, Map.Entry<ModuleFactory, BundleContext>> getAllFactories() {
35 Collection<ServiceReference<ModuleFactory>> serviceReferences;
37 serviceReferences = bundleContext.getServiceReferences(ModuleFactory.class, null);
38 } catch (final InvalidSyntaxException e) {
39 throw new IllegalStateException(e);
41 Map<String, Map.Entry<ModuleFactory, BundleContext>> result = new HashMap<>(serviceReferences.size());
42 for (ServiceReference<ModuleFactory> serviceReference : serviceReferences) {
43 ModuleFactory factory = bundleContext.getService(serviceReference);
44 // null if the service is not registered, the service object
45 // returned by a ServiceFactory does not
46 // implement the classes under which it was registered or the
47 // ServiceFactory threw an exception.
48 if (factory == null) {
49 throw new NullPointerException(
50 "ServiceReference of class" + serviceReference.getClass() + "not found.");
53 String moduleName = factory.getImplementationName();
54 if (moduleName == null || moduleName.isEmpty()) {
55 throw new IllegalStateException("Invalid implementation name for " + factory);
57 if (serviceReference.getBundle() == null || serviceReference.getBundle().getBundleContext() == null) {
58 throw new NullPointerException("Bundle context of " + factory + " ModuleFactory not found.");
60 LOG.debug("Reading factory {} {}", moduleName, factory);
62 Map.Entry<ModuleFactory, BundleContext> conflicting = result.get(moduleName);
63 if (conflicting != null) {
64 String error = String.format(
65 "Module name is not unique. Found two conflicting factories with same name '%s': '%s' '%s'",
66 moduleName, conflicting.getKey(), factory);
68 throw new IllegalArgumentException(error);
71 result.put(moduleName,
72 new AbstractMap.SimpleImmutableEntry<>(factory, serviceReference.getBundle().getBundleContext()));