org.opendaylight.netvirt.vpnmanager.intervpnlink

Class InterVpnLinkUtil

java.lang.Object

org.opendaylight.netvirt.vpnmanager.intervpnlink.InterVpnLinkUtil

public final class InterVpnLinkUtil
extends Object

This class contains methods to be used as utilities related with inter-vpn-link.

Method Summary

Modifier and Type	Method and Description
static FirstEndpointState	buildFirstEndpointState(FirstEndpointState original, com.google.common.base.Optional<List<BigInteger>> new1stEndpointDpns, com.google.common.base.Optional<Long> new1stEndpointLportTag)
static FirstEndpointState	buildFirstEndpointState(String vpnName, List<BigInteger> dpnList, long lportTag)
static String	buildInterVpnLinkIfaceName(String vpnName, BigInteger dpnId)
static InterVpnLinkState	buildIvlStateFromOriginal(InterVpnLinkState original, com.google.common.base.Optional<FirstEndpointState> new1stEndpointState, com.google.common.base.Optional<SecondEndpointState> new2ndEndpointState, com.google.common.base.Optional<String> errDescription) Creates an InterVpnLinkState out of an existing one and modifying only the desired attributes.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow	buildLPortDispatcherFlow(String interVpnLinkName, long vpnId, int lportTag) Builds a Flow to be installed into LPortDispatcher table, that matches on SI=2 + vpnLinkEndpointPseudoPortTag and sends to FIB.
static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction>	buildLportDispatcherTableInstructions(long vpnId)
static SecondEndpointState	buildSecondEndpointState(SecondEndpointState original, com.google.common.base.Optional<List<BigInteger>> new2ndEndpointDpns, com.google.common.base.Optional<Long> new2ndEndpointLportTag)
static SecondEndpointState	buildSecondEndpointState(String vpnName, List<BigInteger> dpnList, long lportTag)
static List<InterVpnLink>	getAllInterVpnLinks(org.opendaylight.controller.md.sal.binding.api.DataBroker broker) Retrieves all configured InterVpnLinks.
static List<InterVpnLinkState>	getAllInterVpnLinkState(org.opendaylight.controller.md.sal.binding.api.DataBroker broker) Retrieves the States of all InterVpnLinks.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<InterVpnLink>	getInterVpnLinkPath(String interVpnLinkName) Retrieves the Instance Identifier that points to an InterVpnLink object in MD-SAL.
static com.google.common.base.Optional<InterVpnLinkState>	getInterVpnLinkState(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String interVpnLinkName) Retrieves the State of an InterVpnLink.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<InterVpnLinkState>	getInterVpnLinkStateIid(String vpnLinkName) Retrieves the Instance Identifier that points to an InterVpnLinkState object in MD-SAL.
static String	getLportDispatcherFlowRef(String interVpnLinkName, Integer lportTag) Builds a flowRef to be assigned to the flow to be installed into LPortDispatcher table.
static void	handleStaticRoute(InterVpnLinkDataComposite interVpnLink, String vpnName, String destination, String nexthop, int label, org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, IFibManager fibManager, IBgpManager bgpManager)
static List<com.google.common.util.concurrent.ListenableFuture<Void>>	installLPortDispatcherTableFlow(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager, String interVpnLinkName, List<BigInteger> dpnList, String vpnUuidOtherEndpoint, Long lportTagOfOtherEndpoint) Installs a Flow in LPortDispatcher table that matches on SI=2 and the lportTag of one InterVpnLink's endpoint and sets the vrfTag of the other endpoint and sends to FIB table.
static void	removeIVpnLinkIfaceFromVpnFootprint(VpnFootprintService vpnFootprintService, String vpnName, String rd, BigInteger dpnId) Updates VpnToDpn map by removing the fake VpnInterface related to an InterVpnLink in the corresponding DPNs.
static void	updateInterVpnLinkState(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String vpnLinkName, InterVpnLinkState.State state, FirstEndpointState newFirstEndpointState, SecondEndpointState newSecondEndpointState, InterVpnLinkCache interVpnLinkCache) Updates inter-VPN link state.
static void	updateVpnFootprint(VpnFootprintService vpnFootprintService, String vpnName, String primaryRd, List<BigInteger> dpnList) Updates VpnToDpn map by adding a fake VpnInterface related to an InterVpnLink in the corresponding DPNs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInterVpnLinkPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<InterVpnLink> getInterVpnLinkPath(String interVpnLinkName)

