bgp/topology-provider/src/main/java/org/opendaylight/bgpcep/bgp/topology/provider/UriBuilder.java

   1 /*
   2  * Copyright (c) 2013 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.bgpcep.bgp.topology.provider;
   9
  10 import com.google.common.io.BaseEncoding;
  11 import com.google.common.primitives.UnsignedBytes;
  12 import java.util.Arrays;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.IsisAreaIdentifier;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.NodeIdentifier;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.linkstate.object.type.LinkCase;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.linkstate.object.type.link._case.LinkDescriptors;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.linkstate.routes.linkstate.routes.LinkstateRoute;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.node.identifier.CRouterIdentifier;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.node.identifier.c.router.identifier.IsisNodeCase;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.node.identifier.c.router.identifier.IsisPseudonodeCase;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.node.identifier.c.router.identifier.OspfNodeCase;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.node.identifier.c.router.identifier.OspfPseudonodeCase;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.node.identifier.c.router.identifier.isis.pseudonode._case.IsisPseudonode;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev171207.node.identifier.c.router.identifier.ospf.pseudonode._case.OspfPseudonode;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.IsoSystemIdentifier;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 final class UriBuilder {
  30     private static final Logger LOG = LoggerFactory.getLogger(UriBuilder.class);
  31     private static final char HEX_SEPARATOR = '.';
  32     private static final int AREA_ID_MAX_SIZE = 7;
  33     private final StringBuilder sb;
  34
  35     UriBuilder(final UriBuilder base, final String type) {
  36         this.sb = new StringBuilder(base.sb);
  37         this.sb.append("type=").append(type);
  38     }
  39
  40     UriBuilder(final LinkstateRoute route) {
  41         this.sb = new StringBuilder("bgpls://");
  42
  43         if (route.getDistinguisher() != null) {
  44             this.sb.append(route.getDistinguisher().getValue().toString()).append(':');
  45         }
  46
  47         this.sb.append(route.getProtocolId().toString()).append(':')
  48                 .append(route.getIdentifier().getValue().toString()).append('/');
  49     }
  50
  51     UriBuilder add(final String name, final Object value) {
  52         if (value != null) {
  53             this.sb.append('&').append(name).append('=').append(value.toString());
  54         }
  55         return this;
  56     }
  57
  58     UriBuilder add(final LinkCase link) {
  59         addPrefix("local-", link.getLocalNodeDescriptors());
  60         addPrefix("remote-", link.getRemoteNodeDescriptors());
  61
  62         final LinkDescriptors ld = link.getLinkDescriptors();
  63         if (ld.getIpv4InterfaceAddress() != null) {
  64             add("ipv4-iface", ld.getIpv4InterfaceAddress().getValue());
  65         }
  66         if (ld.getIpv4NeighborAddress() != null) {
  67             add("ipv4-neigh", ld.getIpv4NeighborAddress().getValue());
  68         }
  69         if (ld.getIpv6InterfaceAddress() != null) {
  70             add("ipv6-iface", ld.getIpv6InterfaceAddress().getValue());
  71         }
  72         if (ld.getIpv6NeighborAddress() != null) {
  73             add("ipv6-neigh", ld.getIpv6NeighborAddress().getValue());
  74         }
  75         if (ld.getMultiTopologyId() != null) {
  76             add("mt", ld.getMultiTopologyId().getValue());
  77         }
  78         add("local-id", ld.getLinkLocalIdentifier());
  79         add("remote-id", ld.getLinkRemoteIdentifier());
  80         return this;
  81     }
  82
  83     private static String isoId(final byte[] bytes) {
  84         final StringBuilder sBuilder = new StringBuilder();
  85         int id = 0;
  86         while (id < bytes.length) {
  87             sBuilder.append(BaseEncoding.base16().encode(new byte[] { bytes[id++], bytes[id++] }));
  88             if (id != bytes.length) {
  89                 sBuilder.append(HEX_SEPARATOR);
  90             }
  91         }
  92         return sBuilder.toString();
  93     }
  94
  95     /**
  96      * Creates a String representation of ISO system identifier
  97      * in format XX.XX.XX where X is one byte.
  98      *
  99      * @param systemId IsoSystemIdentifier object
 100      * @return String representation of ISO Identifier
 101      */
 102     public static String isoId(final IsoSystemIdentifier systemId) {
 103         return isoId(systemId.getValue());
 104     }
 105
 106     private static String formatRouterIdentifier(final CRouterIdentifier routerIdentifier) {
 107         if (routerIdentifier == null) {
 108             return null;
 109         }
 110         if (routerIdentifier instanceof IsisNodeCase) {
 111             return isoId(((IsisNodeCase) routerIdentifier).getIsisNode().getIsoSystemId());
 112         }
 113         if (routerIdentifier instanceof IsisPseudonodeCase) {
 114             final IsisPseudonode r = ((IsisPseudonodeCase) routerIdentifier).getIsisPseudonode();
 115             return isoId(r.getIsIsRouterIdentifier().getIsoSystemId().getValue()) + '.'
 116                     + BaseEncoding.base16().encode(new byte[] { UnsignedBytes.checkedCast(r.getPsn()) });
 117         }
 118         if (routerIdentifier instanceof OspfNodeCase) {
 119             return ((OspfNodeCase) routerIdentifier).getOspfNode().getOspfRouterId().toString();
 120         }
 121         if (routerIdentifier instanceof OspfPseudonodeCase) {
 122             final OspfPseudonode r = ((OspfPseudonodeCase) routerIdentifier).getOspfPseudonode();
 123             return r.getOspfRouterId().toString() + ':' + r.getLanInterface().getValue();
 124         }
 125         LOG.warn("Unhandled router identifier type {}, fallback to toString()",
 126                 routerIdentifier.getImplementedInterface());
 127         return routerIdentifier.toString();
 128     }
 129
 130     UriBuilder addPrefix(final String prefix, final NodeIdentifier node) {
 131         if (node.getAsNumber() != null) {
 132             add(prefix + "as", node.getAsNumber().getValue());
 133         }
 134         if (node.getDomainId() != null) {
 135             add(prefix + "domain", node.getDomainId().getValue());
 136         }
 137         if (node.getAreaId() != null) {
 138             add(prefix + "area", node.getAreaId().getValue());
 139         }
 140         add(prefix + "router", formatRouterIdentifier(node.getCRouterIdentifier()));
 141         return this;
 142     }
 143
 144     @Override
 145     public String toString() {
 146         final String ret = this.sb.toString();
 147         LOG.trace("New URI {}", ret);
 148         return ret;
 149     }
 150
 151     /**
 152      * Creates string representation of IS-IS Network Entity Title,
 153      * based on Area Identifier and System Identifier.
 154      *
 155      * @param areaId IS-IS Area Identifier
 156      * @param systemId string representation of ISO SYSTEM-ID
 157      * @return ISO NET ID
 158      */
 159     public static String toIsoNetId(final IsisAreaIdentifier areaId, final String systemId) {
 160         final byte[] value = areaId.getValue();
 161         //first byte is AFI
 162         //ISIS area identifier might have variable length, but need to fit the IsoNetId pattern
 163         return BaseEncoding.base16().encode(value, 0, 1) + HEX_SEPARATOR
 164                 + UriBuilder.isoId(Arrays.copyOfRange(value, 1, AREA_ID_MAX_SIZE)) + HEX_SEPARATOR + systemId;
 165     }
 166 }