2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.dom.store.inmemory;
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;
42 * In-memory DOM Data Store.
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}
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);
55 private final DataTree dataTree = new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_OPERATIONAL);
56 private final AtomicLong txCounter = new AtomicLong(0);
58 private final InMemoryDOMStoreTreeChangePublisher changePublisher;
59 private final ExecutorService dataChangeListenerExecutor;
60 private final boolean debugTransactions;
61 private final String name;
63 private volatile AutoCloseable closeable;
65 public InMemoryDOMDataStore(final String name, final ExecutorService dataChangeListenerExecutor) {
66 this(name, dataChangeListenerExecutor,
67 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE, false);
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);
79 public void setCloseable(final AutoCloseable closeable) {
80 this.closeable = closeable;
84 public final String getIdentifier() {
89 public DOMStoreReadTransaction newReadOnlyTransaction() {
90 return SnapshotBackedTransactions.newReadTransaction(
91 nextIdentifier(),debugTransactions, dataTree.takeSnapshot());
95 public DOMStoreReadWriteTransaction newReadWriteTransaction() {
96 return SnapshotBackedTransactions.newReadWriteTransaction(nextIdentifier(),
97 debugTransactions, dataTree.takeSnapshot(), this);
101 public DOMStoreWriteTransaction newWriteOnlyTransaction() {
102 return SnapshotBackedTransactions.newWriteTransaction(nextIdentifier(),
103 debugTransactions, dataTree.takeSnapshot(), this);
107 public DOMStoreTransactionChain createTransactionChain() {
108 return new DOMStoreTransactionChainImpl(this);
112 public synchronized void onGlobalContextUpdated(final SchemaContext ctx) {
113 dataTree.setSchemaContext(ctx);
116 @SuppressWarnings("checkstyle:IllegalCatch")
118 public void close() {
119 ExecutorServiceUtil.tryGracefulShutdown(dataChangeListenerExecutor, 30, TimeUnit.SECONDS);
121 if (closeable != null) {
124 } catch (Exception e) {
125 LOG.debug("Error closing instance", e);
130 public final boolean getDebugTransactions() {
131 return debugTransactions;
134 final DataTreeSnapshot takeSnapshot() {
135 return dataTree.takeSnapshot();
139 public synchronized <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerTreeChangeListener(
140 final YangInstanceIdentifier treeId, final L listener) {
142 * Make sure commit is not occurring right now. Listener has to be
143 * registered and its state capture enqueued at a consistent point.
145 return changePublisher.registerTreeChangeListener(treeId, listener, dataTree.takeSnapshot());
149 protected void transactionAborted(final SnapshotBackedWriteTransaction<String> tx) {
150 LOG.debug("Tx: {} is closed.", tx.getIdentifier());
154 protected DOMStoreThreePhaseCommitCohort transactionReady(final SnapshotBackedWriteTransaction<String> tx,
155 final DataTreeModification modification) {
156 LOG.debug("Tx: {} is submitted. Modifications: {}", tx.getIdentifier(), modification);
157 return new InMemoryDOMStoreThreePhaseCommitCohort(this, tx, modification);
160 String nextIdentifier() {
161 return name + "-" + txCounter.getAndIncrement();
164 void validate(final DataTreeModification modification) throws DataValidationFailedException {
165 dataTree.validate(modification);
168 DataTreeCandidate prepare(final DataTreeModification modification) {
169 return dataTree.prepare(modification);
172 synchronized void commit(final DataTreeCandidate candidate) {
173 dataTree.commit(candidate);
174 changePublisher.publishChange(candidate);