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
9 package org.opendaylight.controller.netconf.confignetconfconnector.transactions;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import org.opendaylight.controller.config.api.ValidationException;
14 import org.opendaylight.controller.config.api.jmx.CommitStatus;
15 import org.opendaylight.controller.config.util.ConfigRegistryClient;
16 import org.opendaylight.controller.config.util.ConfigTransactionClient;
17 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
18 import org.slf4j.Logger;
19 import org.slf4j.LoggerFactory;
21 import javax.management.InstanceNotFoundException;
22 import javax.management.ObjectName;
23 import java.util.ArrayList;
24 import java.util.List;
27 public class TransactionProvider implements AutoCloseable {
28 private static final Logger logger = LoggerFactory.getLogger(TransactionProvider.class);
30 private final ConfigRegistryClient configRegistryClient;
32 private final String netconfSessionIdForReporting;
33 private ObjectName transaction;
34 private final List<ObjectName> allOpenedTransactions = new ArrayList<>();
36 public TransactionProvider(ConfigRegistryClient configRegistryClient, String netconfSessionIdForReporting) {
37 this.configRegistryClient = configRegistryClient;
38 this.netconfSessionIdForReporting = netconfSessionIdForReporting;
42 public synchronized void close() {
43 for (ObjectName tx : allOpenedTransactions) {
44 if (isStillOpenTransaction(tx)) {
46 configRegistryClient.getConfigTransactionClient(tx).abortConfig();
47 } catch (Exception e) {
48 logger.debug("Ignoring {} while closing transaction {}", e.toString(), tx, e);
52 allOpenedTransactions.clear();
55 public Optional<ObjectName> getTransaction() {
57 if (transaction == null)
58 return Optional.absent();
60 // Transaction was already closed somehow
61 if (isStillOpenTransaction(transaction) == false) {
62 logger.warn("Fixing illegal state: transaction {} was closed in {}", transaction,
63 netconfSessionIdForReporting);
65 return Optional.absent();
67 return Optional.of(transaction);
70 private boolean isStillOpenTransaction(ObjectName transaction) {
71 boolean isStillOpenTransaction = configRegistryClient.getOpenConfigs().contains(transaction);
72 return isStillOpenTransaction;
75 public synchronized ObjectName getOrCreateTransaction() {
76 Optional<ObjectName> ta = getTransaction();
80 transaction = configRegistryClient.beginConfig();
81 allOpenedTransactions.add(transaction);
86 * Used for editConfig test option
88 public synchronized ObjectName getTestTransaction() {
89 ObjectName testTx = configRegistryClient.beginConfig();
90 allOpenedTransactions.add(testTx);
95 * Commit and notification send must be atomic
97 public synchronized CommitStatus commitTransaction() throws NetconfDocumentedException {
98 final Optional<ObjectName> taON = getTransaction();
99 Preconditions.checkState(taON.isPresent(), "No transaction found for session " + netconfSessionIdForReporting);
100 CommitStatus status = configRegistryClient.commitConfig(taON.get());
101 allOpenedTransactions.remove(transaction);
106 public synchronized void abortTransaction() {
107 Optional<ObjectName> taON = getTransaction();
108 Preconditions.checkState(taON.isPresent(), "No transaction found for session " + netconfSessionIdForReporting);
110 ConfigTransactionClient transactionClient = configRegistryClient.getConfigTransactionClient(taON.get());
111 transactionClient.abortConfig();
112 allOpenedTransactions.remove(transaction);
116 public synchronized void abortTestTransaction(ObjectName testTx) {
117 ConfigTransactionClient transactionClient = configRegistryClient.getConfigTransactionClient(testTx);
118 allOpenedTransactions.remove(testTx);
119 transactionClient.abortConfig();
122 public void validateTransaction() throws ValidationException {
123 Optional<ObjectName> taON = getTransaction();
124 Preconditions.checkState(taON.isPresent(), "No transaction found for session " + netconfSessionIdForReporting);
126 ConfigTransactionClient transactionClient = configRegistryClient.getConfigTransactionClient(taON.get());
127 transactionClient.validateConfig();
130 public void validateTestTransaction(ObjectName taON) {
131 ConfigTransactionClient transactionClient = configRegistryClient.getConfigTransactionClient(taON);
132 transactionClient.validateConfig();
135 public void wipeTestTransaction(ObjectName taON) {
136 wipeInternal(taON, true, null);
140 * Wiping means removing all module instances keeping the transaction open.
142 synchronized void wipeInternal(ObjectName taON, boolean isTest, String moduleName) {
143 ConfigTransactionClient transactionClient = configRegistryClient.getConfigTransactionClient(taON);
145 Set<ObjectName> lookupConfigBeans = moduleName == null ? transactionClient.lookupConfigBeans()
146 : transactionClient.lookupConfigBeans(moduleName);
147 for (ObjectName instance : lookupConfigBeans) {
149 transactionClient.destroyModule(instance);
150 } catch (InstanceNotFoundException e) {
152 logger.debug("Unable to clean configuration in transactiom {}", taON, e);
154 logger.warn("Unable to clean configuration in transactiom {}", taON, e);
156 throw new IllegalStateException("Unable to clean configuration in transactiom " + taON, e);
159 logger.debug("Transaction {} wiped clean", taON);
162 public void wipeTransaction() {
163 Optional<ObjectName> taON = getTransaction();
164 Preconditions.checkState(taON.isPresent(), "No transaction found for session " + netconfSessionIdForReporting);
165 wipeInternal(taON.get(), false, null);