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