Retrieves the Instance Identifier that points to an InterVpnLink object in MD-SAL.

Parameters:

interVpnLinkName - The name of the InterVpnLink

Returns:

The requested InstanceIdentifier

getInterVpnLinkStateIid

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<InterVpnLinkState> getInterVpnLinkStateIid(String vpnLinkName)

Retrieves the Instance Identifier that points to an InterVpnLinkState object in MD-SAL.

Parameters:

vpnLinkName - The name of the InterVpnLink

Returns:

The requested InstanceIdentifier

buildInterVpnLinkIfaceName

public static String buildInterVpnLinkIfaceName(String vpnName,
                                                BigInteger dpnId)

updateVpnFootprint

public static void updateVpnFootprint(VpnFootprintService vpnFootprintService,
                                      String vpnName,
                                      String primaryRd,
                                      List<BigInteger> dpnList)

Updates VpnToDpn map by adding a fake VpnInterface related to an InterVpnLink in the corresponding DPNs. If the fake iface is the first one on the any of the specified DPNs, the installation of Fib flows on that DPN will be triggered.

Parameters:

vpnFootprintService - VpnFootprintService service reference

vpnName - Name of the VPN to which the fake interfaces belong

dpnList - List of DPNs where the fake InterVpnLink interface must be added

removeIVpnLinkIfaceFromVpnFootprint

public static void removeIVpnLinkIfaceFromVpnFootprint(VpnFootprintService vpnFootprintService,
                                                       String vpnName,
                                                       String rd,
                                                       BigInteger dpnId)

Updates VpnToDpn map by removing the fake VpnInterface related to an InterVpnLink in the corresponding DPNs.

Parameters:

vpnFootprintService - VpnFootprintService service reference

vpnName - Name of the VPN to which the fake interfaces belong

dpnId - DPN where the fake InterVpnLink interface must be removed from

buildFirstEndpointState

public static FirstEndpointState buildFirstEndpointState(FirstEndpointState original,
                                                         com.google.common.base.Optional<List<BigInteger>> new1stEndpointDpns,
                                                         com.google.common.base.Optional<Long> new1stEndpointLportTag)

buildFirstEndpointState

public static FirstEndpointState buildFirstEndpointState(String vpnName,
                                                         List<BigInteger> dpnList,
                                                         long lportTag)

buildSecondEndpointState

public static SecondEndpointState buildSecondEndpointState(SecondEndpointState original,
                                                           com.google.common.base.Optional<List<BigInteger>> new2ndEndpointDpns,
                                                           com.google.common.base.Optional<Long> new2ndEndpointLportTag)

buildSecondEndpointState

public static SecondEndpointState buildSecondEndpointState(String vpnName,
                                                           List<BigInteger> dpnList,
                                                           long lportTag)

buildIvlStateFromOriginal

public static InterVpnLinkState buildIvlStateFromOriginal(InterVpnLinkState original,
                                                          com.google.common.base.Optional<FirstEndpointState> new1stEndpointState,
                                                          com.google.common.base.Optional<SecondEndpointState> new2ndEndpointState,
                                                          com.google.common.base.Optional<String> errDescription)

Creates an InterVpnLinkState out of an existing one and modifying only the desired attributes.

Parameters:

original - InterVpnLinkState to start from.

new1stEndpointState - Sets this FirstEndpointState if present

new2ndEndpointState - Sets this SecondEndpointState if present

errDescription - Sets this ErrorDescription if present

Returns:

the newly build InterVpnLinkState

updateInterVpnLinkState

