opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/AbstractDOMTransactionFactory.java

   1 /*
   2  * Copyright (c) 2015 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
   9 package org.opendaylight.controller.cluster.databroker;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.FluentFuture;
  13 import java.lang.invoke.MethodHandles;
  14 import java.lang.invoke.VarHandle;
  15 import java.util.Collection;
  16 import java.util.EnumMap;
  17 import java.util.Map;
  18 import org.opendaylight.mdsal.common.api.CommitInfo;
  19 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  20 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  21 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  22 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  23 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
  24 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionFactory;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 public abstract class AbstractDOMTransactionFactory<T extends DOMStoreTransactionFactory> implements AutoCloseable {
  29     private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMTransactionFactory.class);
  30     private static final VarHandle CLOSED;
  31
  32     static {
  33         try {
  34             CLOSED = MethodHandles.lookup().findVarHandle(AbstractDOMTransactionFactory.class, "closed", boolean.class);
  35         } catch (NoSuchFieldException | IllegalAccessException e) {
  36             throw new ExceptionInInitializerError(e);
  37         }
  38     }
  39
  40     private final Map<LogicalDatastoreType, T> storeTxFactories;
  41
  42     private volatile boolean closed;
  43
  44     protected AbstractDOMTransactionFactory(final Map<LogicalDatastoreType, T> txFactories) {
  45         this.storeTxFactories = new EnumMap<>(txFactories);
  46     }
  47
  48     /**
  49      * Implementations must return unique identifier for each and every call of
  50      * this method.
  51      *
  52      * @return new Unique transaction identifier.
  53      */
  54     protected abstract Object newTransactionIdentifier();
  55
  56     /**
  57      * Submits a transaction asynchronously for commit.
  58      *
  59      * @param transaction the transaction to submit
  60      * @param cohorts the associated cohorts
  61      * @return a resulting Future
  62      */
  63     protected abstract FluentFuture<? extends CommitInfo> commit(DOMDataTreeWriteTransaction transaction,
  64             Collection<DOMStoreThreePhaseCommitCohort> cohorts);
  65
  66     /**
  67      * Creates a new read-only transaction.
  68      *
  69      * @return the transaction instance
  70      */
  71     public final DOMDataTreeReadTransaction newReadOnlyTransaction() {
  72         checkNotClosed();
  73
  74         return new DOMBrokerReadOnlyTransaction(newTransactionIdentifier(), storeTxFactories);
  75     }
  76
  77
  78     /**
  79      * Creates a new write-only transaction.
  80      *
  81      * @return the transaction instance
  82      */
  83     public final DOMDataTreeWriteTransaction newWriteOnlyTransaction() {
  84         checkNotClosed();
  85
  86         return new DOMBrokerWriteOnlyTransaction(newTransactionIdentifier(), storeTxFactories, this);
  87     }
  88
  89
  90     /**
  91      * Creates a new read-write transaction.
  92      *
  93      * @return the transaction instance
  94      */
  95     public final DOMDataTreeReadWriteTransaction newReadWriteTransaction() {
  96         checkNotClosed();
  97
  98         return new DOMBrokerReadWriteTransaction(newTransactionIdentifier(), storeTxFactories, this);
  99     }
 100
 101     /**
 102      * Convenience accessor of backing factories intended to be used only by
 103      * finalization of this class.
 104      *
 105      * <b>Note:</b>
 106      * Finalization of this class may want to access other functionality of
 107      * supplied Transaction factories.
 108      *
 109      * @return Map of backing transaction factories.
 110      */
 111     public final Map<LogicalDatastoreType, T> getTxFactories() {
 112         return storeTxFactories;
 113     }
 114
 115     /**
 116      * Checks if instance is not closed.
 117      *
 118      * @throws IllegalStateException If instance of this class was closed.
 119      *
 120      */
 121     protected final void checkNotClosed() {
 122         Preconditions.checkState(!closed, "Transaction factory was closed. No further operations allowed.");
 123     }
 124
 125     @Override
 126     public void close() {
 127         if (!CLOSED.compareAndSet(this, false, true)) {
 128             LOG.warn("Transaction factory was already closed", new Throwable());
 129         }
 130     }
 131 }