2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.sal.connect.netconf.sal;
10 import static com.google.common.base.Preconditions.checkArgument;
12 import com.google.common.collect.ClassToInstanceMap;
13 import com.google.common.collect.ImmutableClassToInstanceMap;
14 import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
15 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
16 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
17 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
18 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
19 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
20 import org.opendaylight.mdsal.dom.spi.PingPongMergingDOMDataBroker;
21 import org.opendaylight.netconf.dom.api.tx.NetconfDOMDataBrokerFieldsExtension;
22 import org.opendaylight.netconf.dom.api.tx.NetconfDOMFieldsReadTransaction;
23 import org.opendaylight.netconf.dom.api.tx.NetconfDOMFieldsReadWriteTransaction;
24 import org.opendaylight.netconf.dom.api.tx.NetconfDOMFieldsTransactionChain;
25 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceId;
26 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices.Rpcs;
27 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
28 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.FieldsAwareReadOnlyTx;
29 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.FieldsAwareReadWriteTx;
30 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.FieldsAwareTxChain;
31 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.ReadOnlyTx;
32 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.ReadWriteTx;
33 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.TxChain;
34 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.WriteCandidateRunningTx;
35 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.WriteCandidateTx;
36 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.WriteRunningTx;
37 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
38 import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
40 public final class NetconfDeviceDataBroker implements PingPongMergingDOMDataBroker {
41 private final NetconfDOMDataBrokerFieldsExtension fieldsExtension = new NetconfDOMDataBrokerFieldsExtensionImpl();
42 private final RemoteDeviceId id;
43 private final NetconfBaseOps netconfOps;
44 private final boolean rollbackSupport;
45 private final boolean candidateSupported;
46 private final boolean runningWritable;
47 private final boolean lockDatastore;
49 public NetconfDeviceDataBroker(final RemoteDeviceId id, final MountPointContext mountContext, final Rpcs rpcs,
50 final NetconfSessionPreferences netconfSessionPreferences, final boolean lockDatastore) {
52 netconfOps = new NetconfBaseOps(rpcs, mountContext);
53 // get specific attributes from netconf preferences and get rid of it
54 // no need to keep the entire preferences object, its quite big with all the capability QNames
55 candidateSupported = netconfSessionPreferences.isCandidateSupported();
56 runningWritable = netconfSessionPreferences.isRunningWritable();
57 rollbackSupport = netconfSessionPreferences.isRollbackSupported();
58 checkArgument(candidateSupported || runningWritable,
59 "Device %s has advertised neither :writable-running nor :candidate capability. At least one of these "
60 + "should be advertised. Failed to establish a session.", id.name());
61 this.lockDatastore = lockDatastore;
65 public DOMDataTreeReadTransaction newReadOnlyTransaction() {
66 return new ReadOnlyTx(netconfOps, id);
70 public DOMDataTreeReadWriteTransaction newReadWriteTransaction() {
71 return new ReadWriteTx<>(newReadOnlyTransaction(), newWriteOnlyTransaction());
75 public DOMDataTreeWriteTransaction newWriteOnlyTransaction() {
76 if (candidateSupported) {
77 if (runningWritable) {
78 return new WriteCandidateRunningTx(id, netconfOps, rollbackSupport, lockDatastore);
80 return new WriteCandidateTx(id, netconfOps, rollbackSupport, lockDatastore);
83 return new WriteRunningTx(id, netconfOps, rollbackSupport, lockDatastore);
88 public DOMTransactionChain createTransactionChain(final DOMTransactionChainListener listener) {
89 return new TxChain(this, listener);
93 public ClassToInstanceMap<DOMDataBrokerExtension> getExtensions() {
94 return ImmutableClassToInstanceMap.of(NetconfDOMDataBrokerFieldsExtension.class, fieldsExtension);
97 private final class NetconfDOMDataBrokerFieldsExtensionImpl implements NetconfDOMDataBrokerFieldsExtension {
99 public NetconfDOMFieldsReadTransaction newReadOnlyTransaction() {
100 return new FieldsAwareReadOnlyTx(netconfOps, id);
104 public NetconfDOMFieldsReadWriteTransaction newReadWriteTransaction() {
105 return new FieldsAwareReadWriteTx(newReadOnlyTransaction(), newWriteOnlyTransaction());
109 public NetconfDOMFieldsTransactionChain createTransactionChain(final DOMTransactionChainListener listener) {
110 return new FieldsAwareTxChain(NetconfDeviceDataBroker.this, listener, this);