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