bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/config/OpenConfigMappingUtil.java

   1 /*
   2  * Copyright (c) 2016 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.protocol.bgp.rib.impl.config;
  10
  11 import static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil.INSTANCE;
  12
  13 import com.google.common.collect.ImmutableList;
  14 import java.util.Collections;
  15 import java.util.List;
  16 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  17 import org.opendaylight.protocol.concepts.KeyMapping;
  18 import org.opendaylight.protocol.util.Ipv4Util;
  19 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.BgpCommonAfiSafiList;
  20 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
  21 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafiBuilder;
  22 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Timers;
  23 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.transport.Config;
  24 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
  25 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.NeighborKey;
  26 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
  27 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Neighbors;
  28 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.IPV4UNICAST;
  29 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.Protocol;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.Config1;
  33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  34
  35 final class OpenConfigMappingUtil {
  36
  37     private static final AfiSafi IPV4_AFISAFI = new AfiSafiBuilder().setAfiSafiName(IPV4UNICAST.class).build();
  38     private static final List<AfiSafi> DEFAULT_AFISAFI = ImmutableList.of(IPV4_AFISAFI);
  39     private static final int HOLDTIMER = 90;
  40     private static final int CONNECT_RETRY = 30;
  41     private static final PortNumber PORT = new PortNumber(179);
  42
  43     private OpenConfigMappingUtil() {
  44         throw new UnsupportedOperationException();
  45     }
  46
  47     public static String getRibInstanceName(final InstanceIdentifier<?> rootIdentifier) {
  48         return rootIdentifier.firstKeyOf(Protocol.class).getName();
  49     }
  50
  51     public static int getHoldTimer(final Neighbor neighbor) {
  52         final org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.timers.Config config =
  53                 getTimersConfig(neighbor);
  54         if (config != null && config.getHoldTime() != null) {
  55             return config.getHoldTime().intValue();
  56         }
  57         return HOLDTIMER;
  58     }
  59
  60     public static AsNumber getPeerAs(final Neighbor neighbor, final RIB rib) {
  61         if (neighbor.getConfig() != null) {
  62             final AsNumber peerAs = neighbor.getConfig().getPeerAs();
  63             if (peerAs != null) {
  64                 return peerAs;
  65             }
  66         }
  67         return rib.getLocalAs();
  68     }
  69
  70     public static boolean isActive(final Neighbor neighbor) {
  71         if (neighbor.getTransport() != null) {
  72             final Config config = neighbor.getTransport().getConfig();
  73             if (config != null && config.isPassiveMode() != null) {
  74                 return !config.isPassiveMode();
  75             }
  76         }
  77         return true;
  78     }
  79
  80     public static int getRetryTimer(final Neighbor neighbor) {
  81         final org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.timers.Config config =
  82                 getTimersConfig(neighbor);
  83         if (config != null && config.getConnectRetry() != null) {
  84             return config.getConnectRetry().intValue();
  85         }
  86         return CONNECT_RETRY;
  87     }
  88
  89     public static KeyMapping getNeighborKey(final Neighbor neighbor) {
  90         if (neighbor.getConfig() != null) {
  91             final String authPassword = neighbor.getConfig().getAuthPassword();
  92             if (authPassword != null) {
  93                 return KeyMapping.getKeyMapping(INSTANCE.inetAddressFor(neighbor.getNeighborAddress()), authPassword);
  94             }
  95         }
  96         return null;
  97     }
  98
  99     public static InstanceIdentifier<Neighbor> getNeighborInstanceIdentifier(final InstanceIdentifier<Bgp> rootIdentifier,
 100             final NeighborKey neighborKey) {
 101         return rootIdentifier.child(Neighbors.class).child(Neighbor.class, neighborKey);
 102     }
 103
 104     public static String getNeighborInstanceName(final InstanceIdentifier<?> rootIdentifier) {
 105         return Ipv4Util.toStringIP(rootIdentifier.firstKeyOf(Neighbor.class).getNeighborAddress());
 106     }
 107
 108     public static PortNumber getPort(final Neighbor neighbor) {
 109         if (neighbor.getTransport() != null) {
 110             final Config config = neighbor.getTransport().getConfig();
 111             if (config != null && config.getAugmentation(Config1.class) != null) {
 112                 final PortNumber remotePort = config.getAugmentation(Config1.class).getRemotePort();
 113                 if (remotePort != null) {
 114                     return remotePort;
 115                 }
 116             }
 117         }
 118         return PORT;
 119     }
 120
 121     //make sure IPv4 Unicast (RFC 4271) when required
 122     public static List<AfiSafi> getAfiSafiWithDefault(final BgpCommonAfiSafiList afiSAfis, final boolean setDeafultIPv4) {
 123         if (afiSAfis == null || afiSAfis.getAfiSafi() == null) {
 124             return setDeafultIPv4 ? DEFAULT_AFISAFI : Collections.emptyList();
 125         }
 126         final List<AfiSafi> afiSafi = afiSAfis.getAfiSafi();
 127         if (setDeafultIPv4) {
 128             final boolean anyMatch = afiSafi.stream().anyMatch(input -> input.getAfiSafiName().equals(IPV4UNICAST.class));
 129             if (!anyMatch) {
 130                 afiSafi.add(IPV4_AFISAFI);
 131             }
 132         }
 133         return afiSafi;
 134     }
 135
 136     private static org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.timers.Config getTimersConfig(final Neighbor neighbor) {
 137         final Timers timers = neighbor.getTimers();
 138         return timers != null ? timers.getConfig() : null;
 139     }
 140
 141 }