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