2 * Copyright (c) 2014 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.mdsal.dom.spi.store;
10 import static com.google.common.base.Preconditions.checkState;
12 import com.google.common.annotations.Beta;
13 import com.google.common.base.MoreObjects.ToStringHelper;
14 import com.google.common.base.Optional;
15 import com.google.common.base.Preconditions;
16 import com.google.common.base.Throwables;
17 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
20 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
21 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
22 import org.slf4j.Logger;
23 import org.slf4j.LoggerFactory;
26 * Implementation of Write transaction which is backed by
27 * {@link DataTreeSnapshot} and executed according to
28 * {@link org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction.TransactionReadyPrototype}.
30 * @param <T> Identifier type
33 public class SnapshotBackedWriteTransaction<T> extends AbstractDOMStoreTransaction<T>
34 implements DOMStoreWriteTransaction {
36 private static final Logger LOG = LoggerFactory.getLogger(SnapshotBackedWriteTransaction.class);
38 @SuppressWarnings("rawtypes")
39 private static final AtomicReferenceFieldUpdater<SnapshotBackedWriteTransaction,
40 TransactionReadyPrototype> READY_UPDATER =
41 AtomicReferenceFieldUpdater.newUpdater(SnapshotBackedWriteTransaction.class,
42 TransactionReadyPrototype.class, "readyImpl");
44 @SuppressWarnings("rawtypes")
45 private static final AtomicReferenceFieldUpdater<SnapshotBackedWriteTransaction,
46 DataTreeModification> TREE_UPDATER =
47 AtomicReferenceFieldUpdater.newUpdater(SnapshotBackedWriteTransaction.class,
48 DataTreeModification.class, "mutableTree");
50 // non-null when not ready
51 private volatile TransactionReadyPrototype<T> readyImpl;
52 // non-null when not committed/closed
53 private volatile DataTreeModification mutableTree;
55 SnapshotBackedWriteTransaction(final T identifier, final boolean debug,
56 final DataTreeSnapshot snapshot, final TransactionReadyPrototype<T> readyImpl) {
57 super(identifier, debug);
58 this.readyImpl = Preconditions.checkNotNull(readyImpl, "readyImpl must not be null.");
59 mutableTree = snapshot.newModification();
60 LOG.debug("Write Tx: {} allocated with snapshot {}", identifier, snapshot);
63 @SuppressWarnings("checkstyle:IllegalCatch")
65 public void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
68 final DataTreeModification tree = mutableTree;
69 LOG.debug("Tx: {} Write: {}:{}", getIdentifier(), path, data);
72 tree.write(path, data);
73 // FIXME: Add checked exception
74 } catch (Exception e) {
75 LOG.error("Tx: {}, failed to write {}:{} in {}", getIdentifier(), path, data, tree, e);
76 // Rethrow original ones if they are subclasses of RuntimeException or Error
77 Throwables.throwIfUnchecked(e);
78 // FIXME: Introduce proper checked exception
79 throw new IllegalArgumentException("Illegal input data.", e);
83 @SuppressWarnings("checkstyle:IllegalCatch")
85 public void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
88 final DataTreeModification tree = mutableTree;
89 LOG.debug("Tx: {} Merge: {}:{}", getIdentifier(), path, data);
92 tree.merge(path, data);
93 // FIXME: Add checked exception
94 } catch (Exception e) {
95 LOG.error("Tx: {}, failed to write {}:{} in {}", getIdentifier(), path, data, tree, e);
96 // Rethrow original ones if they are subclasses of RuntimeException or Error
97 Throwables.throwIfUnchecked(e);
98 // FIXME: Introduce proper checked exception
99 throw new IllegalArgumentException("Illegal input data.", e);
103 @SuppressWarnings("checkstyle:IllegalCatch")
105 public void delete(final YangInstanceIdentifier path) {
108 final DataTreeModification tree = mutableTree;
109 LOG.debug("Tx: {} Delete: {}", getIdentifier(), path);
113 // FIXME: Add checked exception
114 } catch (Exception e) {
115 LOG.error("Tx: {}, failed to delete {} in {}", getIdentifier(), path, tree, e);
116 // Rethrow original ones if they are subclasses of RuntimeException or Error
117 Throwables.throwIfUnchecked(e);
118 // FIXME: Introduce proper checked exception
119 throw new IllegalArgumentException("Illegal path to delete.", e);
124 * Exposed for {@link SnapshotBackedReadWriteTransaction}'s sake only. The contract does
125 * not allow data access after the transaction has been closed or readied.
127 * @param path Path to read
128 * @return null if the the transaction has been closed;
130 final Optional<NormalizedNode<?, ?>> readSnapshotNode(final YangInstanceIdentifier path) {
131 return readyImpl == null ? null : mutableTree.readNode(path);
134 private void checkNotReady() {
135 checkState(readyImpl != null,
136 "Transaction %s is no longer open. No further modifications allowed.", getIdentifier());
140 public DOMStoreThreePhaseCommitCohort ready() {
141 @SuppressWarnings("unchecked")
142 final TransactionReadyPrototype<T> wasReady = READY_UPDATER.getAndSet(this, null);
143 checkState(wasReady != null, "Transaction %s is no longer open", getIdentifier());
145 LOG.debug("Store transaction: {} : Ready", getIdentifier());
147 final DataTreeModification tree = mutableTree;
148 TREE_UPDATER.lazySet(this, null);
150 return wasReady.transactionReady(this, tree);
154 public void close() {
155 @SuppressWarnings("unchecked")
156 final TransactionReadyPrototype<T> wasReady = READY_UPDATER.getAndSet(this, null);
157 if (wasReady != null) {
158 LOG.debug("Store transaction: {} : Closed", getIdentifier());
159 TREE_UPDATER.lazySet(this, null);
160 wasReady.transactionAborted(this);
162 LOG.debug("Store transaction: {} : Closed after submit", getIdentifier());
167 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
168 return toStringHelper.add("ready", readyImpl == null);
172 * Prototype implementation of {@link SnapshotBackedWriteTransaction#ready()}.
175 * This class is intended to be implemented by Transaction factories responsible for allocation
176 * of {@link org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction} and
177 * providing underlying logic for applying implementation.
179 * @param <T> identifier type
181 public abstract static class TransactionReadyPrototype<T> {
183 * Called when a transaction is closed without being readied. This is not invoked for
184 * transactions which are ready.
186 * @param tx Transaction which got aborted.
188 protected abstract void transactionAborted(SnapshotBackedWriteTransaction<T> tx);
191 * Returns a commit coordinator associated with supplied transactions.
192 * This call must not fail.
195 * Transaction on which ready was invoked.
197 * Modified data tree which has been constructed.
198 * @return DOMStoreThreePhaseCommitCohort associated with transaction
200 protected abstract DOMStoreThreePhaseCommitCohort transactionReady(
201 SnapshotBackedWriteTransaction<T> tx, DataTreeModification tree);