opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/factoriesresolver/HierarchicalConfigMBeanFactoriesHolder.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.factoriesresolver;
   9
  10
  11 import org.opendaylight.controller.config.spi.ModuleFactory;
  12 import org.osgi.framework.BundleContext;
  13 import org.slf4j.Logger;
  14 import org.slf4j.LoggerFactory;
  15
  16 import java.util.Map.Entry;
  17 import java.util.Set;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Collections;
  21 import java.util.TreeSet;
  22 import java.util.Collection;
  23 import java.util.ArrayList;
  24
  25 /**
  26  * Hold sorted ConfigMBeanFactories by their module names. Check that module
  27  * names are globally unique.
  28  */
  29 public class HierarchicalConfigMBeanFactoriesHolder {
  30     private static final Logger logger = LoggerFactory
  31             .getLogger(HierarchicalConfigMBeanFactoriesHolder.class);
  32
  33     private final Map<String, Map.Entry<ModuleFactory, BundleContext>> moduleNamesToConfigBeanFactories;
  34     private final Set<String> moduleNames;
  35     private final List<ModuleFactory> moduleFactories;
  36
  37     /**
  38      * Create instance.
  39      *
  40      * @throws IllegalArgumentException
  41      *             if unique constraint on module names is violated
  42      */
  43     public HierarchicalConfigMBeanFactoriesHolder(
  44             Map<String, Map.Entry<ModuleFactory, BundleContext>> factoriesMap) {
  45         this.moduleNamesToConfigBeanFactories = Collections
  46                 .unmodifiableMap(factoriesMap);
  47         moduleNames = Collections.unmodifiableSet(new TreeSet<>(
  48                 moduleNamesToConfigBeanFactories.keySet()));
  49         List<ModuleFactory> factories = new ArrayList<>(this.moduleNamesToConfigBeanFactories.size());
  50         Collection<Map.Entry<ModuleFactory, BundleContext>> entryCollection = this.moduleNamesToConfigBeanFactories.values();
  51         for (Map.Entry<ModuleFactory, BundleContext> entry : entryCollection) {
  52             factories.add(entry.getKey());
  53         }
  54         this.moduleFactories = Collections.unmodifiableList(factories);
  55     }
  56
  57     /**
  58      * Get ModuleFactory by their name.
  59      *
  60      * @throws IllegalArgumentException
  61      *             if factory is not found
  62      */
  63     public ModuleFactory findByModuleName(String moduleName) {
  64         Map.Entry<ModuleFactory, BundleContext> result = moduleNamesToConfigBeanFactories.get(moduleName);
  65         if (result == null) {
  66             throw new IllegalArgumentException(
  67                     "ModuleFactory not found with module name: " + moduleName);
  68         }
  69         return result.getKey();
  70     }
  71
  72     public Set<String> getModuleNames() {
  73         return moduleNames;
  74     }
  75
  76     public List<ModuleFactory> getModuleFactories() {
  77         return moduleFactories;
  78     }
  79
  80     public Map<String, Entry<ModuleFactory, BundleContext>> getModuleNamesToConfigBeanFactories() {
  81         return moduleNamesToConfigBeanFactories;
  82     }
  83 }