dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/AbstractDOMDataBroker.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.mdsal.dom.spi;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import java.util.EnumMap;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.concurrent.atomic.AtomicLong;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  17 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  18 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  19 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  20 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
  21 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  22 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher;
  23 import org.opendaylight.yangtools.concepts.Registration;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 public abstract class AbstractDOMDataBroker extends AbstractDOMForwardedTransactionFactory<DOMStore>
  28         implements PingPongMergingDOMDataBroker {
  29     private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMDataBroker.class);
  30
  31     private final AtomicLong txNum = new AtomicLong();
  32     private final AtomicLong chainNum = new AtomicLong();
  33     private final @NonNull List<Extension> supportedExtensions;
  34
  35     protected AbstractDOMDataBroker(final Map<LogicalDatastoreType, DOMStore> datastores) {
  36         super(datastores);
  37
  38         final var builder = ImmutableList.<Extension>builder();
  39         if (isSupported(datastores, DOMStoreTreeChangePublisher.class)) {
  40             builder.add(new DataTreeChangeExtension() {
  41                 @Override
  42                 public Registration registerTreeChangeListener(final DOMDataTreeIdentifier treeId,
  43                         final DOMDataTreeChangeListener listener) {
  44                     return getPublisher(treeId.datastore()).registerTreeChangeListener(treeId.path(), listener);
  45                 }
  46
  47                 @Override
  48                 @Deprecated(since = "13.0.0", forRemoval = true)
  49                 public Registration registerLegacyTreeChangeListener(final DOMDataTreeIdentifier treeId,
  50                         final DOMDataTreeChangeListener listener) {
  51                     return getPublisher(treeId.datastore()).registerLegacyTreeChangeListener(treeId.path(), listener);
  52                 }
  53
  54                 private DOMStoreTreeChangePublisher getPublisher(final LogicalDatastoreType datastore) {
  55                     if (getTxFactories().get(datastore) instanceof DOMStoreTreeChangePublisher publisher) {
  56                         return publisher;
  57                     }
  58                     throw new IllegalStateException("Publisher for " + datastore + " data store is not available");
  59                 }
  60             });
  61         }
  62         if (isSupported(datastores, CommitCohortExtension.class)) {
  63             builder.add((CommitCohortExtension) (path, cohort) -> {
  64                 final var dsType = path.datastore();
  65                 if (getTxFactories().get(dsType) instanceof CommitCohortExtension extension) {
  66                     return extension.registerCommitCohort(path, cohort);
  67                 }
  68                 throw new IllegalStateException("Cohort registry for " + dsType + " data store is not available");
  69             });
  70         }
  71
  72         supportedExtensions = builder.build();
  73     }
  74
  75     @Override
  76     public final List<Extension> supportedExtensions() {
  77         return supportedExtensions;
  78     }
  79
  80     @Override
  81     public DOMTransactionChain createTransactionChain() {
  82         checkNotClosed();
  83
  84         final var delegates = new EnumMap<LogicalDatastoreType, DOMStoreTransactionChain>(LogicalDatastoreType.class);
  85         for (var entry : getTxFactories().entrySet()) {
  86             delegates.put(entry.getKey(), entry.getValue().createTransactionChain());
  87         }
  88
  89         final long chainId = chainNum.getAndIncrement();
  90         LOG.debug("Transactoin chain {} created, backing store chains {}", chainId, delegates);
  91         return new DOMDataBrokerTransactionChainImpl(chainId, delegates, this);
  92     }
  93
  94     @Override
  95     protected final Object newTransactionIdentifier() {
  96         return "DOM-" + txNum.getAndIncrement();
  97     }
  98
  99     private static boolean isSupported(final Map<LogicalDatastoreType, DOMStore> datastores,
 100             final Class<?> expDOMStoreInterface) {
 101         return datastores.values().stream().allMatch(expDOMStoreInterface::isInstance);
 102     }
 103 }