Reduce JSR305 proliferation
[controller.git] / 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
12 import com.google.common.collect.ImmutableMap;
13 import java.util.Collections;
14 import java.util.EnumMap;
15 import java.util.Map;
16 import java.util.Map.Entry;
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.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.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
32
33 public abstract class AbstractDOMDataBroker extends AbstractDOMForwardedTransactionFactory<DOMStore>
34        implements DOMDataBroker {
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(
55                     DOMDataTreeChangeService.class, new DOMDataTreeChangeService() {
56                         @Override
57                         public <L extends DOMDataTreeChangeListener> ListenerRegistration<L>
58                             registerDataTreeChangeListener(final DOMDataTreeIdentifier treeId, final L listener) {
59                                 DOMStore publisher = getTxFactories().get(treeId.getDatastoreType());
60                                 checkState(publisher != null,
61                                            "Requested logical data store is not available.");
62
63                                 return ((DOMStoreTreeChangePublisher) publisher)
64                                         .registerTreeChangeListener(treeId.getRootIdentifier(), listener);
65                             }
66                     });
67         } else {
68             extensions = Collections.emptyMap();
69         }
70     }
71
72     public void setCloseable(final AutoCloseable closeable) {
73         this.closeable = closeable;
74     }
75
76     @Override
77     @SuppressWarnings("checkstyle:IllegalCatch")
78     public void close() {
79         super.close();
80
81         if (closeable != null) {
82             try {
83                 closeable.close();
84             } catch (Exception e) {
85                 LOG.debug("Error closing instance", e);
86             }
87         }
88     }
89
90     @Override
91     protected Object newTransactionIdentifier() {
92         return "DOM-" + txNum.getAndIncrement();
93     }
94
95     @Override
96     public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
97         return extensions;
98     }
99
100     @Override
101     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
102         checkNotClosed();
103
104         final Map<LogicalDatastoreType, DOMStoreTransactionChain> backingChains = new EnumMap<>(
105                 LogicalDatastoreType.class);
106         for (Entry<LogicalDatastoreType, DOMStore> entry : getTxFactories().entrySet()) {
107             backingChains.put(entry.getKey(), entry.getValue().createTransactionChain());
108         }
109
110         final long chainId = chainNum.getAndIncrement();
111         LOG.debug("Transactoin chain {} created with listener {}, backing store chains {}", chainId, listener,
112                   backingChains);
113         return new DOMDataBrokerTransactionChainImpl(chainId, backingChains, this, listener);
114     }
115 }