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.mdsal.common.api.LogicalDatastoreType;
19 import org.opendaylight.mdsal.common.api.TransactionChainListener;
20 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
21 import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
22 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
23 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
24 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort;
25 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration;
26 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry;
27 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
28 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
29 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
30 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
31 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher;
32 import org.opendaylight.yangtools.concepts.ListenerRegistration;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
36 public abstract class AbstractDOMBroker extends AbstractDOMTransactionFactory<DOMStore> implements DOMDataBroker {
38 private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMBroker.class);
40 private final AtomicLong txNum = new AtomicLong();
41 private final AtomicLong chainNum = new AtomicLong();
42 private final Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> extensions;
43 private volatile AutoCloseable closeable;
45 protected AbstractDOMBroker(final Map<LogicalDatastoreType, DOMStore> datastores) {
48 Builder<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> extBuilder = ImmutableMap.builder();
49 if (isSupported(datastores, DOMStoreTreeChangePublisher.class)) {
50 extBuilder.put(DOMDataTreeChangeService.class, new DOMDataTreeChangeService() {
52 public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerDataTreeChangeListener(
53 final DOMDataTreeIdentifier treeId, final L listener) {
54 DOMStore store = getDOMStore(treeId.getDatastoreType());
55 return ((DOMStoreTreeChangePublisher) store).registerTreeChangeListener(
56 treeId.getRootIdentifier(), listener);
61 if (isSupported(datastores, DOMDataTreeCommitCohortRegistry.class)) {
62 extBuilder.put(DOMDataTreeCommitCohortRegistry.class, new DOMDataTreeCommitCohortRegistry() {
64 public <T extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<T> registerCommitCohort(
65 final DOMDataTreeIdentifier path, final T cohort) {
66 DOMStore store = getDOMStore(path.getDatastoreType());
67 return ((DOMDataTreeCommitCohortRegistry) store).registerCommitCohort(path, cohort);
72 extensions = extBuilder.build();
75 private static boolean isSupported(final Map<LogicalDatastoreType, DOMStore> datastores,
76 final Class<?> expDOMStoreInterface) {
77 return datastores.values().stream().allMatch(expDOMStoreInterface::isInstance);
80 public void setCloseable(final AutoCloseable closeable) {
81 this.closeable = closeable;
85 @SuppressWarnings("checkstyle:IllegalCatch")
89 if (closeable != null) {
92 } catch (Exception e) {
93 LOG.debug("Error closing instance", e);
99 protected Object newTransactionIdentifier() {
100 return "DOM-" + txNum.getAndIncrement();
104 public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
109 public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
112 final Map<LogicalDatastoreType, DOMStoreTransactionChain> backingChains =
113 new EnumMap<>(LogicalDatastoreType.class);
114 for (Map.Entry<LogicalDatastoreType, DOMStore> entry : getTxFactories().entrySet()) {
115 backingChains.put(entry.getKey(), entry.getValue().createTransactionChain());
118 final long chainId = chainNum.getAndIncrement();
119 LOG.debug("Transaction chain {} created with listener {}, backing store chains {}", chainId, listener,
121 return new DOMBrokerTransactionChain(chainId, backingChains, this, listener);
124 private DOMStore getDOMStore(final LogicalDatastoreType type) {
125 DOMStore store = getTxFactories().get(type);
126 checkState(store != null, "Requested logical data store is not available.");