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