dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/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.broker;
   9
  10 import java.util.EnumMap;
  11 import java.util.List;
  12 import java.util.Map;
  13 import java.util.concurrent.atomic.AtomicLong;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  16 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
  17 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  18 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
  19 import org.opendaylight.mdsal.dom.spi.PingPongMergingDOMDataBroker;
  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.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 public abstract class AbstractDOMDataBroker extends AbstractDOMForwardedTransactionFactory<DOMStore>
  27         implements PingPongMergingDOMDataBroker {
  28     private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMDataBroker.class);
  29
  30     private final AtomicLong txNum = new AtomicLong();
  31     private final AtomicLong chainNum = new AtomicLong();
  32     private final @NonNull List<Extension> supportedExtensions;
  33
  34     private volatile AutoCloseable closeable;
  35
  36     protected AbstractDOMDataBroker(final Map<LogicalDatastoreType, DOMStore> datastores) {
  37         super(datastores);
  38
  39         boolean treeChange = true;
  40         for (var ds : datastores.values()) {
  41             if (!(ds instanceof DOMStoreTreeChangePublisher)) {
  42                 treeChange = false;
  43                 break;
  44             }
  45         }
  46
  47         if (treeChange) {
  48             supportedExtensions = List.of((DOMDataTreeChangeService) (treeId, listener) -> {
  49                 final var dsType = treeId.datastore();
  50                 if (getTxFactories().get(dsType) instanceof DOMStoreTreeChangePublisher publisher) {
  51                     return publisher.registerTreeChangeListener(treeId.path(), listener);
  52                 }
  53                 throw new IllegalStateException("Publisher for " + dsType + " data store is not available");
  54             });
  55         } else {
  56             supportedExtensions = List.of();
  57         }
  58     }
  59
  60     public void setCloseable(final AutoCloseable closeable) {
  61         this.closeable = closeable;
  62     }
  63
  64     @SuppressWarnings("checkstyle:IllegalCatch")
  65     @Override
  66     public void close() {
  67         super.close();
  68
  69         if (closeable != null) {
  70             try {
  71                 closeable.close();
  72             } catch (Exception e) {
  73                 LOG.debug("Error closing instance", e);
  74             }
  75         }
  76     }
  77
  78     @Override
  79     protected Object newTransactionIdentifier() {
  80         return "DOM-" + txNum.getAndIncrement();
  81     }
  82
  83     @Override
  84     public final List<Extension> supportedExtensions() {
  85         return supportedExtensions;
  86     }
  87
  88
  89     @Override
  90     public DOMTransactionChain createTransactionChain(final DOMTransactionChainListener listener) {
  91         checkNotClosed();
  92
  93         final var delegates = new EnumMap<LogicalDatastoreType, DOMStoreTransactionChain>(LogicalDatastoreType.class);
  94         for (var entry : getTxFactories().entrySet()) {
  95             delegates.put(entry.getKey(), entry.getValue().createTransactionChain());
  96         }
  97
  98         final long chainId = chainNum.getAndIncrement();
  99         LOG.debug("Transactoin chain {} created with listener {}, backing store chains {}", chainId, listener,
 100                 delegates);
 101         return new DOMDataBrokerTransactionChainImpl(chainId, delegates, this, listener);
 102     }
 103 }