2 * Copyright (c) 2015 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.netconf.mdsal.connector;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.util.concurrent.CheckedFuture;
14 import java.util.ArrayList;
15 import java.util.List;
16 import org.opendaylight.controller.config.util.xml.DocumentedException;
17 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorSeverity;
18 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorTag;
19 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorType;
20 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
21 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
22 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
23 import org.slf4j.Logger;
24 import org.slf4j.LoggerFactory;
26 public class TransactionProvider implements AutoCloseable{
28 private static final Logger LOG = LoggerFactory.getLogger(TransactionProvider.class);
30 private final DOMDataBroker dataBroker;
32 private DOMDataReadWriteTransaction candidateTransaction = null;
33 private DOMDataReadWriteTransaction runningTransaction = null;
34 private final List<DOMDataReadWriteTransaction> allOpenReadWriteTransactions = new ArrayList<>();
36 private final String netconfSessionIdForReporting;
38 private static final String NO_TRANSACTION_FOUND_FOR_SESSION = "No candidateTransaction found for session ";
41 public TransactionProvider(DOMDataBroker dataBroker, String netconfSessionIdForReporting) {
42 this.dataBroker = dataBroker;
43 this.netconfSessionIdForReporting = netconfSessionIdForReporting;
47 public synchronized void close() throws Exception {
48 for (DOMDataReadWriteTransaction rwt : allOpenReadWriteTransactions) {
52 allOpenReadWriteTransactions.clear();
55 public synchronized Optional<DOMDataReadWriteTransaction> getCandidateTransaction() {
56 if (candidateTransaction == null) {
57 return Optional.absent();
60 return Optional.of(candidateTransaction);
63 public synchronized DOMDataReadWriteTransaction getOrCreateTransaction() {
64 if (getCandidateTransaction().isPresent()) {
65 return getCandidateTransaction().get();
68 candidateTransaction = dataBroker.newReadWriteTransaction();
69 allOpenReadWriteTransactions.add(candidateTransaction);
70 return candidateTransaction;
73 public synchronized boolean commitTransaction() throws DocumentedException {
74 if (!getCandidateTransaction().isPresent()) {
75 //making empty commit without prior opened transaction, just return true
76 LOG.debug("Making commit without open candidate transaction for session {}", netconfSessionIdForReporting);
80 CheckedFuture<Void, TransactionCommitFailedException> future = candidateTransaction.submit();
83 } catch (TransactionCommitFailedException e) {
84 LOG.debug("Transaction {} failed on", candidateTransaction, e);
85 final String cause = e.getCause() != null ? (" Cause: " + e.getCause().getMessage()) : "";
86 throw new DocumentedException("Transaction commit failed on " + e.getMessage() + " " + netconfSessionIdForReporting +
88 ErrorType.application, ErrorTag.operation_failed, ErrorSeverity.error);
90 allOpenReadWriteTransactions.remove(candidateTransaction);
91 candidateTransaction = null;
97 public synchronized void abortTransaction() {
98 LOG.debug("Aborting current candidateTransaction");
99 Optional<DOMDataReadWriteTransaction> otx = getCandidateTransaction();
100 if (!otx.isPresent()) {
101 LOG.warn("discard-changes triggerd on an empty transaction for session: {}", netconfSessionIdForReporting );
104 candidateTransaction.cancel();
105 allOpenReadWriteTransactions.remove(candidateTransaction);
106 candidateTransaction = null;
109 public synchronized DOMDataReadWriteTransaction createRunningTransaction() {
110 runningTransaction = dataBroker.newReadWriteTransaction();
111 allOpenReadWriteTransactions.add(runningTransaction);
112 return runningTransaction;
115 public synchronized boolean commitRunningTransaction(DOMDataReadWriteTransaction tx) throws DocumentedException {
116 allOpenReadWriteTransactions.remove(tx);
118 CheckedFuture<Void, TransactionCommitFailedException> future = tx.submit();
121 } catch (TransactionCommitFailedException e) {
122 LOG.debug("Transaction {} failed on", tx, e);
123 throw new DocumentedException("Transaction commit failed on " + e.getMessage() + " " + netconfSessionIdForReporting,
124 ErrorType.application, ErrorTag.operation_failed, ErrorSeverity.error);
130 public synchronized void abortRunningTransaction(DOMDataReadWriteTransaction tx) {
131 LOG.debug("Aborting current running Transaction");
132 Preconditions.checkState(runningTransaction != null, NO_TRANSACTION_FOUND_FOR_SESSION + netconfSessionIdForReporting);
134 allOpenReadWriteTransactions.remove(tx);