netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/NetconfDeviceDataBroker.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
   9 package org.opendaylight.netconf.sal.connect.netconf.sal;
  10
  11 import com.google.common.base.Preconditions;
  12 import java.util.Collections;
  13 import java.util.Map;
  14 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  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.DOMDataChangeListener;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  24 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  25 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.ReadOnlyTx;
  26 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.ReadWriteTx;
  27 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.TxChain;
  28 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.WriteCandidateRunningTx;
  29 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.WriteCandidateTx;
  30 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.WriteRunningTx;
  31 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
  32 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  33 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  36
  37 public final class NetconfDeviceDataBroker implements DOMDataBroker {
  38     private final RemoteDeviceId id;
  39     private final NetconfBaseOps netconfOps;
  40
  41     private final boolean rollbackSupport;
  42     private final boolean candidateSupported;
  43     private final boolean runningWritable;
  44
  45     public NetconfDeviceDataBroker(final RemoteDeviceId id, final SchemaContext schemaContext,
  46                                    final DOMRpcService rpc, final NetconfSessionPreferences netconfSessionPreferences) {
  47         this.id = id;
  48         this.netconfOps = new NetconfBaseOps(rpc, schemaContext);
  49         // get specific attributes from netconf preferences and get rid of it
  50         // no need to keep the entire preferences object, its quite big with all the capability QNames
  51         candidateSupported = netconfSessionPreferences.isCandidateSupported();
  52         runningWritable = netconfSessionPreferences.isRunningWritable();
  53         rollbackSupport = netconfSessionPreferences.isRollbackSupported();
  54         Preconditions.checkArgument(candidateSupported || runningWritable,
  55             "Device %s has advertised neither :writable-running nor :candidate capability."
  56                     + "At least one of these should be advertised. Failed to establish a session.", id.getName());
  57     }
  58
  59     @Override
  60     public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
  61         return new ReadOnlyTx(netconfOps, id);
  62     }
  63
  64     @Override
  65     public DOMDataReadWriteTransaction newReadWriteTransaction() {
  66         return new ReadWriteTx(newReadOnlyTransaction(), newWriteOnlyTransaction());
  67     }
  68
  69     @Override
  70     public DOMDataWriteTransaction newWriteOnlyTransaction() {
  71         if (candidateSupported) {
  72             if (runningWritable) {
  73                 return new WriteCandidateRunningTx(id, netconfOps, rollbackSupport);
  74             } else {
  75                 return new WriteCandidateTx(id, netconfOps, rollbackSupport);
  76             }
  77         } else {
  78             return new WriteRunningTx(id, netconfOps, rollbackSupport);
  79         }
  80     }
  81
  82     @Override
  83     public ListenerRegistration<DOMDataChangeListener> registerDataChangeListener(
  84             final LogicalDatastoreType store, final YangInstanceIdentifier path, final DOMDataChangeListener listener,
  85             final DataChangeScope triggeringScope) {
  86         throw new UnsupportedOperationException(id + ": Data change listeners not supported for netconf mount point");
  87     }
  88
  89     @Override
  90     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
  91         return new TxChain(this, listener);
  92     }
  93
  94     @Override
  95     public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
  96         return Collections.emptyMap();
  97     }
  98
  99 }