opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/AbstractDOMBroker.java

   1 /*
   2  * Copyright (c) 2015 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
   9 package org.opendaylight.controller.cluster.databroker;
  10
  11 import static com.google.common.base.Preconditions.checkState;
  12
  13 import com.google.common.collect.ImmutableMap;
  14 import java.util.Collections;
  15 import java.util.EnumMap;
  16 import java.util.Map;
  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.DOMDataTreeIdentifier;
  26 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  27 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  28 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
  29 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTreeChangePublisher;
  30 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 abstract class AbstractDOMBroker extends AbstractDOMTransactionFactory<DOMStore>
  36         implements DOMDataBroker {
  37
  38     private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMBroker.class);
  39
  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;
  44
  45     protected AbstractDOMBroker(final Map<LogicalDatastoreType, DOMStore> datastores) {
  46         super(datastores);
  47
  48         boolean treeChange = true;
  49         for (DOMStore ds : datastores.values()) {
  50             if (!(ds instanceof DOMStoreTreeChangePublisher)) {
  51                 treeChange = false;
  52                 break;
  53             }
  54         }
  55
  56         if (treeChange) {
  57             extensions = ImmutableMap.of(DOMDataTreeChangeService.class, new DOMDataTreeChangeService() {
  58                 @Override
  59                 public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerDataTreeChangeListener(
  60                         final DOMDataTreeIdentifier treeId, final L listener) {
  61                     DOMStore publisher = getTxFactories().get(treeId.getDatastoreType());
  62                     checkState(publisher != null, "Requested logical data store is not available.");
  63
  64                     return ((DOMStoreTreeChangePublisher) publisher).registerTreeChangeListener(
  65                             treeId.getRootIdentifier(), listener);
  66                 }
  67             });
  68         } else {
  69             extensions = Collections.emptyMap();
  70         }
  71     }
  72
  73     public void setCloseable(final AutoCloseable closeable) {
  74         this.closeable = closeable;
  75     }
  76
  77     @Override
  78     @SuppressWarnings("checkstyle:IllegalCatch")
  79     public void close() {
  80         super.close();
  81
  82         if (closeable != null) {
  83             try {
  84                 closeable.close();
  85             } catch (Exception e) {
  86                 LOG.debug("Error closing instance", e);
  87             }
  88         }
  89     }
  90
  91     @Override
  92     protected Object newTransactionIdentifier() {
  93         return "DOM-" + txNum.getAndIncrement();
  94     }
  95
  96     @Override
  97     public ListenerRegistration<DOMDataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
  98             final YangInstanceIdentifier path, final DOMDataChangeListener listener,
  99             final DataChangeScope triggeringScope) {
 100         DOMStore potentialStore = getTxFactories().get(store);
 101         checkState(potentialStore != null, "Requested logical data store is not available.");
 102         return potentialStore.registerChangeListener(path, listener, triggeringScope);
 103     }
 104
 105     @Override
 106     public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
 107         return extensions;
 108     }
 109
 110     @Override
 111     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
 112         checkNotClosed();
 113
 114         final Map<LogicalDatastoreType, DOMStoreTransactionChain> backingChains =
 115                 new EnumMap<>(LogicalDatastoreType.class);
 116         for (Map.Entry<LogicalDatastoreType, DOMStore> entry : getTxFactories().entrySet()) {
 117             backingChains.put(entry.getKey(), entry.getValue().createTransactionChain());
 118         }
 119
 120         final long chainId = chainNum.getAndIncrement();
 121         LOG.debug("Transaction chain {} created with listener {}, backing store chains {}", chainId, listener,
 122                 backingChains);
 123         return new DOMBrokerTransactionChain(chainId, backingChains, this, listener);
 124     }
 125 }