opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/DOMForwardedWriteTransaction.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 static com.google.common.base.Preconditions.checkState;
  11
  12 import javax.annotation.concurrent.GuardedBy;
  13
  14 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  17 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  18 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  19 import org.opendaylight.yangtools.yang.common.RpcResult;
  20 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  22
  23 import com.google.common.base.Preconditions;
  24 import com.google.common.collect.ImmutableList;
  25 import com.google.common.collect.ImmutableMap;
  26 import com.google.common.util.concurrent.ListenableFuture;
  27
  28 /**
  29  *
  30  *
  31  * Read-Write Transaction, which is composed of several
  32  * {@link DOMStoreWriteTransaction} transactions. Subtransaction is selected by
  33  * {@link LogicalDatastoreType} type parameter in:
  34  *
  35  * <ul>
  36  * <li>{@link #put(LogicalDatastoreType, InstanceIdentifier, NormalizedNode)}
  37  * <li>{@link #delete(LogicalDatastoreType, InstanceIdentifier)}
  38  * <li>{@link #merge(LogicalDatastoreType, InstanceIdentifier, NormalizedNode)}
  39  * </ul>
  40  * <p>
  41  * {@link #commit()} will result in invocation of
  42  * {@link DOMDataCommitImplementation#commit(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction, Iterable)}
  43  * invocation with all {@link org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort} for underlying
  44  * transactions.
  45  *
  46  * @param <T>
  47  *            Subtype of {@link DOMStoreWriteTransaction} which is used as
  48  *            subtransaction.
  49  */
  50 class DOMForwardedWriteTransaction<T extends DOMStoreWriteTransaction> extends
  51         AbstractDOMForwardedCompositeTransaction<LogicalDatastoreType, T> implements DOMDataWriteTransaction {
  52
  53     @GuardedBy("this")
  54     private DOMDataCommitImplementation commitImpl;
  55
  56     @GuardedBy("this")
  57     private boolean canceled;
  58     @GuardedBy("this")
  59     private ListenableFuture<RpcResult<TransactionStatus>> commitFuture;
  60
  61     protected DOMForwardedWriteTransaction(final Object identifier,
  62             final ImmutableMap<LogicalDatastoreType, T> backingTxs, final DOMDataCommitImplementation commitImpl) {
  63         super(identifier, backingTxs);
  64         this.commitImpl = Preconditions.checkNotNull(commitImpl, "commitImpl must not be null.");
  65     }
  66
  67     @Override
  68     public void put(final LogicalDatastoreType store, final InstanceIdentifier path, final NormalizedNode<?, ?> data) {
  69         checkNotReady();
  70         getSubtransaction(store).write(path, data);
  71     }
  72
  73     @Override
  74     public void delete(final LogicalDatastoreType store, final InstanceIdentifier path) {
  75         checkNotReady();
  76         getSubtransaction(store).delete(path);
  77     }
  78
  79     @Override
  80     public void merge(final LogicalDatastoreType store, final InstanceIdentifier path, final NormalizedNode<?, ?> data) {
  81         checkNotReady();
  82         getSubtransaction(store).merge(path, data);
  83     }
  84
  85     @Override
  86     public synchronized void cancel() {
  87         checkState(!canceled, "Transaction was canceled.");
  88         if (commitFuture != null) {
  89             // FIXME: Implement cancelation of commit future
  90             // when Broker impl will support cancelation.
  91             throw new UnsupportedOperationException("Not implemented yet.");
  92         }
  93         canceled = true;
  94         commitImpl = null;
  95
  96     }
  97
  98     @Override
  99     public synchronized ListenableFuture<RpcResult<TransactionStatus>> commit() {
 100         checkNotReady();
 101
 102         ImmutableList.Builder<DOMStoreThreePhaseCommitCohort> cohortsBuilder = ImmutableList.builder();
 103         for (DOMStoreWriteTransaction subTx : getSubtransactions()) {
 104             cohortsBuilder.add(subTx.ready());
 105         }
 106         ImmutableList<DOMStoreThreePhaseCommitCohort> cohorts = cohortsBuilder.build();
 107         commitFuture = commitImpl.commit(this, cohorts);
 108         return commitFuture;
 109     }
 110
 111     private void checkNotReady() {
 112         checkNotCanceled();
 113         checkNotCommited();
 114     }
 115
 116     private void checkNotCanceled() {
 117         Preconditions.checkState(!canceled, "Transaction was canceled.");
 118     }
 119
 120     private void checkNotCommited() {
 121         checkState(commitFuture == null, "Transaction was already commited.");
 122     }
 123
 124 }