dom/mdsal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/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.controller.md.sal.dom.broker.impl;
   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.controller.md.sal.common.api.data.LogicalDatastoreType;
  18 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  22 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
  23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
  24 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  25 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory;
  26 import org.opendaylight.controller.sal.core.spi.data.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()}
  65      * for transaction.
  66      *
  67      * Callback invoked when {@link DOMDataWriteTransaction#submit()} is invoked
  68      * on transaction created by this factory.
  69      *
  70      * @param transaction
  71      *            Transaction on which {@link DOMDataWriteTransaction#commit()}
  72      *            was invoked.
  73      * @param cohorts
  74      *            Iteratable of cohorts for subtransactions associated with
  75      *            the transaction being committed.
  76      * @return a CheckedFuture. if commit coordination on cohorts finished successfully,
  77      *         nothing is returned from the Future, On failure,
  78      *         the Future fails with a {@link TransactionCommitFailedException}.
  79      */
  80     protected abstract CheckedFuture<Void,TransactionCommitFailedException> submit(final DOMDataWriteTransaction transaction,
  81             final Collection<DOMStoreThreePhaseCommitCohort> cohorts);
  82
  83     /**
  84      * Creates a new composite read-only transaction
  85      *
  86      * Creates a new composite read-only transaction backed by one transaction per factory in
  87      * {@link #getTxFactories()}.
  88      *
  89      * Subtransaction for reading is selected by supplied {@link LogicalDatastoreType} as parameter
  90      * for
  91      * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
  92      * .
  93      *
  94      * Id of returned transaction is retrieved via {@link #newTransactionIdentifier()}.
  95      *
  96      * @return New composite read-only transaction.
  97      */
  98     public final DOMDataReadOnlyTransaction newReadOnlyTransaction() {
  99         checkNotClosed();
 100
 101         final Map<LogicalDatastoreType, DOMStoreReadTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
 102         for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
 103             txns.put(store.getKey(), store.getValue().newReadOnlyTransaction());
 104         }
 105         return new DOMForwardedReadOnlyTransaction(newTransactionIdentifier(), txns);
 106     }
 107
 108     /**
 109      * Creates a new composite write-only transaction
 110      *
 111      * <p>
 112      * Creates a new composite write-only transaction backed by one write-only transaction per
 113      * factory in {@link #getTxFactories()}.
 114      *
 115      * <p>
 116      * Implementation of composite Write-only transaction is following:
 117      *
 118      * <ul>
 119      * <li>
 120      * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 121      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 122      * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 123      * is invoked on selected subtransaction.</li>
 124      * <li>
 125      * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 126      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 127      * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 128      * is invoked on selected subtransaction.</li>
 129      * <li>
 130      * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
 131      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 132      * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
 133      * is invoked on selected subtransaction.
 134      * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
 135      * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts and then invoking
 136      * finalized implementation callback {@link #submit(DOMDataWriteTransaction, Collection)} with
 137      * transaction which was commited and gathered results.</li>
 138      * </ul>
 139      *
 140      * Id of returned transaction is generated via {@link #newTransactionIdentifier()}.
 141      *
 142      * @return New composite write-only transaction associated with this factory.
 143      */
 144     public final DOMDataWriteTransaction newWriteOnlyTransaction() {
 145         checkNotClosed();
 146
 147         final Map<LogicalDatastoreType, DOMStoreWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
 148         for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
 149             txns.put(store.getKey(), store.getValue().newWriteOnlyTransaction());
 150         }
 151         return new DOMForwardedWriteTransaction<DOMStoreWriteTransaction>(newTransactionIdentifier(), txns, this);
 152     }
 153
 154     /**
 155      * Creates a new composite write-only transaction
 156      *
 157      * <p>
 158      * Creates a new composite write-only transaction backed by one write-only transaction per
 159      * factory in {@link #getTxFactories()}.
 160      * <p>
 161      * Implementation of composite Write-only transaction is following:
 162      *
 163      * <ul>
 164      * <li>
 165      * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 166      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 167      * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 168      * is invoked on selected subtransaction.</li>
 169      * <li>
 170      * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 171      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 172      * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
 173      * is invoked on selected subtransaction.</li>
 174      * <li>
 175      * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
 176      * - backing subtransaction is selected by {@link LogicalDatastoreType},
 177      * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
 178      * is invoked on selected subtransaction.</li>
 179      * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
 180      * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts and then invoking
 181      * finalized implementation callback {@link #submit(DOMDataWriteTransaction, Collection)} with
 182      * transaction which was commited and gathered results.</li>
 183      * </ul>
 184      *
 185      * Id of returned transaction is generated via {@link #newTransactionIdentifier()}.
 186      *
 187      * @return New composite read-write transaction associated with this factory.
 188      */
 189     public final DOMDataReadWriteTransaction newReadWriteTransaction() {
 190         checkNotClosed();
 191
 192         final Map<LogicalDatastoreType, DOMStoreReadWriteTransaction> txns = new EnumMap<>(LogicalDatastoreType.class);
 193         for (final Entry<LogicalDatastoreType, T> store : storeTxFactories.entrySet()) {
 194             txns.put(store.getKey(), store.getValue().newReadWriteTransaction());
 195         }
 196         return new DOMForwardedReadWriteTransaction(newTransactionIdentifier(), txns, this);
 197     }
 198
 199     /**
 200      * Convenience accessor of backing factories intended to be used only by
 201      * finalization of this class.
 202      *
 203      * <b>Note:</b>
 204      * Finalization of this class may want to access other functionality of
 205      * supplied Transaction factories.
 206      *
 207      * @return Map of backing transaction factories.
 208      */
 209     protected final Map<LogicalDatastoreType, T> getTxFactories() {
 210         return storeTxFactories;
 211     }
 212
 213     /**
 214      * Checks if instance is not closed.
 215      *
 216      * @throws IllegalStateException If instance of this class was closed.
 217      *
 218      */
 219     protected final void checkNotClosed() {
 220         Preconditions.checkState(closed == 0, "Transaction factory was closed. No further operations allowed.");
 221     }
 222
 223     @Override
 224     public void close() {
 225         final boolean success = UPDATER.compareAndSet(this, 0, 1);
 226         Preconditions.checkState(success, "Transaction factory was already closed");
 227     }
 228 }
 229