2 * Copyright (c) 2015 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
9 package org.opendaylight.controller.cluster.databroker;
11 import static com.google.common.base.Preconditions.checkState;
13 import com.google.common.collect.ImmutableMap;
14 import com.google.common.collect.ImmutableMap.Builder;
15 import java.util.EnumMap;
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.dom.api.DOMDataBroker;
21 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
22 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
23 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
24 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
25 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeCommitCohortRegistry;
26 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
27 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
28 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
29 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
30 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTreeChangePublisher;
31 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort;
32 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration;
33 import org.opendaylight.yangtools.concepts.ListenerRegistration;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
38 abstract class AbstractDOMBroker extends AbstractDOMTransactionFactory<DOMStore>
39 implements DOMDataBroker {
41 private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMBroker.class);
43 private final AtomicLong txNum = new AtomicLong();
44 private final AtomicLong chainNum = new AtomicLong();
45 private final Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> extensions;
46 private volatile AutoCloseable closeable;
48 protected AbstractDOMBroker(final Map<LogicalDatastoreType, DOMStore> datastores) {
51 Builder<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> extBuilder = ImmutableMap.builder();
52 if (isSupported(datastores, DOMStoreTreeChangePublisher.class)) {
53 extBuilder.put(DOMDataTreeChangeService.class, new DOMDataTreeChangeService() {
55 public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerDataTreeChangeListener(
56 final DOMDataTreeIdentifier treeId, final L listener) {
57 DOMStore store = getDOMStore(treeId.getDatastoreType());
58 return ((DOMStoreTreeChangePublisher) store).registerTreeChangeListener(
59 treeId.getRootIdentifier(), listener);
64 if (isSupported(datastores, org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry.class)) {
65 extBuilder.put(DOMDataTreeCommitCohortRegistry.class, new DOMDataTreeCommitCohortRegistry() {
67 public <T extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<T> registerCommitCohort(
68 org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier path, T cohort) {
69 DOMStore store = getDOMStore(toLegacy(path.getDatastoreType()));
70 return ((org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry) store)
71 .registerCommitCohort(path, cohort);
76 extensions = extBuilder.build();
79 private static LogicalDatastoreType toLegacy(org.opendaylight.mdsal.common.api.LogicalDatastoreType datastoreType) {
80 switch (datastoreType) {
82 return LogicalDatastoreType.CONFIGURATION;
84 return LogicalDatastoreType.OPERATIONAL;
86 throw new IllegalArgumentException("Unsupported data store type: " + datastoreType);
90 private static boolean isSupported(Map<LogicalDatastoreType, DOMStore> datastores,
91 Class<?> expDOMStoreInterface) {
92 for (DOMStore ds : datastores.values()) {
93 if (!expDOMStoreInterface.isAssignableFrom(ds.getClass())) {
101 public void setCloseable(final AutoCloseable closeable) {
102 this.closeable = closeable;
106 @SuppressWarnings("checkstyle:IllegalCatch")
107 public void close() {
110 if (closeable != null) {
113 } catch (Exception e) {
114 LOG.debug("Error closing instance", e);
120 protected Object newTransactionIdentifier() {
121 return "DOM-" + txNum.getAndIncrement();
125 public ListenerRegistration<DOMDataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
126 final YangInstanceIdentifier path, final DOMDataChangeListener listener,
127 final DataChangeScope triggeringScope) {
128 DOMStore potentialStore = getDOMStore(store);
129 return potentialStore.registerChangeListener(path, listener, triggeringScope);
133 public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
138 public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
141 final Map<LogicalDatastoreType, DOMStoreTransactionChain> backingChains =
142 new EnumMap<>(LogicalDatastoreType.class);
143 for (Map.Entry<LogicalDatastoreType, DOMStore> entry : getTxFactories().entrySet()) {
144 backingChains.put(entry.getKey(), entry.getValue().createTransactionChain());
147 final long chainId = chainNum.getAndIncrement();
148 LOG.debug("Transaction chain {} created with listener {}, backing store chains {}", chainId, listener,
150 return new DOMBrokerTransactionChain(chainId, backingChains, this, listener);
153 private DOMStore getDOMStore(final LogicalDatastoreType type) {
154 DOMStore store = getTxFactories().get(type);
155 checkState(store != null, "Requested logical data store is not available.");