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
8 package org.opendaylight.controller.cluster.databroker;
10 import static com.google.common.base.Preconditions.checkState;
12 import com.google.common.collect.ClassToInstanceMap;
13 import com.google.common.collect.ImmutableClassToInstanceMap;
14 import com.google.common.collect.ImmutableClassToInstanceMap.Builder;
15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
16 import java.util.EnumMap;
18 import java.util.concurrent.atomic.AtomicLong;
19 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
20 import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
21 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
22 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
23 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort;
24 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration;
25 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry;
26 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
27 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
28 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
29 import org.opendaylight.mdsal.dom.spi.PingPongMergingDOMDataBroker;
30 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
31 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
32 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher;
33 import org.opendaylight.yangtools.concepts.ListenerRegistration;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
37 public abstract class AbstractDOMBroker extends AbstractDOMTransactionFactory<DOMStore>
38 implements PingPongMergingDOMDataBroker {
40 private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMBroker.class);
42 private final AtomicLong txNum = new AtomicLong();
43 private final AtomicLong chainNum = new AtomicLong();
44 private final ClassToInstanceMap<DOMDataBrokerExtension> extensions;
46 private volatile AutoCloseable closeable;
48 protected AbstractDOMBroker(final Map<LogicalDatastoreType, DOMStore> datastores) {
51 Builder<DOMDataBrokerExtension> extBuilder = ImmutableClassToInstanceMap.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, DOMDataTreeCommitCohortRegistry.class)) {
65 extBuilder.put(DOMDataTreeCommitCohortRegistry.class, new DOMDataTreeCommitCohortRegistry() {
67 public <T extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<T> registerCommitCohort(
68 final DOMDataTreeIdentifier path, final T cohort) {
69 DOMStore store = getDOMStore(path.getDatastoreType());
70 return ((DOMDataTreeCommitCohortRegistry) store).registerCommitCohort(path, cohort);
75 extensions = extBuilder.build();
78 private static boolean isSupported(final Map<LogicalDatastoreType, DOMStore> datastores,
79 final Class<?> expDOMStoreInterface) {
80 return datastores.values().stream().allMatch(expDOMStoreInterface::isInstance);
83 public void setCloseable(final AutoCloseable closeable) {
84 this.closeable = closeable;
88 @SuppressWarnings("checkstyle:IllegalCatch")
92 if (closeable != null) {
95 } catch (Exception e) {
96 LOG.debug("Error closing instance", e);
102 protected Object newTransactionIdentifier() {
103 return "DOM-" + txNum.getAndIncrement();
107 public ClassToInstanceMap<DOMDataBrokerExtension> getExtensions() {
112 public DOMTransactionChain createTransactionChain(final DOMTransactionChainListener listener) {
115 final Map<LogicalDatastoreType, DOMStoreTransactionChain> backingChains =
116 new EnumMap<>(LogicalDatastoreType.class);
117 for (Map.Entry<LogicalDatastoreType, DOMStore> entry : getTxFactories().entrySet()) {
118 backingChains.put(entry.getKey(), entry.getValue().createTransactionChain());
121 final long chainId = chainNum.getAndIncrement();
122 LOG.debug("Transaction chain {} created with listener {}, backing store chains {}", chainId, listener,
124 return new DOMBrokerTransactionChain(chainId, backingChains, this, listener);
127 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
128 justification = "https://github.com/spotbugs/spotbugs/issues/811")
129 private DOMStore getDOMStore(final LogicalDatastoreType type) {
130 DOMStore store = getTxFactories().get(type);
131 checkState(store != null, "Requested logical data store is not available.");