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