2 * Copyright (c) 2013 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;
10 import org.opendaylight.controller.config.api.DependencyResolver;
11 import org.opendaylight.controller.config.api.ModuleIdentifier;
12 import org.opendaylight.controller.config.api.ServiceReferenceWritableRegistry;
13 import org.opendaylight.controller.config.api.ValidationException;
14 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
15 import org.opendaylight.controller.config.manager.impl.dependencyresolver.DependencyResolverManager;
16 import org.opendaylight.controller.config.manager.impl.dynamicmbean.DynamicWritableWrapper;
17 import org.opendaylight.controller.config.manager.impl.dynamicmbean.ReadOnlyAtomicBoolean;
18 import org.opendaylight.controller.config.manager.impl.dynamicmbean.ReadOnlyAtomicBoolean.ReadOnlyAtomicBooleanImpl;
19 import org.opendaylight.controller.config.manager.impl.factoriesresolver.HierarchicalConfigMBeanFactoriesHolder;
20 import org.opendaylight.controller.config.manager.impl.jmx.TransactionModuleJMXRegistrator;
21 import org.opendaylight.controller.config.manager.impl.jmx.TransactionModuleJMXRegistrator.TransactionModuleJMXRegistration;
22 import org.opendaylight.controller.config.spi.Module;
23 import org.opendaylight.controller.config.spi.ModuleFactory;
24 import org.opendaylight.yangtools.concepts.Identifiable;
25 import org.osgi.framework.BundleContext;
26 import org.slf4j.Logger;
27 import org.slf4j.LoggerFactory;
29 import javax.annotation.Nullable;
30 import javax.annotation.concurrent.GuardedBy;
31 import javax.management.DynamicMBean;
32 import javax.management.InstanceAlreadyExistsException;
33 import javax.management.InstanceNotFoundException;
34 import javax.management.MBeanServer;
35 import javax.management.ObjectName;
36 import java.util.ArrayList;
37 import java.util.Collection;
38 import java.util.HashSet;
39 import java.util.List;
41 import java.util.Map.Entry;
43 import java.util.concurrent.atomic.AtomicBoolean;
45 import static java.lang.String.format;
48 * This is a JMX bean representing current transaction. It contains
49 * transaction identifier, unique version and parent version for
52 class ConfigTransactionControllerImpl implements
53 ConfigTransactionControllerInternal,
54 ConfigTransactionControllerImplMXBean,
55 Identifiable<TransactionIdentifier>{
56 private static final Logger logger = LoggerFactory.getLogger(ConfigTransactionControllerImpl.class);
58 private final ConfigTransactionLookupRegistry txLookupRegistry;
59 private final ObjectName controllerON;
61 private final long parentVersion, currentVersion;
62 private final HierarchicalConfigMBeanFactoriesHolder factoriesHolder;
63 private final DependencyResolverManager dependencyResolverManager;
64 private final TransactionStatus transactionStatus;
65 private final MBeanServer transactionsMBeanServer;
66 private final Map<String, Map.Entry<ModuleFactory, BundleContext>> currentlyRegisteredFactories;
69 * Disables ability of {@link DynamicWritableWrapper} to change attributes
73 private final AtomicBoolean configBeanModificationDisabled = new AtomicBoolean(
75 private final ReadOnlyAtomicBoolean readOnlyAtomicBoolean = new ReadOnlyAtomicBooleanImpl(
76 configBeanModificationDisabled);
77 private final MBeanServer configMBeanServer;
79 private final boolean blankTransaction;
82 private final ServiceReferenceWritableRegistry writableSRRegistry;
84 public ConfigTransactionControllerImpl(ConfigTransactionLookupRegistry txLookupRegistry,
85 long parentVersion, long currentVersion,
86 Map<String, Map.Entry<ModuleFactory, BundleContext>> currentlyRegisteredFactories,
87 MBeanServer transactionsMBeanServer, MBeanServer configMBeanServer,
88 boolean blankTransaction, ServiceReferenceWritableRegistry writableSRRegistry) {
90 this.txLookupRegistry = txLookupRegistry;
91 String transactionName = txLookupRegistry.getTransactionIdentifier().getName();
92 this.controllerON = ObjectNameUtil.createTransactionControllerON(transactionName);
93 this.parentVersion = parentVersion;
94 this.currentVersion = currentVersion;
95 this.currentlyRegisteredFactories = currentlyRegisteredFactories;
96 this.factoriesHolder = new HierarchicalConfigMBeanFactoriesHolder(currentlyRegisteredFactories);
97 this.transactionStatus = new TransactionStatus();
98 this.dependencyResolverManager = new DependencyResolverManager(transactionName, transactionStatus);
99 this.transactionsMBeanServer = transactionsMBeanServer;
100 this.configMBeanServer = configMBeanServer;
101 this.blankTransaction = blankTransaction;
102 this.writableSRRegistry = writableSRRegistry;
106 public void copyExistingModulesAndProcessFactoryDiff(Collection<ModuleInternalInfo> existingModules, List<ModuleFactory> lastListOfFactories) {
107 // copy old configuration to this server
108 for (ModuleInternalInfo oldConfigInfo : existingModules) {
110 copyExistingModule(oldConfigInfo);
111 } catch (InstanceAlreadyExistsException e) {
112 throw new IllegalStateException("Error while copying " + oldConfigInfo, e);
115 processDefaultBeans(lastListOfFactories);
118 private synchronized void processDefaultBeans(List<ModuleFactory> lastListOfFactories) {
119 transactionStatus.checkNotCommitStarted();
120 transactionStatus.checkNotAborted();
122 Set<ModuleFactory> oldSet = new HashSet<>(lastListOfFactories);
123 Set<ModuleFactory> newSet = new HashSet<>(factoriesHolder.getModuleFactories());
125 List<ModuleFactory> toBeAdded = new ArrayList<>();
126 List<ModuleFactory> toBeRemoved = new ArrayList<>();
127 for(ModuleFactory moduleFactory: factoriesHolder.getModuleFactories()) {
128 if (oldSet.contains(moduleFactory) == false){
129 toBeAdded.add(moduleFactory);
132 for(ModuleFactory moduleFactory: lastListOfFactories){
133 if (newSet.contains(moduleFactory) == false) {
134 toBeRemoved.add(moduleFactory);
137 // add default modules
138 for (ModuleFactory moduleFactory : toBeAdded) {
139 Set<? extends Module> defaultModules = moduleFactory.getDefaultModules(dependencyResolverManager,
140 getModuleFactoryBundleContext(moduleFactory.getImplementationName()));
141 for (Module module : defaultModules) {
142 // ensure default module to be registered to jmx even if its module factory does not use dependencyResolverFactory
143 DependencyResolver dependencyResolver = dependencyResolverManager.getOrCreate(module.getIdentifier());
145 boolean defaultBean = true;
146 putConfigBeanToJMXAndInternalMaps(module.getIdentifier(), module, moduleFactory, null, dependencyResolver, defaultBean);
147 } catch (InstanceAlreadyExistsException e) {
148 throw new IllegalStateException(e);
153 // remove modules belonging to removed factories
154 for(ModuleFactory removedFactory: toBeRemoved){
155 List<ModuleIdentifier> modulesOfRemovedFactory = dependencyResolverManager.findAllByFactory(removedFactory);
156 for (ModuleIdentifier name : modulesOfRemovedFactory) {
163 private synchronized void copyExistingModule(
164 ModuleInternalInfo oldConfigBeanInfo)
165 throws InstanceAlreadyExistsException {
166 transactionStatus.checkNotCommitStarted();
167 transactionStatus.checkNotAborted();
168 ModuleIdentifier moduleIdentifier = oldConfigBeanInfo.getName();
169 dependencyResolverManager.assertNotExists(moduleIdentifier);
171 ModuleFactory moduleFactory = factoriesHolder
172 .findByModuleName(moduleIdentifier.getFactoryName());
175 DependencyResolver dependencyResolver = dependencyResolverManager
176 .getOrCreate(moduleIdentifier);
178 BundleContext bc = getModuleFactoryBundleContext(moduleFactory.getImplementationName());
179 module = moduleFactory.createModule(
180 moduleIdentifier.getInstanceName(), dependencyResolver,
181 oldConfigBeanInfo.getReadableModule(), bc);
182 } catch (Exception e) {
183 throw new IllegalStateException(format(
184 "Error while copying old configuration from %s to %s",
185 oldConfigBeanInfo, moduleFactory), e);
187 putConfigBeanToJMXAndInternalMaps(moduleIdentifier, module, moduleFactory, oldConfigBeanInfo, dependencyResolver,
188 oldConfigBeanInfo.isDefaultBean());
192 public synchronized ObjectName createModule(String factoryName,
193 String instanceName) throws InstanceAlreadyExistsException {
195 transactionStatus.checkNotCommitStarted();
196 transactionStatus.checkNotAborted();
197 ModuleIdentifier moduleIdentifier = new ModuleIdentifier(factoryName, instanceName);
198 dependencyResolverManager.assertNotExists(moduleIdentifier);
201 ModuleFactory moduleFactory = factoriesHolder.findByModuleName(factoryName);
202 DependencyResolver dependencyResolver = dependencyResolverManager.getOrCreate(moduleIdentifier);
203 Module module = moduleFactory.createModule(instanceName, dependencyResolver,
204 getModuleFactoryBundleContext(moduleFactory.getImplementationName()));
205 boolean defaultBean = false;
206 return putConfigBeanToJMXAndInternalMaps(moduleIdentifier, module,
207 moduleFactory, null, dependencyResolver, defaultBean);
210 private synchronized ObjectName putConfigBeanToJMXAndInternalMaps(
211 ModuleIdentifier moduleIdentifier, Module module,
212 ModuleFactory moduleFactory,
213 @Nullable ModuleInternalInfo maybeOldConfigBeanInfo, DependencyResolver dependencyResolver, boolean isDefaultBean)
214 throws InstanceAlreadyExistsException {
216 logger.debug("Adding module {} to transaction {}", moduleIdentifier, this);
217 if (moduleIdentifier.equals(module.getIdentifier())==false) {
218 throw new IllegalStateException("Incorrect name reported by module. Expected "
219 + moduleIdentifier + ", got " + module.getIdentifier());
221 if (dependencyResolver.getIdentifier().equals(moduleIdentifier) == false ) {
222 throw new IllegalStateException("Incorrect name reported by dependency resolver. Expected "
223 + moduleIdentifier + ", got " + dependencyResolver.getIdentifier());
225 DynamicMBean writableDynamicWrapper = new DynamicWritableWrapper(
226 module, moduleIdentifier, getTransactionIdentifier(),
227 readOnlyAtomicBoolean, transactionsMBeanServer,
230 ObjectName writableON = ObjectNameUtil.createTransactionModuleON(
231 getTransactionIdentifier().getName(), moduleIdentifier);
232 // put wrapper to jmx
233 TransactionModuleJMXRegistration transactionModuleJMXRegistration = getTxModuleJMXRegistrator()
234 .registerMBean(writableDynamicWrapper, writableON);
235 ModuleInternalTransactionalInfo moduleInternalTransactionalInfo = new ModuleInternalTransactionalInfo(
236 moduleIdentifier, module, moduleFactory,
237 maybeOldConfigBeanInfo, transactionModuleJMXRegistration, isDefaultBean);
239 dependencyResolverManager.put(moduleInternalTransactionalInfo);
244 public synchronized void destroyModule(ObjectName objectName) throws InstanceNotFoundException {
245 checkTransactionName(objectName);
246 ObjectNameUtil.checkDomain(objectName);
247 ModuleIdentifier moduleIdentifier = ObjectNameUtil.fromON(objectName,
248 ObjectNameUtil.TYPE_MODULE);
249 destroyModule(moduleIdentifier);
252 private void checkTransactionName(ObjectName objectName) {
253 String foundTransactionName = ObjectNameUtil
254 .getTransactionName(objectName);
255 if (getTransactionIdentifier().getName().equals(foundTransactionName) == false) {
256 throw new IllegalArgumentException("Wrong transaction name "
261 private synchronized void destroyModule(ModuleIdentifier moduleIdentifier) {
262 logger.debug("Destroying module {} in transaction {}", moduleIdentifier, this);
263 transactionStatus.checkNotAborted();
265 if (blankTransaction == false) {
266 ModuleInternalTransactionalInfo found =
267 dependencyResolverManager.findModuleInternalTransactionalInfo(moduleIdentifier);
268 if (found.isDefaultBean()) {
269 logger.warn("Warning: removing default bean. This will be forbidden in next version of config-subsystem");
272 // first remove refNames, it checks for objectname existence
274 writableSRRegistry.removeServiceReferences(
275 ObjectNameUtil.createTransactionModuleON(getTransactionName(),moduleIdentifier));
276 } catch (InstanceNotFoundException e) {
277 logger.error("Possible code error: cannot find {} in {}", moduleIdentifier, writableSRRegistry);
278 throw new IllegalStateException("Possible code error: cannot find " + moduleIdentifier, e);
281 ModuleInternalTransactionalInfo removedTInfo = dependencyResolverManager.destroyModule(moduleIdentifier);
283 removedTInfo.getTransactionModuleJMXRegistration().close();
287 public long getParentVersion() {
288 return parentVersion;
292 public long getVersion() {
293 return currentVersion;
297 public synchronized void validateConfig() throws ValidationException {
298 if (configBeanModificationDisabled.get())
299 throw new IllegalStateException("Cannot start validation");
300 configBeanModificationDisabled.set(true);
304 configBeanModificationDisabled.set(false);
308 private void validate_noLocks() throws ValidationException {
309 transactionStatus.checkNotAborted();
310 logger.info("Validating transaction {}", getTransactionIdentifier());
312 List<ValidationException> collectedExceptions = new ArrayList<>();
313 for (Entry<ModuleIdentifier, Module> entry : dependencyResolverManager
314 .getAllModules().entrySet()) {
315 ModuleIdentifier name = entry.getKey();
316 Module module = entry.getValue();
319 } catch (Exception e) {
320 logger.warn("Validation exception in {}", getTransactionName(),
322 collectedExceptions.add(ValidationException
323 .createForSingleException(name, e));
326 if (collectedExceptions.size() > 0) {
327 throw ValidationException
328 .createFromCollectedValidationExceptions(collectedExceptions);
330 logger.info("Validated transaction {}", getTransactionIdentifier());
334 * If this method passes validation, it will grab
335 * {@link TransactionStatus#secondPhaseCommitStarted} lock. This lock will
336 * prevent calling @{link #validateBeforeCommitAndLockTransaction},
337 * effectively only allowing to call {@link #secondPhaseCommit} after
338 * successful return of this method.
341 public synchronized CommitInfo validateBeforeCommitAndLockTransaction()
342 throws ValidationException {
343 transactionStatus.checkNotAborted();
344 transactionStatus.checkNotCommitStarted();
345 configBeanModificationDisabled.set(true);
348 } catch (ValidationException e) {
349 logger.info("Commit failed on validation");
350 configBeanModificationDisabled.set(false); // recoverable error
353 // errors in this state are not recoverable. modules are not mutable
355 transactionStatus.setSecondPhaseCommitStarted();
356 return dependencyResolverManager.toCommitInfo();
363 public synchronized List<ModuleIdentifier> secondPhaseCommit() {
364 transactionStatus.checkNotAborted();
365 transactionStatus.checkCommitStarted();
366 if (configBeanModificationDisabled.get() == false) {
367 throw new IllegalStateException(
368 "Internal error - validateBeforeCommitAndLockTransaction should be called "
369 + "to obtain a lock");
372 logger.info("Committing transaction {}", getTransactionIdentifier());
374 // call getInstance()
375 for (Entry<ModuleIdentifier, Module> entry : dependencyResolverManager
376 .getAllModules().entrySet()) {
377 Module module = entry.getValue();
378 ModuleIdentifier name = entry.getKey();
380 logger.debug("About to commit {} in transaction {}",
381 name, getTransactionIdentifier());
382 module.getInstance();
383 } catch (Exception e) {
384 logger.error("Commit failed on {} in transaction {}", name,
385 getTransactionIdentifier(), e);
387 throw new RuntimeException(
388 format("Error - getInstance() failed for %s in transaction %s",
389 name, getTransactionIdentifier()), e);
393 // count dependency order
395 logger.info("Committed configuration {}", getTransactionIdentifier());
396 transactionStatus.setCommitted();
397 // unregister this and all modules from jmx
400 return dependencyResolverManager.getSortedModuleIdentifiers();
404 public synchronized void abortConfig() {
405 transactionStatus.checkNotCommitStarted();
406 transactionStatus.checkNotAborted();
410 private void internalAbort() {
411 transactionStatus.setAborted();
415 private void close() {
416 //FIXME: should not close object that was retrieved in constructor, a wrapper object should do that perhaps
417 txLookupRegistry.close();
421 public ObjectName getControllerObjectName() {
426 public String getTransactionName() {
427 return getTransactionIdentifier().getName();
434 public Set<ObjectName> lookupConfigBeans() {
435 return txLookupRegistry.lookupConfigBeans();
442 public Set<ObjectName> lookupConfigBeans(String moduleName) {
443 return txLookupRegistry.lookupConfigBeans(moduleName);
450 public ObjectName lookupConfigBean(String moduleName, String instanceName)
451 throws InstanceNotFoundException {
452 return txLookupRegistry.lookupConfigBean(moduleName, instanceName);
459 public Set<ObjectName> lookupConfigBeans(String moduleName, String instanceName) {
460 return txLookupRegistry.lookupConfigBeans(moduleName, instanceName);
467 public void checkConfigBeanExists(ObjectName objectName) throws InstanceNotFoundException {
468 txLookupRegistry.checkConfigBeanExists(objectName);
476 public Set<String> getAvailableModuleNames() {
477 return factoriesHolder.getModuleNames();
481 public boolean isClosed() {
482 return transactionStatus.isAbortedOrCommitted();
486 public String toString() {
487 StringBuilder sb = new StringBuilder();
488 sb.append("transactionName=");
489 sb.append(getTransactionName());
490 return sb.toString();
493 // @VisibleForTesting
495 TransactionModuleJMXRegistrator getTxModuleJMXRegistrator() {
496 return txLookupRegistry.getTxModuleJMXRegistrator();
499 public TransactionIdentifier getName() {
500 return getTransactionIdentifier();
504 public List<ModuleFactory> getCurrentlyRegisteredFactories() {
505 return new ArrayList<>(factoriesHolder.getModuleFactories());
509 public TransactionIdentifier getIdentifier() {
510 return getTransactionIdentifier();
514 public BundleContext getModuleFactoryBundleContext(String factoryName) {
515 Map.Entry<ModuleFactory, BundleContext> factoryBundleContextEntry = this.currentlyRegisteredFactories.get(factoryName);
516 if (factoryBundleContextEntry == null || factoryBundleContextEntry.getValue() == null) {
517 throw new NullPointerException("Bundle context of " + factoryName + " ModuleFactory not found.");
519 return factoryBundleContextEntry.getValue();
522 // service reference functionality:
526 public synchronized ObjectName lookupConfigBeanByServiceInterfaceName(String serviceInterfaceName, String refName) {
527 return writableSRRegistry.lookupConfigBeanByServiceInterfaceName(serviceInterfaceName, refName);
531 public synchronized Map<String, Map<String, ObjectName>> getServiceMapping() {
532 return writableSRRegistry.getServiceMapping();
536 public synchronized Map<String, ObjectName> lookupServiceReferencesByServiceInterfaceName(String serviceInterfaceName) {
537 return writableSRRegistry.lookupServiceReferencesByServiceInterfaceName(serviceInterfaceName);
541 public synchronized Set<String> lookupServiceInterfaceNames(ObjectName objectName) throws InstanceNotFoundException {
542 return writableSRRegistry.lookupServiceInterfaceNames(objectName);
546 public synchronized String getServiceInterfaceName(String namespace, String localName) {
547 return writableSRRegistry.getServiceInterfaceName(namespace, localName);
551 public synchronized void saveServiceReference(String serviceInterfaceName, String refName, ObjectName objectName) throws InstanceNotFoundException {
552 writableSRRegistry.saveServiceReference(serviceInterfaceName, refName, objectName);
556 public synchronized boolean removeServiceReference(String serviceInterfaceName, String refName) {
557 return writableSRRegistry.removeServiceReference(serviceInterfaceName, refName);
561 public synchronized void removeAllServiceReferences() {
562 writableSRRegistry.removeAllServiceReferences();
566 public boolean removeServiceReferences(ObjectName objectName) throws InstanceNotFoundException {
567 return writableSRRegistry.removeServiceReferences(objectName);
571 public ServiceReferenceWritableRegistry getWritableRegistry() {
572 return writableSRRegistry;
575 public TransactionIdentifier getTransactionIdentifier() {
576 return txLookupRegistry.getTransactionIdentifier();
580 public Set<String> getAvailableModuleFactoryQNames() {
581 return txLookupRegistry.getAvailableModuleFactoryQNames();