dom/mdsal-dom-inmemory-datastore/src/main/java/org/opendaylight/mdsal/dom/store/inmemory/InMemoryDOMDataStore.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.mdsal.dom.store.inmemory;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.util.concurrent.ExecutorService;
  12 import java.util.concurrent.TimeUnit;
  13 import java.util.concurrent.atomic.AtomicLong;
  14 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  15 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
  16 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
  17 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
  18 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
  19 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  20 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher;
  21 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  22 import org.opendaylight.mdsal.dom.spi.store.SnapshotBackedTransactions;
  23 import org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction;
  24 import org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction.TransactionReadyPrototype;
  25 import org.opendaylight.yangtools.concepts.Identifiable;
  26 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  27 import org.opendaylight.yangtools.util.ExecutorServiceUtil;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  29 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  30 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  31 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
  32 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  33 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
  34 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
  36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  37 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40
  41 /**
  42  * In-memory DOM Data Store.
  43  *
  44  *<p>
  45  * Implementation of {@link DOMStore} which uses {@link DataTree} and other
  46  * classes such as {@link SnapshotBackedWriteTransaction}.
  47  * {@link org.opendaylight.mdsal.dom.spi.store.SnapshotBackedReadTransaction} to implement {@link DOMStore}
  48  * contract.
  49  *
  50  */
  51 public class InMemoryDOMDataStore extends TransactionReadyPrototype<String> implements DOMStore,
  52         Identifiable<String>, SchemaContextListener, AutoCloseable, DOMStoreTreeChangePublisher {
  53     private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMDataStore.class);
  54
  55     private final DataTree dataTree = new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_OPERATIONAL);
  56     private final AtomicLong txCounter = new AtomicLong(0);
  57
  58     private final InMemoryDOMStoreTreeChangePublisher changePublisher;
  59     private final ExecutorService dataChangeListenerExecutor;
  60     private final boolean debugTransactions;
  61     private final String name;
  62
  63     private volatile AutoCloseable closeable;
  64
  65     public InMemoryDOMDataStore(final String name, final ExecutorService dataChangeListenerExecutor) {
  66         this(name, dataChangeListenerExecutor,
  67                 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE, false);
  68     }
  69
  70     public InMemoryDOMDataStore(final String name, final ExecutorService dataChangeListenerExecutor,
  71             final int maxDataChangeListenerQueueSize, final boolean debugTransactions) {
  72         this.name = Preconditions.checkNotNull(name);
  73         this.dataChangeListenerExecutor = Preconditions.checkNotNull(dataChangeListenerExecutor);
  74         this.debugTransactions = debugTransactions;
  75         changePublisher = new InMemoryDOMStoreTreeChangePublisher(this.dataChangeListenerExecutor,
  76                 maxDataChangeListenerQueueSize);
  77     }
  78
  79     public void setCloseable(final AutoCloseable closeable) {
  80         this.closeable = closeable;
  81     }
  82
  83     @Override
  84     public final String getIdentifier() {
  85         return name;
  86     }
  87
  88     @Override
  89     public DOMStoreReadTransaction newReadOnlyTransaction() {
  90         return SnapshotBackedTransactions.newReadTransaction(
  91                 nextIdentifier(),debugTransactions, dataTree.takeSnapshot());
  92     }
  93
  94     @Override
  95     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
  96         return SnapshotBackedTransactions.newReadWriteTransaction(nextIdentifier(),
  97                 debugTransactions, dataTree.takeSnapshot(), this);
  98     }
  99
 100     @Override
 101     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
 102         return SnapshotBackedTransactions.newWriteTransaction(nextIdentifier(),
 103                 debugTransactions, dataTree.takeSnapshot(), this);
 104     }
 105
 106     @Override
 107     public DOMStoreTransactionChain createTransactionChain() {
 108         return new DOMStoreTransactionChainImpl(this);
 109     }
 110
 111     @Override
 112     public synchronized void onGlobalContextUpdated(final SchemaContext ctx) {
 113         dataTree.setSchemaContext(ctx);
 114     }
 115
 116     @SuppressWarnings("checkstyle:IllegalCatch")
 117     @Override
 118     public void close() {
 119         ExecutorServiceUtil.tryGracefulShutdown(dataChangeListenerExecutor, 30, TimeUnit.SECONDS);
 120
 121         if (closeable != null) {
 122             try {
 123                 closeable.close();
 124             } catch (Exception e) {
 125                 LOG.debug("Error closing instance", e);
 126             }
 127         }
 128     }
 129
 130     public final boolean getDebugTransactions() {
 131         return debugTransactions;
 132     }
 133
 134     final DataTreeSnapshot takeSnapshot() {
 135         return dataTree.takeSnapshot();
 136     }
 137
 138     @Override
 139     public synchronized <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerTreeChangeListener(
 140             final YangInstanceIdentifier treeId, final L listener) {
 141         /*
 142          * Make sure commit is not occurring right now. Listener has to be
 143          * registered and its state capture enqueued at a consistent point.
 144          */
 145         return changePublisher.registerTreeChangeListener(treeId, listener, dataTree.takeSnapshot());
 146     }
 147
 148     @Override
 149     protected void transactionAborted(final SnapshotBackedWriteTransaction<String> tx) {
 150         LOG.debug("Tx: {} is closed.", tx.getIdentifier());
 151     }
 152
 153     @Override
 154     protected DOMStoreThreePhaseCommitCohort transactionReady(final SnapshotBackedWriteTransaction<String> tx,
 155                                                               final DataTreeModification modification,
 156                                                               final Exception readyError) {
 157         LOG.debug("Tx: {} is submitted. Modifications: {}", tx.getIdentifier(), modification);
 158         return new InMemoryDOMStoreThreePhaseCommitCohort(this, tx, modification, readyError);
 159     }
 160
 161     String nextIdentifier() {
 162         return name + "-" + txCounter.getAndIncrement();
 163     }
 164
 165     void validate(final DataTreeModification modification) throws DataValidationFailedException {
 166         dataTree.validate(modification);
 167     }
 168
 169     DataTreeCandidate prepare(final DataTreeModification modification) {
 170         return dataTree.prepare(modification);
 171     }
 172
 173     synchronized void commit(final DataTreeCandidate candidate) {
 174         dataTree.commit(candidate);
 175         changePublisher.publishChange(candidate);
 176     }
 177 }