opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/ConfigRegistryImpl.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;
   9
  10 import com.google.common.collect.Maps;
  11 import java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.Collections;
  14 import java.util.HashMap;
  15 import java.util.Iterator;
  16 import java.util.LinkedList;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Map.Entry;
  20 import java.util.Set;
  21 import javax.annotation.concurrent.GuardedBy;
  22 import javax.annotation.concurrent.NotThreadSafe;
  23 import javax.annotation.concurrent.ThreadSafe;
  24 import javax.management.InstanceAlreadyExistsException;
  25 import javax.management.InstanceNotFoundException;
  26 import javax.management.MBeanServer;
  27 import javax.management.MBeanServerFactory;
  28 import javax.management.ObjectName;
  29 import org.opendaylight.controller.config.api.ConflictingVersionException;
  30 import org.opendaylight.controller.config.api.ModuleIdentifier;
  31 import org.opendaylight.controller.config.api.RuntimeBeanRegistratorAwareModule;
  32 import org.opendaylight.controller.config.api.ValidationException;
  33 import org.opendaylight.controller.config.api.annotations.ServiceInterfaceAnnotation;
  34 import org.opendaylight.controller.config.api.jmx.CommitStatus;
  35 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
  36 import org.opendaylight.controller.config.manager.impl.dependencyresolver.DestroyedModule;
  37 import org.opendaylight.controller.config.manager.impl.dependencyresolver.ModuleInternalTransactionalInfo;
  38 import org.opendaylight.controller.config.manager.impl.dynamicmbean.DynamicReadableWrapper;
  39 import org.opendaylight.controller.config.manager.impl.factoriesresolver.HierarchicalConfigMBeanFactoriesHolder;
  40 import org.opendaylight.controller.config.manager.impl.factoriesresolver.ModuleFactoriesResolver;
  41 import org.opendaylight.controller.config.manager.impl.jmx.BaseJMXRegistrator;
  42 import org.opendaylight.controller.config.manager.impl.jmx.ModuleJMXRegistrator;
  43 import org.opendaylight.controller.config.manager.impl.jmx.RootRuntimeBeanRegistratorImpl;
  44 import org.opendaylight.controller.config.manager.impl.jmx.TransactionJMXRegistrator;
  45 import org.opendaylight.controller.config.manager.impl.osgi.BeanToOsgiServiceManager;
  46 import org.opendaylight.controller.config.manager.impl.osgi.BeanToOsgiServiceManager.OsgiRegistration;
  47 import org.opendaylight.controller.config.manager.impl.osgi.mapping.BindingContextProvider;
  48 import org.opendaylight.controller.config.manager.impl.util.LookupBeansUtil;
  49 import org.opendaylight.controller.config.manager.impl.util.ModuleQNameUtil;
  50 import org.opendaylight.controller.config.spi.Module;
  51 import org.opendaylight.controller.config.spi.ModuleFactory;
  52 import org.osgi.framework.BundleContext;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 /**
  57  * Singleton that is responsible for creating and committing Config
  58  * Transactions. It is registered in Platform MBean Server.
  59  */
  60 @ThreadSafe
  61 public class ConfigRegistryImpl implements AutoCloseable, ConfigRegistryImplMXBean {
  62     private static final Logger LOG = LoggerFactory.getLogger(ConfigRegistryImpl.class);
  63
  64     private final ModuleFactoriesResolver resolver;
  65     private final MBeanServer configMBeanServer;
  66     private final BindingContextProvider bindingContextProvider;
  67
  68     @GuardedBy("this")
  69     private long version = 0;
  70     @GuardedBy("this")
  71     private long versionCounter = 0;
  72
  73     /**
  74      * Contains current configuration in form of {moduleName:{instanceName,read
  75      * only module}} for copying state to new transaction. Each running module
  76      * is present just once, no matter how many interfaces it exposes.
  77      */
  78     @GuardedBy("this")
  79     private final ConfigHolder currentConfig = new ConfigHolder();
  80
  81     /**
  82      * Will return true unless there was a transaction that succeeded during
  83      * validation but failed in second phase of commit. In this case the server
  84      * is unstable and its state is undefined.
  85      */
  86     @GuardedBy("this")
  87     private boolean isHealthy = true;
  88
  89     /**
  90      * Holds Map<transactionName, transactionController> and purges it each time
  91      * its content is requested.
  92      */
  93     @GuardedBy("this")
  94     private final TransactionsHolder transactionsHolder = new TransactionsHolder();
  95
  96     private final BaseJMXRegistrator baseJMXRegistrator;
  97
  98     private final BeanToOsgiServiceManager beanToOsgiServiceManager;
  99
 100     // internal jmx server for read only beans
 101     private final MBeanServer registryMBeanServer;
 102     // internal jmx server shared by all transactions
 103     private final MBeanServer transactionsMBeanServer;
 104
 105     // Used for finding new factory instances for default module functionality
 106     @GuardedBy("this")
 107     private List<ModuleFactory> lastListOfFactories = Collections.emptyList();
 108
 109     @GuardedBy("this") // switched in every 2ndPC
 110     private CloseableServiceReferenceReadableRegistry readableSRRegistry = ServiceReferenceRegistryImpl.createInitialSRLookupRegistry();
 111
 112     // constructor
 113     public ConfigRegistryImpl(ModuleFactoriesResolver resolver,
 114                               MBeanServer configMBeanServer, BindingContextProvider bindingContextProvider) {
 115         this(resolver, configMBeanServer,
 116                 new BaseJMXRegistrator(configMBeanServer), bindingContextProvider);
 117     }
 118
 119     // constructor
 120     public ConfigRegistryImpl(ModuleFactoriesResolver resolver,
 121                               MBeanServer configMBeanServer,
 122                               BaseJMXRegistrator baseJMXRegistrator, BindingContextProvider bindingContextProvider) {
 123         this.resolver = resolver;
 124         this.beanToOsgiServiceManager = new BeanToOsgiServiceManager();
 125         this.configMBeanServer = configMBeanServer;
 126         this.baseJMXRegistrator = baseJMXRegistrator;
 127         this.bindingContextProvider = bindingContextProvider;
 128         this.registryMBeanServer = MBeanServerFactory
 129                 .createMBeanServer("ConfigRegistry" + configMBeanServer.getDefaultDomain());
 130         this.transactionsMBeanServer = MBeanServerFactory
 131                 .createMBeanServer("ConfigTransactions" + configMBeanServer.getDefaultDomain());
 132     }
 133
 134     /**
 135      * Create new {@link ConfigTransactionControllerImpl }
 136      */
 137     @Override
 138     public synchronized ObjectName beginConfig() {
 139         return beginConfig(false);
 140     }
 141
 142     /**
 143      * @param blankTransaction true if this transaction is created automatically by
 144      *                         org.opendaylight.controller.config.manager.impl.osgi.BlankTransactionServiceTracker
 145      */
 146     public synchronized ObjectName beginConfig(boolean blankTransaction) {
 147         return beginConfigInternal(blankTransaction).getControllerObjectName();
 148     }
 149
 150     private synchronized ConfigTransactionControllerInternal beginConfigInternal(boolean blankTransaction) {
 151         versionCounter++;
 152         final String transactionName = "ConfigTransaction-" + version + "-" + versionCounter;
 153
 154         TransactionJMXRegistratorFactory factory = new TransactionJMXRegistratorFactory() {
 155             @Override
 156             public TransactionJMXRegistrator create() {
 157                 return baseJMXRegistrator.createTransactionJMXRegistrator(transactionName);
 158             }
 159         };
 160
 161         Map<String, Map.Entry<ModuleFactory, BundleContext>> allCurrentFactories = new HashMap<>(
 162                 resolver.getAllFactories());
 163
 164         // add all factories that disappeared from SR but are still committed
 165         for (ModuleInternalInfo moduleInternalInfo : currentConfig.getEntries()) {
 166             String name = moduleInternalInfo.getModuleFactory().getImplementationName();
 167             if (allCurrentFactories.containsKey(name) == false) {
 168                 LOG.trace("Factory {} not found in SR, using reference from previous commit", name);
 169                 allCurrentFactories.put(name,
 170                         Maps.immutableEntry(moduleInternalInfo.getModuleFactory(), moduleInternalInfo.getBundleContext()));
 171             }
 172         }
 173         allCurrentFactories = Collections.unmodifiableMap(allCurrentFactories);
 174
 175         // closed by transaction controller
 176         ConfigTransactionLookupRegistry txLookupRegistry = new ConfigTransactionLookupRegistry(new TransactionIdentifier(
 177                 transactionName), factory, allCurrentFactories);
 178         SearchableServiceReferenceWritableRegistry writableRegistry = ServiceReferenceRegistryImpl.createSRWritableRegistry(
 179                 readableSRRegistry, txLookupRegistry, allCurrentFactories);
 180
 181         ConfigTransactionControllerInternal transactionController = new ConfigTransactionControllerImpl(
 182                 txLookupRegistry, version, bindingContextProvider,
 183                 versionCounter, allCurrentFactories, transactionsMBeanServer,
 184                 configMBeanServer, blankTransaction, writableRegistry);
 185         try {
 186             txLookupRegistry.registerMBean(transactionController, transactionController.getControllerObjectName());
 187         } catch (InstanceAlreadyExistsException e) {
 188             throw new IllegalStateException(e);
 189         }
 190         transactionController.copyExistingModulesAndProcessFactoryDiff(currentConfig.getEntries(), lastListOfFactories);
 191         transactionsHolder.add(transactionName, transactionController, txLookupRegistry);
 192         return transactionController;
 193     }
 194
 195     /**
 196      * {@inheritDoc}
 197      */
 198     @Override
 199     public synchronized CommitStatus commitConfig(ObjectName transactionControllerON)
 200             throws ConflictingVersionException, ValidationException {
 201         final String transactionName = ObjectNameUtil
 202                 .getTransactionName(transactionControllerON);
 203         LOG.trace("About to commit {}. Current parentVersion: {}, versionCounter {}", transactionName, version, versionCounter);
 204
 205         // find ConfigTransactionController
 206         Map<String, Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry>> transactions = transactionsHolder.getCurrentTransactions();
 207         Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry> configTransactionControllerEntry = transactions.get(transactionName);
 208         if (configTransactionControllerEntry == null) {
 209             throw new IllegalArgumentException(String.format(
 210                     "Transaction with name '%s' not found", transactionName));
 211         }
 212         ConfigTransactionControllerInternal configTransactionController = configTransactionControllerEntry.getKey();
 213         // check optimistic lock
 214         if (version != configTransactionController.getParentVersion()) {
 215             throw new ConflictingVersionException(
 216                     String.format(
 217                             "Optimistic lock failed. Expected parent version %d, was %d",
 218                             version,
 219                             configTransactionController.getParentVersion()));
 220         }
 221         // optimistic lock ok
 222
 223         CommitInfo commitInfo = configTransactionController.validateBeforeCommitAndLockTransaction();
 224         lastListOfFactories = Collections.unmodifiableList(configTransactionController.getCurrentlyRegisteredFactories());
 225         // non recoverable from here:
 226         try {
 227             return secondPhaseCommit(configTransactionController, commitInfo, configTransactionControllerEntry.getValue());
 228         } catch (Error | RuntimeException t) { // some libs throw Errors: e.g.
 229             // javax.xml.ws.spi.FactoryFinder$ConfigurationError
 230             isHealthy = false;
 231             LOG.error("Configuration Transaction failed on 2PC, server is unhealthy", t);
 232             if (t instanceof RuntimeException) {
 233                 throw (RuntimeException) t;
 234             } else {
 235                 throw (Error) t;
 236             }
 237         }
 238     }
 239
 240     private CommitStatus secondPhaseCommit(ConfigTransactionControllerInternal configTransactionController,
 241                                            CommitInfo commitInfo, ConfigTransactionLookupRegistry txLookupRegistry) {
 242
 243         // close instances which were destroyed by the user, including
 244         // (hopefully) runtime beans
 245         for (DestroyedModule toBeDestroyed : commitInfo
 246                 .getDestroyedFromPreviousTransactions()) {
 247             toBeDestroyed.close(); // closes instance (which should close
 248             // runtime jmx registrator),
 249             // also closes osgi registration and ModuleJMXRegistrator
 250             // registration
 251             currentConfig.remove(toBeDestroyed.getIdentifier());
 252         }
 253
 254         // set RuntimeBeanRegistrators on beans implementing
 255         // RuntimeBeanRegistratorAwareModule, each module
 256         // should have exactly one runtime jmx registrator.
 257         Map<ModuleIdentifier, RootRuntimeBeanRegistratorImpl> runtimeRegistrators = new HashMap<>();
 258         for (ModuleInternalTransactionalInfo entry : commitInfo.getCommitted()
 259                 .values()) {
 260             RootRuntimeBeanRegistratorImpl runtimeBeanRegistrator;
 261             if (entry.hasOldModule() == false) {
 262                 runtimeBeanRegistrator = baseJMXRegistrator
 263                         .createRuntimeBeanRegistrator(entry.getIdentifier());
 264             } else {
 265                 // reuse old JMX registrator
 266                 runtimeBeanRegistrator = entry.getOldInternalInfo()
 267                         .getRuntimeBeanRegistrator();
 268             }
 269             // set runtime jmx registrator if required
 270             Module module = entry.getProxiedModule();
 271             if (module instanceof RuntimeBeanRegistratorAwareModule) {
 272                 ((RuntimeBeanRegistratorAwareModule) module)
 273                         .setRuntimeBeanRegistrator(runtimeBeanRegistrator);
 274             }
 275             // save it to info so it is accessible afterwards
 276             runtimeRegistrators.put(entry.getIdentifier(), runtimeBeanRegistrator);
 277         }
 278
 279         // can register runtime beans
 280         List<ModuleIdentifier> orderedModuleIdentifiers = configTransactionController.secondPhaseCommit();
 281         txLookupRegistry.close();
 282         configTransactionController.close();
 283
 284         // copy configuration to read only mode
 285         List<ObjectName> newInstances = new LinkedList<>();
 286         List<ObjectName> reusedInstances = new LinkedList<>();
 287         List<ObjectName> recreatedInstances = new LinkedList<>();
 288
 289         Map<Module, ModuleInternalInfo> newConfigEntries = new HashMap<>();
 290
 291         int orderingIdx = 0;
 292         for (ModuleIdentifier moduleIdentifier : orderedModuleIdentifiers) {
 293             LOG.trace("Registering {}", moduleIdentifier);
 294             ModuleInternalTransactionalInfo entry = commitInfo.getCommitted()
 295                     .get(moduleIdentifier);
 296             if (entry == null) {
 297                 throw new NullPointerException("Module not found "
 298                         + moduleIdentifier);
 299             }
 300
 301             ObjectName primaryReadOnlyON = ObjectNameUtil
 302                     .createReadOnlyModuleON(moduleIdentifier);
 303
 304             // determine if current instance was recreated or reused or is new
 305
 306             // rules for closing resources:
 307             // osgi registration - will be reused if possible.
 308             // module jmx registration - will be (re)created every time, needs
 309             // to be closed here
 310             // runtime jmx registration - should be taken care of by module
 311             // itself
 312             // instance - is closed only if it was destroyed
 313             ModuleJMXRegistrator newModuleJMXRegistrator = baseJMXRegistrator
 314                     .createModuleJMXRegistrator();
 315
 316             OsgiRegistration osgiRegistration = null;
 317             AutoCloseable instance = entry.getProxiedModule().getInstance();
 318             if (entry.hasOldModule()) {
 319                 ModuleInternalInfo oldInternalInfo = entry.getOldInternalInfo();
 320                 DynamicReadableWrapper oldReadableConfigBean = oldInternalInfo.getReadableModule();
 321                 currentConfig.remove(entry.getIdentifier());
 322
 323                 // test if old instance == new instance
 324                 if (oldReadableConfigBean.getInstance().equals(instance)) {
 325                     // reused old instance:
 326                     // wrap in readable dynamic mbean
 327                     reusedInstances.add(primaryReadOnlyON);
 328                     osgiRegistration = oldInternalInfo.getOsgiRegistration();
 329                 } else {
 330                     // recreated instance:
 331                     // it is responsibility of module to call the old instance -
 332                     // we just need to unregister configbean
 333                     recreatedInstances.add(primaryReadOnlyON);
 334
 335                     // close old osgi registration
 336                     oldInternalInfo.getOsgiRegistration().close();
 337                 }
 338
 339                 // close old module jmx registrator
 340                 oldInternalInfo.getModuleJMXRegistrator().close();
 341
 342                 // We no longer need old internal info. Clear it out, so we do not create a serial leak evidenced
 343                 // by BUG-4514. The reason is that modules retain their resolver, which retains modules. If we retain
 344                 // the old module, we would have the complete reconfiguration history held in heap for no good reason.
 345                 entry.clearOldInternalInfo();
 346             } else {
 347                 // new instance:
 348                 // wrap in readable dynamic mbean
 349                 newInstances.add(primaryReadOnlyON);
 350             }
 351             Module realModule = entry.getRealModule();
 352
 353             DynamicReadableWrapper newReadableConfigBean = new DynamicReadableWrapper(
 354                     realModule, instance, moduleIdentifier,
 355                     registryMBeanServer, configMBeanServer);
 356
 357             // register to JMX
 358             try {
 359                 newModuleJMXRegistrator.registerMBean(newReadableConfigBean, primaryReadOnlyON);
 360             } catch (InstanceAlreadyExistsException e) {
 361                 throw new IllegalStateException("Possible code error, already registered:" + primaryReadOnlyON,e);
 362             }
 363
 364             // register services to OSGi
 365             Map<ServiceInterfaceAnnotation, String /* service ref name */> annotationMapping = configTransactionController.getWritableRegistry().findServiceInterfaces(moduleIdentifier);
 366             BundleContext bc = configTransactionController.getModuleFactoryBundleContext(
 367                     entry.getModuleFactory().getImplementationName());
 368             if (osgiRegistration == null) {
 369                 osgiRegistration = beanToOsgiServiceManager.registerToOsgi(
 370                         newReadableConfigBean.getInstance(), moduleIdentifier, bc, annotationMapping);
 371             } else {
 372                 osgiRegistration.updateRegistrations(annotationMapping, bc, instance);
 373             }
 374
 375             RootRuntimeBeanRegistratorImpl runtimeBeanRegistrator = runtimeRegistrators
 376                     .get(entry.getIdentifier());
 377             ModuleInternalInfo newInfo = new ModuleInternalInfo(
 378                     entry.getIdentifier(), newReadableConfigBean, osgiRegistration,
 379                     runtimeBeanRegistrator, newModuleJMXRegistrator,
 380                     orderingIdx, entry.isDefaultBean(), entry.getModuleFactory(), entry.getBundleContext());
 381
 382             newConfigEntries.put(realModule, newInfo);
 383             orderingIdx++;
 384         }
 385         currentConfig.addAll(newConfigEntries.values());
 386
 387         // update version
 388         version = configTransactionController.getVersion();
 389
 390         // switch readable Service Reference Registry
 391         this.readableSRRegistry.close();
 392         this.readableSRRegistry = ServiceReferenceRegistryImpl.createSRReadableRegistry(
 393                 configTransactionController.getWritableRegistry(), this, baseJMXRegistrator);
 394
 395         return new CommitStatus(newInstances, reusedInstances,
 396                 recreatedInstances);
 397     }
 398
 399     /**
 400      * {@inheritDoc}
 401      */
 402     @Override
 403     public synchronized List<ObjectName> getOpenConfigs() {
 404         Map<String, Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry>> transactions = transactionsHolder
 405                 .getCurrentTransactions();
 406         List<ObjectName> result = new ArrayList<>(transactions.size());
 407         for (Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry> configTransactionControllerEntry : transactions
 408                 .values()) {
 409             result.add(configTransactionControllerEntry.getKey().getControllerObjectName());
 410         }
 411         return result;
 412     }
 413
 414     /**
 415      * Abort open transactions and unregister read only modules. Since this
 416      * class is not responsible for registering itself under
 417      * {@link org.opendaylight.controller.config.api.ConfigRegistry#OBJECT_NAME}, it will not unregister itself
 418      * here.
 419      */
 420     @Override
 421     public synchronized void close() {
 422         // abort transactions
 423         Map<String, Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry>> transactions = transactionsHolder
 424                 .getCurrentTransactions();
 425         for (Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry> configTransactionControllerEntry : transactions
 426                 .values()) {
 427
 428             ConfigTransactionControllerInternal configTransactionController = configTransactionControllerEntry.getKey();
 429             try {
 430                 configTransactionControllerEntry.getValue().close();
 431                 configTransactionController.abortConfig();
 432             } catch (RuntimeException e) {
 433                 LOG.warn("Ignoring exception while aborting {}",
 434                         configTransactionController, e);
 435             }
 436         }
 437
 438         // destroy all live objects one after another in order of the dependency hierarchy, from top to bottom
 439         List<DestroyedModule> destroyedModules = currentConfig
 440                 .getModulesToBeDestroyed();
 441         for (DestroyedModule destroyedModule : destroyedModules) {
 442             destroyedModule.close();
 443         }
 444         // unregister MBeans that failed to unregister properly
 445         baseJMXRegistrator.close();
 446         // remove jmx servers
 447         MBeanServerFactory.releaseMBeanServer(registryMBeanServer);
 448         MBeanServerFactory.releaseMBeanServer(transactionsMBeanServer);
 449
 450     }
 451
 452     /**
 453      * {@inheritDoc}
 454      */
 455     @Override
 456     public long getVersion() {
 457         return version;
 458     }
 459
 460     /**
 461      * {@inheritDoc}
 462      */
 463     @Override
 464     public Set<String> getAvailableModuleNames() {
 465         return new HierarchicalConfigMBeanFactoriesHolder(
 466                 resolver.getAllFactories()).getModuleNames();
 467     }
 468
 469     /**
 470      * {@inheritDoc}
 471      */
 472     @Override
 473     public boolean isHealthy() {
 474         return isHealthy;
 475     }
 476
 477     // filtering methods
 478
 479     /**
 480      * {@inheritDoc}
 481      */
 482     @Override
 483     public Set<ObjectName> lookupConfigBeans() {
 484         return lookupConfigBeans("*", "*");
 485     }
 486
 487     /**
 488      * {@inheritDoc}
 489      */
 490     @Override
 491     public Set<ObjectName> lookupConfigBeans(String moduleName) {
 492         return lookupConfigBeans(moduleName, "*");
 493     }
 494
 495     /**
 496      * {@inheritDoc}
 497      */
 498     @Override
 499     public ObjectName lookupConfigBean(String moduleName, String instanceName)
 500             throws InstanceNotFoundException {
 501         return LookupBeansUtil.lookupConfigBean(this, moduleName, instanceName);
 502     }
 503
 504     /**
 505      * {@inheritDoc}
 506      */
 507     @Override
 508     public Set<ObjectName> lookupConfigBeans(String moduleName,
 509                                              String instanceName) {
 510         ObjectName namePattern = ObjectNameUtil.createModulePattern(moduleName,
 511                 instanceName);
 512         return baseJMXRegistrator.queryNames(namePattern, null);
 513     }
 514
 515     /**
 516      * {@inheritDoc}
 517      */
 518     @Override
 519     public Set<ObjectName> lookupRuntimeBeans() {
 520         return lookupRuntimeBeans("*", "*");
 521     }
 522
 523     /**
 524      * {@inheritDoc}
 525      */
 526     @Override
 527     public Set<ObjectName> lookupRuntimeBeans(String moduleName,
 528                                               String instanceName) {
 529         String finalModuleName = moduleName == null ? "*" : moduleName;
 530         String finalInstanceName = instanceName == null ? "*" : instanceName;
 531         ObjectName namePattern = ObjectNameUtil.createRuntimeBeanPattern(
 532                 finalModuleName, finalInstanceName);
 533         return baseJMXRegistrator.queryNames(namePattern, null);
 534     }
 535
 536     @Override
 537     public void checkConfigBeanExists(ObjectName objectName) throws InstanceNotFoundException {
 538         ObjectNameUtil.checkDomain(objectName);
 539         ObjectNameUtil.checkType(objectName, ObjectNameUtil.TYPE_MODULE);
 540         String transactionName = ObjectNameUtil.getTransactionName(objectName);
 541         if (transactionName != null) {
 542             throw new IllegalArgumentException("Transaction attribute not supported in registry, wrong ObjectName: " + objectName);
 543         }
 544         // make sure exactly one match is found:
 545         LookupBeansUtil.lookupConfigBean(this, ObjectNameUtil.getFactoryName(objectName), ObjectNameUtil.getInstanceName(objectName));
 546     }
 547
 548     // service reference functionality:
 549     @Override
 550     public synchronized ObjectName lookupConfigBeanByServiceInterfaceName(String serviceInterfaceQName, String refName) {
 551         return readableSRRegistry.lookupConfigBeanByServiceInterfaceName(serviceInterfaceQName, refName);
 552     }
 553
 554     @Override
 555     public synchronized Map<String, Map<String, ObjectName>> getServiceMapping() {
 556         return readableSRRegistry.getServiceMapping();
 557     }
 558
 559     @Override
 560     public synchronized Map<String, ObjectName> lookupServiceReferencesByServiceInterfaceName(String serviceInterfaceQName) {
 561         return readableSRRegistry.lookupServiceReferencesByServiceInterfaceName(serviceInterfaceQName);
 562     }
 563
 564     @Override
 565     public synchronized Set<String> lookupServiceInterfaceNames(ObjectName objectName) throws InstanceNotFoundException {
 566         return readableSRRegistry.lookupServiceInterfaceNames(objectName);
 567     }
 568
 569     @Override
 570     public synchronized String getServiceInterfaceName(String namespace, String localName) {
 571         return readableSRRegistry.getServiceInterfaceName(namespace, localName);
 572     }
 573
 574     @Override
 575     public void checkServiceReferenceExists(ObjectName objectName) throws InstanceNotFoundException {
 576         readableSRRegistry.checkServiceReferenceExists(objectName);
 577     }
 578
 579     @Override
 580     public ObjectName getServiceReference(String serviceInterfaceQName, String refName) throws InstanceNotFoundException {
 581         return readableSRRegistry.getServiceReference(serviceInterfaceQName, refName);
 582     }
 583
 584     @Override
 585     public Set<String> getAvailableModuleFactoryQNames() {
 586         return ModuleQNameUtil.getQNames(resolver.getAllFactories());
 587     }
 588
 589     @Override
 590     public String toString() {
 591         return "ConfigRegistryImpl{" +
 592                 "versionCounter=" + versionCounter +
 593                 ", version=" + version +
 594                 '}';
 595     }
 596 }
 597
 598 /**
 599  * Holds currently running modules
 600  */
 601 @NotThreadSafe
 602 class ConfigHolder {
 603     private final Map<ModuleIdentifier, ModuleInternalInfo> currentConfig = new HashMap<>();
 604
 605     /**
 606      * Add all modules to the internal map. Also add service instance to OSGi
 607      * Service Registry.
 608      */
 609     public void addAll(Collection<ModuleInternalInfo> configInfos) {
 610         if (!currentConfig.isEmpty()) {
 611             throw new IllegalStateException(
 612                     "Error - some config entries were not removed: "
 613                             + currentConfig);
 614         }
 615         for (ModuleInternalInfo configInfo : configInfos) {
 616             add(configInfo);
 617         }
 618     }
 619
 620     private void add(ModuleInternalInfo configInfo) {
 621         ModuleInternalInfo oldValue = currentConfig.put(configInfo.getIdentifier(),
 622                 configInfo);
 623         if (oldValue != null) {
 624             throw new IllegalStateException(
 625                     "Cannot overwrite module with same name:"
 626                             + configInfo.getIdentifier() + ":" + configInfo);
 627         }
 628     }
 629
 630     /**
 631      * Remove entry from current config.
 632      */
 633     public void remove(ModuleIdentifier name) {
 634         ModuleInternalInfo removed = currentConfig.remove(name);
 635         if (removed == null) {
 636             throw new IllegalStateException(
 637                     "Cannot remove from ConfigHolder - name not found:" + name);
 638         }
 639     }
 640
 641     public Collection<ModuleInternalInfo> getEntries() {
 642         return currentConfig.values();
 643     }
 644
 645     public List<DestroyedModule> getModulesToBeDestroyed() {
 646         List<DestroyedModule> result = new ArrayList<>();
 647         for (ModuleInternalInfo moduleInternalInfo : getEntries()) {
 648             result.add(moduleInternalInfo.toDestroyedModule());
 649         }
 650         Collections.sort(result);
 651         return result;
 652     }
 653
 654
 655 }
 656
 657 /**
 658  * Holds Map<transactionName, transactionController> and purges it each time its
 659  * content is requested.
 660  */
 661 @NotThreadSafe
 662 class TransactionsHolder {
 663     /**
 664      * This map keeps transaction names and
 665      * {@link ConfigTransactionControllerInternal} instances, because platform
 666      * MBeanServer transforms mbeans into another representation. Map is cleaned
 667      * every time current transactions are requested.
 668      */
 669     @GuardedBy("ConfigRegistryImpl.this")
 670     private final Map<String /* transactionName */,
 671             Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry>> transactions = new HashMap<>();
 672
 673     /**
 674      * Can only be called from within synchronized method.
 675      */
 676     public void add(String transactionName,
 677                     ConfigTransactionControllerInternal transactionController, ConfigTransactionLookupRegistry txLookupRegistry) {
 678         Object oldValue = transactions.put(transactionName,
 679                 Maps.immutableEntry(transactionController, txLookupRegistry));
 680         if (oldValue != null) {
 681             throw new IllegalStateException(
 682                     "Error: two transactions with same name");
 683         }
 684     }
 685
 686     /**
 687      * Purges closed transactions from transactions map. Can only be called from
 688      * within synchronized method. Calling this method more than once within the
 689      * method can modify the resulting map that was obtained in previous calls.
 690      *
 691      * @return current view on transactions map.
 692      */
 693     public Map<String, Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry>> getCurrentTransactions() {
 694         // first, remove closed transaction
 695         for (Iterator<Entry<String, Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry>>> it = transactions
 696                 .entrySet().iterator(); it.hasNext(); ) {
 697             Entry<String, Entry<ConfigTransactionControllerInternal, ConfigTransactionLookupRegistry>> entry = it
 698                     .next();
 699             if (entry.getValue().getKey().isClosed()) {
 700                 it.remove();
 701             }
 702         }
 703         return Collections.unmodifiableMap(transactions);
 704     }
 705 }