Reduce JSR305 proliferation
[controller.git] / 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 com.google.common.base.Preconditions.checkNotNull;
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 public class LegacyShardedDOMDataBrokerAdapter implements DOMDataBroker {
39
40     private final org.opendaylight.mdsal.dom.api.DOMDataBroker delegateDataBroker;
41     private final DOMSchemaService schemaService;
42     private final AtomicLong txNum = new AtomicLong();
43     private final AtomicLong chainNum = new AtomicLong();
44
45     public LegacyShardedDOMDataBrokerAdapter(final ShardedDOMDataBrokerAdapter delegateDataBroker,
46                                              final DOMSchemaService schemaService) {
47         this.delegateDataBroker = checkNotNull(delegateDataBroker);
48         this.schemaService = checkNotNull(schemaService);
49     }
50
51     @Override
52     public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
53         return new ShardedDOMDataBrokerDelegatingReadTransaction(newTransactionIdentifier(),
54                                                                  delegateDataBroker.newReadOnlyTransaction());
55     }
56
57     @Override
58     public DOMDataReadWriteTransaction newReadWriteTransaction() {
59         return new ShardedDOMDataBrokerDelegatingReadWriteTransaction(newTransactionIdentifier(),
60                                                                       schemaService.getGlobalContext(),
61                                                                       newReadOnlyTransaction(),
62                                                                       newWriteOnlyTransaction());
63     }
64
65     @Override
66     public DOMDataWriteTransaction newWriteOnlyTransaction() {
67         return new ShardedDOMDataBrokerDelegatingWriteTransaction(newTransactionIdentifier(),
68                                                                   delegateDataBroker.newWriteOnlyTransaction());
69     }
70
71     @Override
72     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
73         return new ShardedDOMDataBrokerDelegatingTransactionChain(chainNum.getAndIncrement(),
74                                                                   schemaService.getGlobalContext(), delegateDataBroker,
75                                                                   listener);
76     }
77
78     @Override
79     public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
80         return Collections.emptyMap();
81     }
82
83     private Object newTransactionIdentifier() {
84         return "DOM-" + txNum.getAndIncrement();
85     }
86 }