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