opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/legacy/sharded/adapter/LegacyShardedDOMDataBrokerAdapter.java

   1 /*
   2  * Copyright (c) 2016 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.legacy.sharded.adapter;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.util.Collections;
  13 import java.util.Map;
  14 import java.util.concurrent.atomic.AtomicLong;
  15 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  17 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
  18 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  22 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  23 import org.opendaylight.mdsal.dom.broker.ShardedDOMDataBrokerAdapter;
  24
  25 /**
  26  * DOMDataBroker implementation that forwards calls to
  27  * {@link org.opendaylight.mdsal.dom.broker.ShardedDOMDataBrokerAdapter},
  28  * which in turn translates calls to shard aware implementation of
  29  * {@link org.opendaylight.mdsal.dom.api.DOMDataTreeService}
  30  *
  31  * <p>
  32  * The incompatibility between first and latter APIs, puts restriction on {@link DOMDataReadWriteTransaction}
  33  * and {@link DOMDataReadOnlyTransaction} provided by this data broker. See
  34  * {@link ShardedDOMDataBrokerDelegatingReadWriteTransaction}
  35  * and {@link ShardedDOMDataBrokerDelegatingReadTransaction} respectively.
  36  */
  37 // FIXME try to refactor some of the implementation to abstract class for better reusability
  38 @Deprecated(forRemoval = true)
  39 public class LegacyShardedDOMDataBrokerAdapter implements DOMDataBroker {
  40
  41     private final org.opendaylight.mdsal.dom.api.DOMDataBroker delegateDataBroker;
  42     private final DOMSchemaService schemaService;
  43     private final AtomicLong txNum = new AtomicLong();
  44     private final AtomicLong chainNum = new AtomicLong();
  45
  46     public LegacyShardedDOMDataBrokerAdapter(final ShardedDOMDataBrokerAdapter delegateDataBroker,
  47                                              final DOMSchemaService schemaService) {
  48         this.delegateDataBroker = requireNonNull(delegateDataBroker);
  49         this.schemaService = requireNonNull(schemaService);
  50     }
  51
  52     @Override
  53     public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
  54         return new ShardedDOMDataBrokerDelegatingReadTransaction(newTransactionIdentifier(),
  55                                                                  delegateDataBroker.newReadOnlyTransaction());
  56     }
  57
  58     @Override
  59     public DOMDataReadWriteTransaction newReadWriteTransaction() {
  60         return new ShardedDOMDataBrokerDelegatingReadWriteTransaction(newTransactionIdentifier(),
  61                                                                       schemaService.getGlobalContext(),
  62                                                                       newReadOnlyTransaction(),
  63                                                                       newWriteOnlyTransaction());
  64     }
  65
  66     @Override
  67     public DOMDataWriteTransaction newWriteOnlyTransaction() {
  68         return new ShardedDOMDataBrokerDelegatingWriteTransaction(newTransactionIdentifier(),
  69                                                                   delegateDataBroker.newWriteOnlyTransaction());
  70     }
  71
  72     @Override
  73     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
  74         return new ShardedDOMDataBrokerDelegatingTransactionChain(chainNum.getAndIncrement(),
  75                                                                   schemaService.getGlobalContext(), delegateDataBroker,
  76                                                                   listener);
  77     }
  78
  79     @Override
  80     public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
  81         return Collections.emptyMap();
  82     }
  83
  84     private Object newTransactionIdentifier() {
  85         return "DOM-" + txNum.getAndIncrement();
  86     }
  87 }