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.ClassToInstanceMap;
  14 import com.google.common.collect.ImmutableClassToInstanceMap;
  15 import com.google.common.collect.ImmutableClassToInstanceMap.Builder;
  16 import java.util.EnumMap;
  17 import java.util.Map;
  18 import java.util.concurrent.atomic.AtomicLong;
  19 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  20 import org.opendaylight.mdsal.common.api.TransactionChainListener;
  21 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  22 import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
  23 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  24 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
  25 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort;
  26 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration;
  27 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry;
  28 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  29 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  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;
  36
  37 public abstract class AbstractDOMBroker extends AbstractDOMTransactionFactory<DOMStore> implements DOMDataBroker {
  38
  39     private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMBroker.class);
  40
  41     private final AtomicLong txNum = new AtomicLong();
  42     private final AtomicLong chainNum = new AtomicLong();
  43     private final ClassToInstanceMap<DOMDataBrokerExtension> extensions;
  44
  45     private volatile AutoCloseable closeable;
  46
  47     protected AbstractDOMBroker(final Map<LogicalDatastoreType, DOMStore> datastores) {
  48         super(datastores);
  49
  50         Builder<DOMDataBrokerExtension> extBuilder = ImmutableClassToInstanceMap.builder();
  51         if (isSupported(datastores, DOMStoreTreeChangePublisher.class)) {
  52             extBuilder.put(DOMDataTreeChangeService.class, new DOMDataTreeChangeService() {
  53                 @Override
  54                 public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerDataTreeChangeListener(
  55                         final DOMDataTreeIdentifier treeId, final L listener) {
  56                     DOMStore store = getDOMStore(treeId.getDatastoreType());
  57                     return ((DOMStoreTreeChangePublisher) store).registerTreeChangeListener(
  58                             treeId.getRootIdentifier(), listener);
  59                 }
  60             });
  61         }
  62
  63         if (isSupported(datastores, DOMDataTreeCommitCohortRegistry.class)) {
  64             extBuilder.put(DOMDataTreeCommitCohortRegistry.class, new DOMDataTreeCommitCohortRegistry() {
  65                 @Override
  66                 public <T extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<T> registerCommitCohort(
  67                         final DOMDataTreeIdentifier path, final T cohort) {
  68                     DOMStore store = getDOMStore(path.getDatastoreType());
  69                     return ((DOMDataTreeCommitCohortRegistry) store).registerCommitCohort(path, cohort);
  70                 }
  71             });
  72         }
  73
  74         extensions = extBuilder.build();
  75     }
  76
  77     private static boolean isSupported(final Map<LogicalDatastoreType, DOMStore> datastores,
  78             final Class<?> expDOMStoreInterface) {
  79         return datastores.values().stream().allMatch(expDOMStoreInterface::isInstance);
  80     }
  81
  82     public void setCloseable(final AutoCloseable closeable) {
  83         this.closeable = closeable;
  84     }
  85
  86     @Override
  87     @SuppressWarnings("checkstyle:IllegalCatch")
  88     public void close() {
  89         super.close();
  90
  91         if (closeable != null) {
  92             try {
  93                 closeable.close();
  94             } catch (Exception e) {
  95                 LOG.debug("Error closing instance", e);
  96             }
  97         }
  98     }
  99
 100     @Override
 101     protected Object newTransactionIdentifier() {
 102         return "DOM-" + txNum.getAndIncrement();
 103     }
 104
 105     @Override
 106     @Deprecated
 107     public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
 108         return extensions;
 109     }
 110
 111     @Override
 112     public ClassToInstanceMap<DOMDataBrokerExtension> getExtensions() {
 113         return extensions;
 114     }
 115
 116     @Override
 117     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
 118         checkNotClosed();
 119
 120         final Map<LogicalDatastoreType, DOMStoreTransactionChain> backingChains =
 121                 new EnumMap<>(LogicalDatastoreType.class);
 122         for (Map.Entry<LogicalDatastoreType, DOMStore> entry : getTxFactories().entrySet()) {
 123             backingChains.put(entry.getKey(), entry.getValue().createTransactionChain());
 124         }
 125
 126         final long chainId = chainNum.getAndIncrement();
 127         LOG.debug("Transaction chain {} created with listener {}, backing store chains {}", chainId, listener,
 128                 backingChains);
 129         return new DOMBrokerTransactionChain(chainId, backingChains, this, listener);
 130     }
 131
 132     private DOMStore getDOMStore(final LogicalDatastoreType type) {
 133         DOMStore store = getTxFactories().get(type);
 134         checkState(store != null, "Requested logical data store is not available.");
 135         return store;
 136     }
 137 }