netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/NetconfDeviceTopologyAdapter.java

   1 /*
   2  * Copyright (c) 2015 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.netconf.sal.connect.netconf.sal;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.MoreExecutors;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.concurrent.ExecutionException;
  17 import java.util.stream.Collectors;
  18 import org.opendaylight.mdsal.binding.api.TransactionChain;
  19 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  20 import org.opendaylight.mdsal.common.api.CommitInfo;
  21 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  22 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  23 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus.ConnectionStatus;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilitiesBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.ClusteredConnectionStatusBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilities;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilitiesBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability.FailureReason;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapabilityBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  48 import org.opendaylight.yangtools.yang.common.QName;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 public class NetconfDeviceTopologyAdapter implements AutoCloseable {
  53
  54     private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
  55
  56     private final RemoteDeviceId id;
  57     private TransactionChain txChain;
  58
  59     private final InstanceIdentifier<NetworkTopology> networkTopologyPath;
  60     private final KeyedInstanceIdentifier<Topology, TopologyKey> topologyListPath;
  61     private static final String UNKNOWN_REASON = "Unknown reason";
  62
  63     NetconfDeviceTopologyAdapter(final RemoteDeviceId id, final TransactionChain txChain) {
  64         this.id = id;
  65         this.txChain = Preconditions.checkNotNull(txChain);
  66
  67         this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
  68         this.topologyListPath = networkTopologyPath
  69                 .child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
  70
  71         initDeviceData();
  72     }
  73
  74     private void initDeviceData() {
  75         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
  76
  77         createNetworkTopologyIfNotPresent(writeTx);
  78
  79         final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
  80         final NodeBuilder nodeBuilder = getNodeIdBuilder(id);
  81         NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
  82         netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
  83         netconfNodeBuilder.setHost(id.getHost());
  84         netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
  85         nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
  86         Node node = nodeBuilder.build();
  87
  88         LOG.trace("{}: Init device state transaction {} putting if absent operational data started.",
  89                 id, writeTx.getIdentifier());
  90         writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
  91         LOG.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
  92         LOG.trace("{}: Init device state transaction {} putting if absent config data started.",
  93                 id, writeTx.getIdentifier());
  94         LOG.trace("{}: Init device state transaction {} putting config data ended.", id, writeTx.getIdentifier());
  95
  96         commitTransaction(writeTx, "init");
  97     }
  98
  99     public void updateDeviceData(final boolean up, final NetconfDeviceCapabilities capabilities) {
 100         final NetconfNode data = buildDataForNetconfNode(up, capabilities);
 101
 102         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 103         LOG.trace("{}: Update device state transaction {} merging operational data started.",
 104                 id, writeTx.getIdentifier());
 105         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class),
 106             data, true);
 107         LOG.trace("{}: Update device state transaction {} merging operational data ended.",
 108                 id, writeTx.getIdentifier());
 109
 110         commitTransaction(writeTx, "update");
 111     }
 112
 113     public void updateClusteredDeviceData(final boolean up, final String masterAddress,
 114                                           final NetconfDeviceCapabilities capabilities) {
 115         final NetconfNode data = buildDataForNetconfClusteredNode(up, masterAddress, capabilities);
 116
 117         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 118         LOG.trace("{}: Update device state transaction {} merging operational data started.",
 119                 id, writeTx.getIdentifier());
 120         writeTx.put(LogicalDatastoreType.OPERATIONAL,
 121                 id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
 122         LOG.trace("{}: Update device state transaction {} merging operational data ended.",
 123                 id, writeTx.getIdentifier());
 124
 125         commitTransaction(writeTx, "update");
 126     }
 127
 128     public void setDeviceAsFailed(final Throwable throwable) {
 129         String reason = throwable != null && throwable.getMessage() != null ? throwable.getMessage() : UNKNOWN_REASON;
 130
 131         final NetconfNode data = new NetconfNodeBuilder()
 132                 .setHost(id.getHost())
 133                 .setPort(new PortNumber(id.getAddress().getPort()))
 134                 .setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
 135
 136         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 137         LOG.trace(
 138                 "{}: Setting device state as failed {} putting operational data started.",
 139                 id, writeTx.getIdentifier());
 140         writeTx.put(LogicalDatastoreType.OPERATIONAL,
 141                 id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
 142         LOG.trace(
 143                 "{}: Setting device state as failed {} putting operational data ended.",
 144                 id, writeTx.getIdentifier());
 145
 146         commitTransaction(writeTx, "update-failed-device");
 147     }
 148
 149     private NetconfNode buildDataForNetconfNode(final boolean up, final NetconfDeviceCapabilities capabilities) {
 150         List<AvailableCapability> capabilityList = new ArrayList<>();
 151         capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
 152         capabilityList.addAll(capabilities.getResolvedCapabilities());
 153
 154         final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
 155         avCapabalitiesBuilder.setAvailableCapability(capabilityList);
 156
 157         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
 158                 .setHost(id.getHost())
 159                 .setPort(new PortNumber(id.getAddress().getPort()))
 160                 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
 161                 .setAvailableCapabilities(avCapabalitiesBuilder.build())
 162                 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()));
 163
 164         return netconfNodeBuilder.build();
 165     }
 166
 167     private NetconfNode buildDataForNetconfClusteredNode(final boolean up, final String masterNodeAddress,
 168                                                          final NetconfDeviceCapabilities capabilities) {
 169         List<AvailableCapability> capabilityList = new ArrayList<>();
 170         capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
 171         capabilityList.addAll(capabilities.getResolvedCapabilities());
 172         final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
 173         avCapabalitiesBuilder.setAvailableCapability(capabilityList);
 174
 175         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
 176                 .setHost(id.getHost())
 177                 .setPort(new PortNumber(id.getAddress().getPort()))
 178                 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
 179                 .setAvailableCapabilities(avCapabalitiesBuilder.build())
 180                 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
 181                 .setClusteredConnectionStatus(
 182                         new ClusteredConnectionStatusBuilder().setNetconfMasterNode(masterNodeAddress).build());
 183
 184         return netconfNodeBuilder.build();
 185     }
 186
 187     private static UnavailableCapabilities unavailableCapabilities(final Map<QName, FailureReason> input) {
 188         return new UnavailableCapabilitiesBuilder().setUnavailableCapability(input.entrySet().stream().map(
 189             e -> new UnavailableCapabilityBuilder().setCapability(e.getKey().toString()).setFailureReason(
 190                 e.getValue()).build()).collect(Collectors.toList())).build();
 191     }
 192
 193     public void removeDeviceConfiguration() {
 194         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 195
 196         LOG.trace(
 197                 "{}: Close device state transaction {} removing all data started.",
 198                 id, writeTx.getIdentifier());
 199         writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
 200         LOG.trace(
 201                 "{}: Close device state transaction {} removing all data ended.",
 202                 id, writeTx.getIdentifier());
 203
 204         try {
 205             writeTx.commit().get();
 206         } catch (InterruptedException | ExecutionException e) {
 207             LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
 208             throw new IllegalStateException(id + "  Transaction(close) not committed correctly", e);
 209         }
 210     }
 211
 212     private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
 213
 214         final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
 215         LOG.trace("{}: Transaction {} merging {} container to ensure its presence", id, writeTx.getIdentifier(),
 216             NetworkTopology.QNAME);
 217         writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
 218
 219         final Topology topology =
 220                 new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
 221         LOG.trace("{}: Transaction {} merging {} container to ensure its presence", id, writeTx.getIdentifier(),
 222                 Topology.QNAME);
 223         writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
 224     }
 225
 226     private void commitTransaction(final WriteTransaction transaction, final String txType) {
 227         LOG.trace("{}: Committing Transaction {}:{}", id, txType,
 228                 transaction.getIdentifier());
 229
 230         transaction.commit().addCallback(new FutureCallback<CommitInfo>() {
 231             @Override
 232             public void onSuccess(final CommitInfo result) {
 233                 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
 234                         transaction.getIdentifier());
 235             }
 236
 237             @Override
 238             public void onFailure(final Throwable throwable) {
 239                 LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
 240                         transaction.getIdentifier(), throwable);
 241                 throw new IllegalStateException(
 242                         id + "  Transaction(" + txType + ") not committed correctly", throwable);
 243             }
 244         }, MoreExecutors.directExecutor());
 245     }
 246
 247     private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
 248         final NodeBuilder nodeBuilder = new NodeBuilder();
 249         nodeBuilder.withKey(new NodeKey(new NodeId(id.getName())));
 250         return nodeBuilder;
 251     }
 252
 253     @Override
 254     public void close() {
 255         removeDeviceConfiguration();
 256     }
 257
 258     public void setTxChain(final TransactionChain txChain) {
 259         this.txChain = Preconditions.checkNotNull(txChain);
 260     }
 261 }