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.ValidationException;
13 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
14 import org.opendaylight.controller.config.manager.impl.dependencyresolver.DependencyResolverManager;
15 import org.opendaylight.controller.config.manager.impl.dynamicmbean.DynamicWritableWrapper;
16 import org.opendaylight.controller.config.manager.impl.dynamicmbean.ReadOnlyAtomicBoolean;
17 import org.opendaylight.controller.config.manager.impl.dynamicmbean.ReadOnlyAtomicBoolean.ReadOnlyAtomicBooleanImpl;
18 import org.opendaylight.controller.config.manager.impl.factoriesresolver.HierarchicalConfigMBeanFactoriesHolder;
19 import org.opendaylight.controller.config.manager.impl.jmx.TransactionJMXRegistrator;
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.manager.impl.util.LookupBeansUtil;
23 import org.opendaylight.controller.config.spi.Module;
24 import org.opendaylight.controller.config.spi.ModuleFactory;
25 import org.opendaylight.yangtools.concepts.Identifiable;
26 import org.osgi.framework.BundleContext;
27 import org.slf4j.Logger;
28 import org.slf4j.LoggerFactory;
30 import javax.annotation.Nullable;
31 import javax.annotation.concurrent.GuardedBy;
32 import javax.management.DynamicMBean;
33 import javax.management.InstanceAlreadyExistsException;
34 import javax.management.InstanceNotFoundException;
35 import javax.management.MBeanServer;
36 import javax.management.ObjectName;
37 import java.util.ArrayList;
38 import java.util.Collection;
39 import java.util.HashSet;
40 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 * {@link #transactionIdentifier}, 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 TransactionIdentifier transactionIdentifier;
59 private final ObjectName controllerON;
60 private final TransactionJMXRegistrator transactionRegistrator;
61 private final TransactionModuleJMXRegistrator txModuleJMXRegistrator;
62 private final long parentVersion, currentVersion;
63 private final HierarchicalConfigMBeanFactoriesHolder factoriesHolder;
64 private final DependencyResolverManager dependencyResolverManager;
65 private final TransactionStatus transactionStatus;
66 private final MBeanServer transactionsMBeanServer;
67 private final List<ModuleFactory> currentlyRegisteredFactories;
70 * Disables ability of {@link DynamicWritableWrapper} to change attributes
74 private final AtomicBoolean configBeanModificationDisabled = new AtomicBoolean(
76 private final ReadOnlyAtomicBoolean readOnlyAtomicBoolean = new ReadOnlyAtomicBooleanImpl(
77 configBeanModificationDisabled);
78 private final MBeanServer configMBeanServer;
80 private final BundleContext bundleContext;
82 public ConfigTransactionControllerImpl(String transactionName,
83 TransactionJMXRegistrator transactionRegistrator,
84 long parentVersion, long currentVersion,
85 List<ModuleFactory> currentlyRegisteredFactories,
86 MBeanServer transactionsMBeanServer, MBeanServer configMBeanServer, BundleContext bundleContext) {
88 this.transactionIdentifier = new TransactionIdentifier(transactionName);
89 this.controllerON = ObjectNameUtil
90 .createTransactionControllerON(transactionName);
91 this.transactionRegistrator = transactionRegistrator;
92 txModuleJMXRegistrator = transactionRegistrator
93 .createTransactionModuleJMXRegistrator();
94 this.parentVersion = parentVersion;
95 this.currentVersion = currentVersion;
96 this.currentlyRegisteredFactories = currentlyRegisteredFactories;
97 this.factoriesHolder = new HierarchicalConfigMBeanFactoriesHolder(currentlyRegisteredFactories);
98 this.transactionStatus = new TransactionStatus();
99 this.dependencyResolverManager = new DependencyResolverManager(transactionName, transactionStatus);
100 this.transactionsMBeanServer = transactionsMBeanServer;
101 this.configMBeanServer = configMBeanServer;
102 this.bundleContext = bundleContext;
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<>(currentlyRegisteredFactories);
125 List<ModuleFactory> toBeAdded = new ArrayList<>();
126 List<ModuleFactory> toBeRemoved = new ArrayList<>();
127 for(ModuleFactory moduleFactory: currentlyRegisteredFactories) {
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, bundleContext);
140 for (Module module : defaultModules) {
142 putConfigBeanToJMXAndInternalMaps(module.getIdentifier(), module, moduleFactory, null);
143 } catch (InstanceAlreadyExistsException e) {
144 throw new IllegalStateException(e);
149 // remove modules belonging to removed factories
150 for(ModuleFactory removedFactory: toBeRemoved){
151 List<ModuleIdentifier> modulesOfRemovedFactory = dependencyResolverManager.findAllByFactory(removedFactory);
152 for (ModuleIdentifier name : modulesOfRemovedFactory) {
159 private synchronized void copyExistingModule(
160 ModuleInternalInfo oldConfigBeanInfo)
161 throws InstanceAlreadyExistsException {
162 transactionStatus.checkNotCommitStarted();
163 transactionStatus.checkNotAborted();
164 ModuleIdentifier moduleIdentifier = oldConfigBeanInfo.getName();
165 dependencyResolverManager.assertNotExists(moduleIdentifier);
167 ModuleFactory moduleFactory = factoriesHolder
168 .findByModuleName(moduleIdentifier.getFactoryName());
171 DependencyResolver dependencyResolver = dependencyResolverManager
172 .getOrCreate(moduleIdentifier);
174 module = moduleFactory.createModule(
175 moduleIdentifier.getInstanceName(), dependencyResolver,
176 oldConfigBeanInfo.getReadableModule(), bundleContext);
177 } catch (Exception e) {
178 throw new IllegalStateException(format(
179 "Error while copying old configuration from %s to %s",
180 oldConfigBeanInfo, moduleFactory), e);
182 putConfigBeanToJMXAndInternalMaps(moduleIdentifier, module, moduleFactory, oldConfigBeanInfo);
186 public synchronized ObjectName createModule(String factoryName,
187 String instanceName) throws InstanceAlreadyExistsException {
189 transactionStatus.checkNotCommitStarted();
190 transactionStatus.checkNotAborted();
191 ModuleIdentifier moduleIdentifier = new ModuleIdentifier(factoryName, instanceName);
192 dependencyResolverManager.assertNotExists(moduleIdentifier);
195 ModuleFactory moduleFactory = factoriesHolder.findByModuleName(factoryName);
196 DependencyResolver dependencyResolver = dependencyResolverManager.getOrCreate(moduleIdentifier);
197 Module module = moduleFactory.createModule(instanceName, dependencyResolver, bundleContext);
198 return putConfigBeanToJMXAndInternalMaps(moduleIdentifier, module,
199 moduleFactory, null);
202 private synchronized ObjectName putConfigBeanToJMXAndInternalMaps(
203 ModuleIdentifier moduleIdentifier, Module module,
204 ModuleFactory moduleFactory,
205 @Nullable ModuleInternalInfo maybeOldConfigBeanInfo)
206 throws InstanceAlreadyExistsException {
207 logger.debug("Adding module {} to transaction {}", moduleIdentifier, this);
208 if (moduleIdentifier.equals(module.getIdentifier())==false) {
209 throw new IllegalStateException("Incorrect name reported by module. Expected "
210 + moduleIdentifier + ", got " + module.getIdentifier());
212 DynamicMBean writableDynamicWrapper = new DynamicWritableWrapper(
213 module, moduleIdentifier, transactionIdentifier,
214 readOnlyAtomicBoolean, transactionsMBeanServer,
217 ObjectName writableON = ObjectNameUtil.createTransactionModuleON(
218 transactionIdentifier.getName(), moduleIdentifier);
219 // put wrapper to jmx
220 TransactionModuleJMXRegistration transactionModuleJMXRegistration = txModuleJMXRegistrator
221 .registerMBean(writableDynamicWrapper, writableON);
222 ModuleInternalTransactionalInfo moduleInternalTransactionalInfo = new ModuleInternalTransactionalInfo(
223 moduleIdentifier, module, moduleFactory,
224 maybeOldConfigBeanInfo, transactionModuleJMXRegistration);
226 dependencyResolverManager.put(moduleInternalTransactionalInfo);
231 public void destroyModule(ObjectName objectName)
232 throws InstanceNotFoundException {
233 String foundTransactionName = ObjectNameUtil
234 .getTransactionName(objectName);
235 if (transactionIdentifier.getName().equals(foundTransactionName) == false) {
236 throw new IllegalArgumentException("Wrong transaction name "
239 ObjectNameUtil.checkDomain(objectName);
240 ModuleIdentifier moduleIdentifier = ObjectNameUtil.fromON(objectName,
241 ObjectNameUtil.TYPE_MODULE);
242 destroyModule(moduleIdentifier);
245 private void destroyModule(ModuleIdentifier moduleIdentifier) {
246 logger.debug("Destroying module {} in transaction {}", moduleIdentifier, this);
247 transactionStatus.checkNotAborted();
248 ModuleInternalTransactionalInfo removedTInfo = dependencyResolverManager.destroyModule(moduleIdentifier);
250 removedTInfo.getTransactionModuleJMXRegistration().close();
254 public long getParentVersion() {
255 return parentVersion;
259 public long getVersion() {
260 return currentVersion;
264 public synchronized void validateConfig() throws ValidationException {
265 if (configBeanModificationDisabled.get())
266 throw new IllegalStateException("Cannot start validation");
267 configBeanModificationDisabled.set(true);
271 configBeanModificationDisabled.set(false);
275 private void validate_noLocks() throws ValidationException {
276 transactionStatus.checkNotAborted();
277 logger.info("Validating transaction {}", transactionIdentifier);
279 List<ValidationException> collectedExceptions = new ArrayList<>();
280 for (Entry<ModuleIdentifier, Module> entry : dependencyResolverManager
281 .getAllModules().entrySet()) {
282 ModuleIdentifier name = entry.getKey();
283 Module module = entry.getValue();
286 } catch (Exception e) {
287 logger.warn("Validation exception in {}", getTransactionName(),
289 collectedExceptions.add(ValidationException
290 .createForSingleException(name, e));
293 if (collectedExceptions.size() > 0) {
294 throw ValidationException
295 .createFromCollectedValidationExceptions(collectedExceptions);
297 logger.info("Validated transaction {}", transactionIdentifier);
301 * If this method passes validation, it will grab
302 * {@link TransactionStatus#secondPhaseCommitStarted} lock. This lock will
303 * prevent calling @{link #validateBeforeCommitAndLockTransaction},
304 * effectively only allowing to call {@link #secondPhaseCommit} after
305 * successful return of this method.
308 public synchronized CommitInfo validateBeforeCommitAndLockTransaction()
309 throws ValidationException {
310 transactionStatus.checkNotAborted();
311 transactionStatus.checkNotCommitStarted();
312 configBeanModificationDisabled.set(true);
315 } catch (ValidationException e) {
316 logger.info("Commit failed on validation");
317 configBeanModificationDisabled.set(false); // recoverable error
320 // errors in this state are not recoverable. modules are not mutable
322 transactionStatus.setSecondPhaseCommitStarted();
323 return dependencyResolverManager.toCommitInfo();
330 public synchronized List<ModuleIdentifier> secondPhaseCommit() {
331 transactionStatus.checkNotAborted();
332 transactionStatus.checkCommitStarted();
333 if (configBeanModificationDisabled.get() == false) {
334 throw new IllegalStateException(
335 "Internal error - validateBeforeCommitAndLockTransaction should be called "
336 + "to obtain a lock");
339 logger.info("Committing transaction {}", transactionIdentifier);
341 // call getInstance()
342 for (Entry<ModuleIdentifier, Module> entry : dependencyResolverManager
343 .getAllModules().entrySet()) {
344 Module module = entry.getValue();
345 ModuleIdentifier name = entry.getKey();
347 logger.debug("About to commit {} in transaction {}",
348 name, transactionIdentifier);
349 module.getInstance();
350 } catch (Exception e) {
351 logger.error("Commit failed on {} in transaction {}", name,
352 transactionIdentifier, e);
354 throw new RuntimeException(
355 format("Error - getInstance() failed for %s in transaction %s",
356 name, transactionIdentifier), e);
360 // count dependency order
362 logger.info("Committed configuration {}", transactionIdentifier);
363 transactionStatus.setCommitted();
364 // unregister this and all modules from jmx
367 return dependencyResolverManager.getSortedModuleIdentifiers();
371 public synchronized void abortConfig() {
372 transactionStatus.checkNotCommitStarted();
373 transactionStatus.checkNotAborted();
377 private void internalAbort() {
378 transactionStatus.setAborted();
382 private void close() {
383 transactionRegistrator.close();
387 public ObjectName getControllerObjectName() {
392 public String getTransactionName() {
393 return transactionIdentifier.getName();
400 public Set<ObjectName> lookupConfigBeans() {
401 return lookupConfigBeans("*", "*");
408 public Set<ObjectName> lookupConfigBeans(String moduleName) {
409 return lookupConfigBeans(moduleName, "*");
416 public ObjectName lookupConfigBean(String moduleName, String instanceName)
417 throws InstanceNotFoundException {
418 return LookupBeansUtil.lookupConfigBean(this, moduleName, instanceName);
425 public Set<ObjectName> lookupConfigBeans(String moduleName,
426 String instanceName) {
427 ObjectName namePattern = ObjectNameUtil.createModulePattern(moduleName,
428 instanceName, transactionIdentifier.getName());
429 return txModuleJMXRegistrator.queryNames(namePattern, null);
433 public Set<String> getAvailableModuleNames() {
434 return factoriesHolder.getModuleNames();
438 public boolean isClosed() {
439 return transactionStatus.isAbortedOrCommitted();
443 public String toString() {
444 StringBuilder sb = new StringBuilder();
445 sb.append("transactionName=");
446 sb.append(getTransactionName());
447 return sb.toString();
450 // @VisibleForTesting
452 TransactionModuleJMXRegistrator getTxModuleJMXRegistrator() {
453 return txModuleJMXRegistrator;
456 public TransactionIdentifier getName() {
457 return transactionIdentifier;
461 public List<ModuleFactory> getCurrentlyRegisteredFactories() {
462 return currentlyRegisteredFactories;
466 public TransactionIdentifier getIdentifier() {
467 return transactionIdentifier;