dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/AbstractDOMForwardedTransactionFactory.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.dom.broker;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import java.util.Collection;
  13 import java.util.EnumMap;
  14 import java.util.Map;
  15 import java.util.Map.Entry;
  16 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  17 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  18 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  19 import org.opendaylight.mdsal.dom.api.DOMDataReadOnlyTransaction;
  20 import org.opendaylight.mdsal.dom.api.DOMDataReadWriteTransaction;
  21 import org.opendaylight.mdsal.dom.api.DOMDataWriteTransaction;
  22 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
  23 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
  24 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
  25 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionFactory;
  26 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  27
  28 /**
  29  *
  30  * Abstract composite transaction factory.
  31  *
  32  * Provides an convenience common implementation for composite DOM Transactions,
  33  * where subtransaction is identified by {@link LogicalDatastoreType} type and
  34  * implementation of subtransaction is provided by
  35  * {@link DOMStoreTransactionFactory}.
  36  *
  37  * <b>Note:</b>This class does not have thread-safe implementation of  {@link #close()},
  38  *   implementation may allow accessing and allocating new transactions during closing
  39  *   this instance.
  40  *
  41  * @param <T>
  42  *            Type of {@link DOMStoreTransactionFactory} factory.
  43  */
  44 abstract class AbstractDOMForwardedTransactionFactory<T extends DOMStoreTransactionFactory> implements AutoCloseable {
  45     @SuppressWarnings("rawtypes")
  46     private static final AtomicIntegerFieldUpdater<AbstractDOMForwardedTransactionFactory> UPDATER =
  47             AtomicIntegerFieldUpdater.newUpdater(AbstractDOMForwardedTransactionFactory.class, "closed");
  48     private final Map<LogicalDatastoreType, T> storeTxFactories;
  49     private volatile int closed = 0;
  50
  51     protected AbstractDOMForwardedTransactionFactory(final Map<LogicalDatastoreType, ? extends T> txFactories) {
  52         this.storeTxFactories = new EnumMap<>(txFactories);
  53     }
  54
  55     /**
  56      * Implementations must return unique identifier for each and every call of
  57      * this method;
  58      *
  59      * @return new Unique transaction identifier.
  60      */
  61     protected abstract Object newTransactionIdentifier();
  62
  63     /**
  64      * User-supplied implementation of {@link DOMDataWriteTransaction#submit()} for transaction.
  65      *
  66      * Callback invoked when {@link DOMDataWriteTransaction#submit()} is invoked on transaction
  67      * created by this factory.
  68      *
  69      * @param transaction Transaction on which {@link DOMDataWriteTransaction#submit()} was invoked.
  70      * @param cohorts Iteratable of cohorts for subtransactions associated with the transaction
  71      *        being committed.
  72      * @return a CheckedFuture. if commit coordination on cohorts finished successfully, nothing is
  73      *         returned from the Future, On failure, the Future fails with a
  74      *         {@link TransactionCommitFailedException}.
  75      */
  76     protected abstract CheckedFuture<Void,TransactionCommitFailedException> submit(final DOMDataWriteTransaction transaction,
  77             final Collection<DOMStoreThreePhaseCommitCohort> cohorts);
  78
  79     /**
  80      * Creates a new composite read-only transaction
  81      *
  82      * Creates a new composite read-only transaction backed by one transaction per factory in
  83      * {@link #getTxFactories()}.
  84      *
  85      * Subtransaction for reading is selected by supplied {@link LogicalDatastoreType} as parameter
  86      * for
  87      * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
  88      * .
  89      *
  90      * Id of returned transaction is retrieved via {@link #newTransactionIdentifier()}.
  91      *
  92      * @return New composite read-only transaction.
  93      */
  94     public final DOMDataReadOnlyTransaction newReadOnlyTransaction() {
  95         checkNotClosed();
  96
  97         final Map<LogicalDatastoreType, DOMStoreReadTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
  98         for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
  99             txns.put(store.getKey(), store.getValue().newReadOnlyTransaction());
 100         }
 101         return new DOMForwardedReadOnlyTransaction(newTransactionIdentifier(), txns);
 102     }
 103
 104     /**
 105      * Creates a new composite write-only transaction
 106      *
 107      * <p>
 108      * Creates a new composite write-only transaction backed by one write-only transaction per
 109      * factory in {@link #getTxFactories()}.
 110      *
 111      * <p>
 112      * Implementation of composite Write-only transaction is following:
 113      *
 114      * <ul>
 115      * <li>
 116      * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 117      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 118      * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 119      * is invoked on selected subtransaction.</li>
 120      * <li>
 121      * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 122      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 123      * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 124      * is invoked on selected subtransaction.</li>
 125      * <li>
 126      * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
 127      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 128      * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
 129      * is invoked on selected subtransaction.
 130      * <li> {@link DOMDataWriteTransaction#submit()} - results in invoking
 131      * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts and then invoking
 132      * finalized implementation callback {@link #submit(DOMDataWriteTransaction, Collection)} with
 133      * transaction which was commited and gathered results.</li>
 134      * </ul>
 135      *
 136      * Id of returned transaction is generated via {@link #newTransactionIdentifier()}.
 137      *
 138      * @return New composite write-only transaction associated with this factory.
 139      */
 140     public final DOMDataWriteTransaction newWriteOnlyTransaction() {
 141         checkNotClosed();
 142
 143         final Map<LogicalDatastoreType, DOMStoreWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
 144         for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
 145             txns.put(store.getKey(), store.getValue().newWriteOnlyTransaction());
 146         }
 147         return new DOMForwardedWriteTransaction<DOMStoreWriteTransaction>(newTransactionIdentifier(), txns, this);
 148     }
 149
 150     /**
 151      * Creates a new composite write-only transaction
 152      *
 153      * <p>
 154      * Creates a new composite write-only transaction backed by one write-only transaction per
 155      * factory in {@link #getTxFactories()}.
 156      * <p>
 157      * Implementation of composite Write-only transaction is following:
 158      *
 159      * <ul>
 160      * <li>
 161      * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 162      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 163      * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 164      * is invoked on selected subtransaction.</li>
 165      * <li>
 166      * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 167      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 168      * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 169      * is invoked on selected subtransaction.</li>
 170      * <li>
 171      * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
 172      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 173      * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
 174      * is invoked on selected subtransaction.</li>
 175      * <li> {@link DOMDataWriteTransaction#submit()} - results in invoking
 176      * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts and then invoking
 177      * finalized implementation callback {@link #submit(DOMDataWriteTransaction, Collection)} with
 178      * transaction which was commited and gathered results.</li>
 179      * </ul>
 180      *
 181      * Id of returned transaction is generated via {@link #newTransactionIdentifier()}.
 182      *
 183      * @return New composite read-write transaction associated with this factory.
 184      */
 185     public final DOMDataReadWriteTransaction newReadWriteTransaction() {
 186         checkNotClosed();
 187
 188         final Map<LogicalDatastoreType, DOMStoreReadWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
 189         for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
 190             txns.put(store.getKey(), store.getValue().newReadWriteTransaction());
 191         }
 192         return new DOMForwardedReadWriteTransaction(newTransactionIdentifier(), txns, this);
 193     }
 194
 195     /**
 196      * Convenience accessor of backing factories intended to be used only by
 197      * finalization of this class.
 198      *
 199      * <b>Note:</b>
 200      * Finalization of this class may want to access other functionality of
 201      * supplied Transaction factories.
 202      *
 203      * @return Map of backing transaction factories.
 204      */
 205     protected final Map<LogicalDatastoreType, T> getTxFactories() {
 206         return storeTxFactories;
 207     }
 208
 209     /**
 210      * Checks if instance is not closed.
 211      *
 212      * @throws IllegalStateException If instance of this class was closed.
 213      *
 214      */
 215     protected final void checkNotClosed() {
 216         Preconditions.checkState(closed == 0, "Transaction factory was closed. No further operations allowed.");
 217     }
 218
 219     @Override
 220     public void close() {
 221         final boolean success = UPDATER.compareAndSet(this, 0, 1);
 222         Preconditions.checkState(success, "Transaction factory was already closed");
 223     }
 224 }
 225