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