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