public static void updateInterVpnLinkState(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                           String vpnLinkName,
                                           InterVpnLinkState.State state,
                                           FirstEndpointState newFirstEndpointState,
                                           SecondEndpointState newSecondEndpointState,
                                           InterVpnLinkCache interVpnLinkCache)

Updates inter-VPN link state.

Parameters:

broker - dataBroker service reference

vpnLinkName - The name of the InterVpnLink

state - Sets the state of the InterVpnLink to Active or Error

newFirstEndpointState - Updates the lportTag and/or DPNs of the 1st endpoint of the InterVpnLink

newSecondEndpointState - Updates the lportTag and/or DPNs of the 2nd endpoint of the InterVpnLink

interVpnLinkCache - the InterVpnLinkCache

installLPortDispatcherTableFlow

public static List<com.google.common.util.concurrent.ListenableFuture<Void>> installLPortDispatcherTableFlow(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                                                             org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager,
                                                                                                             String interVpnLinkName,
                                                                                                             List<BigInteger> dpnList,
                                                                                                             String vpnUuidOtherEndpoint,
                                                                                                             Long lportTagOfOtherEndpoint)

Installs a Flow in LPortDispatcher table that matches on SI=2 and the lportTag of one InterVpnLink's endpoint and sets the vrfTag of the other endpoint and sends to FIB table.

Parameters:

broker - dataBroker service reference

mdsalManager - MDSAL API accessor

interVpnLinkName - Name of the InterVpnLink.

dpnList - The list of DPNs where this flow must be installed

vpnUuidOtherEndpoint - UUID of the other endpoint of the InterVpnLink

lportTagOfOtherEndpoint - Dataplane identifier of the other endpoint of the InterVpnLink

Returns:

the list of Futures for each and every flow that has been installed

buildLPortDispatcherFlow

public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow buildLPortDispatcherFlow(String interVpnLinkName,
                                                                                                                                long vpnId,
                                                                                                                                int lportTag)

Builds a Flow to be installed into LPortDispatcher table, that matches on SI=2 + vpnLinkEndpointPseudoPortTag and sends to FIB.

Parameters:

interVpnLinkName - The name of the InterVpnLink

vpnId - Dataplane identifier of the VPN, the Vrf Tag.

lportTag - DataPlane identifier of the LogicalPort.

Returns:

the Flow ready to be installed

getLportDispatcherFlowRef

public static String getLportDispatcherFlowRef(String interVpnLinkName,
                                               Integer lportTag)

Builds a flowRef to be assigned to the flow to be installed into LPortDispatcher table.

Parameters:

interVpnLinkName - The name of the InterVpnLink

lportTag - Dataplane identifier of the LogicalPort

Returns:

the flow reference string

buildLportDispatcherTableInstructions

public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> buildLportDispatcherTableInstructions(long vpnId)

getAllInterVpnLinkState

public static List<InterVpnLinkState> getAllInterVpnLinkState(org.opendaylight.controller.md.sal.binding.api.DataBroker broker)

Retrieves the States of all InterVpnLinks.

Parameters:

broker - dataBroker service reference

Returns:

the list of objects that holds the InterVpnLink state information

getInterVpnLinkState

public static com.google.common.base.Optional<InterVpnLinkState> getInterVpnLinkState(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                                      String interVpnLinkName)

Retrieves the State of an InterVpnLink.

Parameters:

broker - dataBroker service reference

interVpnLinkName - The name of the InterVpnLink

Returns:

the object that contains the State of the specified InterVpnLink or Optional.absent() if it doesnt exist

getAllInterVpnLinks

public static List<InterVpnLink> getAllInterVpnLinks(org.opendaylight.controller.md.sal.binding.api.DataBroker broker)

Retrieves all configured InterVpnLinks.

Parameters:

broker - dataBroker service reference

Returns:

the list of InterVpnLinks

handleStaticRoute

public static void handleStaticRoute(InterVpnLinkDataComposite interVpnLink,
                                     String vpnName,
                                     String destination,
                                     String nexthop,
                                     int label,
                                     org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                                     IFibManager fibManager,
                                     IBgpManager bgpManager)
                              throws Exception

Throws:

Exception