netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/util/RemoteDeviceId.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.netconf.sal.connect.util;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import java.net.InetSocketAddress;
  14 import java.util.Objects;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.DomainName;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.network.topology.topology.topology.types.TopologyNetconf;
  19 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  20 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  21 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  22 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  23 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  24 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  25 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  26 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  27 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.common.QName;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  31
  32 public final class RemoteDeviceId {
  33     private static final String DEFAULT_TOPOLOGY_NAME = TopologyNetconf.QNAME.getLocalName();
  34     private static final YangInstanceIdentifier DEFAULT_TOPOLOGY_NODE = YangInstanceIdentifier.builder()
  35             .node(NetworkTopology.QNAME).node(Topology.QNAME)
  36             .nodeWithKey(Topology.QNAME, QName.create(Topology.QNAME, "topology-id"), DEFAULT_TOPOLOGY_NAME)
  37             .node(Node.QNAME)
  38             .build();
  39     private static final QName NODE_ID_QNAME = QName.create(Node.QNAME, "node-id").intern();
  40
  41     // FIXME: extract this into caller and pass to constructor
  42     @VisibleForTesting
  43     public static final KeyedInstanceIdentifier<Topology, TopologyKey> DEFAULT_TOPOLOGY_IID =
  44         InstanceIdentifier.create(NetworkTopology.class)
  45         .child(Topology.class, new TopologyKey(new TopologyId(DEFAULT_TOPOLOGY_NAME)));
  46
  47     private final String name;
  48     private final NodeKey key;
  49     private final YangInstanceIdentifier topologyPath;
  50     private final KeyedInstanceIdentifier<Node, NodeKey> topologyBindingPath;
  51     private InetSocketAddress address;
  52     private Host host;
  53
  54     private RemoteDeviceId(final String name) {
  55         this.name = requireNonNull(name);
  56         topologyPath = DEFAULT_TOPOLOGY_NODE.node(NodeIdentifierWithPredicates.of(Node.QNAME, NODE_ID_QNAME, name));
  57         key = new NodeKey(new NodeId(name));
  58         topologyBindingPath = DEFAULT_TOPOLOGY_IID.child(Node.class, key);
  59     }
  60
  61     public RemoteDeviceId(final String name, final InetSocketAddress address) {
  62         this(name);
  63         this.address = address;
  64         host = buildHost();
  65     }
  66
  67     private Host buildHost() {
  68         final var addr = address.getAddress();
  69         return addr != null ? new Host(IetfInetUtil.INSTANCE.ipAddressFor(addr))
  70             : new Host(new DomainName(address.getHostString()));
  71     }
  72
  73     public String getName() {
  74         return name;
  75     }
  76
  77     public NodeKey getBindingKey() {
  78         return key;
  79     }
  80
  81     public InstanceIdentifier<Node> getTopologyBindingPath() {
  82         return topologyBindingPath;
  83     }
  84
  85     public YangInstanceIdentifier getTopologyPath() {
  86         return topologyPath;
  87     }
  88
  89     public InetSocketAddress getAddress() {
  90         return address;
  91     }
  92
  93     public Host getHost() {
  94         return host;
  95     }
  96
  97     @Override
  98     public String toString() {
  99         return "RemoteDevice{" + name + '}';
 100     }
 101
 102     @Override
 103     public boolean equals(final Object obj) {
 104         return this == obj || obj instanceof RemoteDeviceId other
 105             && name.equals(other.name) && topologyBindingPath.equals(other.topologyBindingPath);
 106     }
 107
 108     @Override
 109     public int hashCode() {
 110         return Objects.hash(name, topologyBindingPath);
 111     }
 112 }