Merge "Add MD-SAL artifacts"
[controller.git] / opendaylight / md-sal / sal-dom-broker / src / main / java / org / opendaylight / controller / md / sal / dom / broker / impl / DOMDataBrokerImpl.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.controller.md.sal.dom.broker.impl;
9
10 import static com.google.common.base.Preconditions.checkState;
11 import com.google.common.base.Preconditions;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import com.google.common.util.concurrent.ListeningExecutorService;
14 import java.util.EnumMap;
15 import java.util.Map;
16 import java.util.Map.Entry;
17 import java.util.concurrent.atomic.AtomicLong;
18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
19 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
20 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
21 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
22 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
23 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
24 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
25 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
26 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
27 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
28 import org.opendaylight.yangtools.concepts.ListenerRegistration;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
32
33 public class DOMDataBrokerImpl extends AbstractDOMForwardedTransactionFactory<DOMStore> implements DOMDataBroker,
34         AutoCloseable {
35
36     private static final Logger LOG = LoggerFactory.getLogger(DOMDataBrokerImpl.class);
37
38     private final DOMDataCommitExecutor coordinator;
39     private final AtomicLong txNum = new AtomicLong();
40     private final AtomicLong chainNum = new AtomicLong();
41     private volatile AutoCloseable closeable;
42
43     public DOMDataBrokerImpl(final Map<LogicalDatastoreType, DOMStore> datastores,
44             final ListeningExecutorService executor) {
45         this(datastores, new DOMDataCommitCoordinatorImpl(executor));
46     }
47
48     public DOMDataBrokerImpl(final Map<LogicalDatastoreType, DOMStore> datastores,
49             final DOMDataCommitExecutor coordinator) {
50         super(datastores);
51         this.coordinator = Preconditions.checkNotNull(coordinator);
52     }
53
54     public void setCloseable(final AutoCloseable closeable) {
55         this.closeable = closeable;
56     }
57
58     @Override
59     public void close() {
60         super.close();
61
62         if(closeable != null) {
63             try {
64                 closeable.close();
65             } catch(Exception e) {
66                 LOG.debug("Error closing instance", e);
67             }
68         }
69     }
70
71     @Override
72     protected Object newTransactionIdentifier() {
73         return "DOM-" + txNum.getAndIncrement();
74     }
75
76     @Override
77     public ListenerRegistration<DOMDataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
78             final YangInstanceIdentifier path, final DOMDataChangeListener listener, final DataChangeScope triggeringScope) {
79
80         DOMStore potentialStore = getTxFactories().get(store);
81         checkState(potentialStore != null, "Requested logical data store is not available.");
82         return potentialStore.registerChangeListener(path, listener, triggeringScope);
83     }
84
85     @Override
86     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
87         checkNotClosed();
88
89         final Map<LogicalDatastoreType, DOMStoreTransactionChain> backingChains = new EnumMap<>(LogicalDatastoreType.class);
90         for (Entry<LogicalDatastoreType, DOMStore> entry : getTxFactories().entrySet()) {
91             backingChains.put(entry.getKey(), entry.getValue().createTransactionChain());
92         }
93
94         final long chainId = chainNum.getAndIncrement();
95         LOG.debug("Transactoin chain {} created with listener {}, backing store chains {}", chainId, listener,
96                 backingChains);
97         return new DOMDataBrokerTransactionChainImpl(chainId, backingChains, coordinator, listener);
98
99     }
100
101     @Override
102     public CheckedFuture<Void,TransactionCommitFailedException> submit(final DOMDataWriteTransaction transaction,
103             final Iterable<DOMStoreThreePhaseCommitCohort> cohorts) {
104         LOG.debug("Transaction: {} submitted with cohorts {}.", transaction.getIdentifier(), cohorts);
105         return coordinator.submit(transaction, cohorts);
106     }
107 }