checkStyleViolationSeverity=error implemented for mdsal-dom-broker
[mdsal.git] / dom / mdsal-dom-broker / src / main / java / org / opendaylight / mdsal / dom / broker / 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.mdsal.dom.broker;
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.mdsal.common.api.LogicalDatastoreType;
19 import org.opendaylight.mdsal.common.api.TransactionChainListener;
20 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
21 import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
22 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
23 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
24 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
25 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
26 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
27 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
28 import org.opendaylight.mdsal.dom.spi.store.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, 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(
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, "Requested logical data store is not available.");
61
62                             return ((DOMStoreTreeChangePublisher)publisher).registerTreeChangeListener(
63                                     treeId.getRootIdentifier(), listener);
64                             }
65                         });
66         } else {
67             extensions = Collections.emptyMap();
68         }
69     }
70
71     public void setCloseable(final AutoCloseable closeable) {
72         this.closeable = closeable;
73     }
74
75     @SuppressWarnings("checkstyle:IllegalCatch")
76     @Override
77     public void close() {
78         super.close();
79
80         if (closeable != null) {
81             try {
82                 closeable.close();
83             } catch (Exception e) {
84                 LOG.debug("Error closing instance", e);
85             }
86         }
87     }
88
89     @Override
90     protected Object newTransactionIdentifier() {
91         return "DOM-" + txNum.getAndIncrement();
92     }
93
94     @Override
95     public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
96         return extensions;
97     }
98
99     @Override
100     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
101         checkNotClosed();
102
103         final Map<LogicalDatastoreType, DOMStoreTransactionChain> backingChains =
104                 new EnumMap<>(LogicalDatastoreType.class);
105         for (Entry<LogicalDatastoreType, DOMStore> entry : getTxFactories().entrySet()) {
106             backingChains.put(entry.getKey(), entry.getValue().createTransactionChain());
107         }
108
109         final long chainId = chainNum.getAndIncrement();
110         LOG.debug("Transactoin chain {} created with listener {}, backing store chains {}", chainId, listener,
111                 backingChains);
112         return new DOMDataBrokerTransactionChainImpl(chainId, backingChains, this, listener);
113     }
114 }