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