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