org.opendaylight.sfc.genius.util

Class SfcGeniusRpcClient

java.lang.Object

org.opendaylight.sfc.genius.util.SfcGeniusRpcClient

public class SfcGeniusRpcClient
extends Object

This class centralizes all Genius RPC accesses which SFC openflow renderer needs when using logical SFFs.

Author:

Diego Granados (diego.jesus.granados.lopez@ericsson.com)

Constructor Summary

Constructors

Constructor and Description
SfcGeniusRpcClient(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcProviderRegistry) Constructor.

Method Summary

Modifier and Type	Method and Description
Optional<DpnIdType>	getDpnIdFromInterfaceNameFromGeniusRPC(String logicalInterfaceName) Given a Neutron interface to which a VM (hosting a SF instance) is attached, the method returns the DPN ID for the dataplane node in the compute node where the VM is running.
List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress>	getDpnIpFromGeniusRPC(DpnIdType theDpnIdType) Given a DPN ID, the method returns its IP addresses.
Optional<List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action>>	getEgressActionsFromGeniusRPC(String targetInterfaceName, boolean interfaceIsPartOfTheTransportZone, int actionOffset) Retrieve egress actions from Genius.
Optional<String>	getTargetInterfaceFromGeniusRPC(DpnIdType srcDpid, DpnIdType dstDpid) Given a pair of data plane node identifiers, the method returns the interface to use for sending traffic from the first dpn to the second.

Methods inherited from class java.lang.Object

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

Constructor Detail

SfcGeniusRpcClient

public SfcGeniusRpcClient(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcProviderRegistry)

Constructor.

Parameters:

rpcProviderRegistry - The registry used to retrieve RPC services

Method Detail

getEgressActionsFromGeniusRPC

public Optional<List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action>> getEgressActionsFromGeniusRPC(String targetInterfaceName,
                                                                                                                                             boolean interfaceIsPartOfTheTransportZone,
                                                                                                                                             int actionOffset)

Retrieve egress actions from Genius.

Parameters:

targetInterfaceName - the interface to use

interfaceIsPartOfTheTransportZone - true when the interface is part of the transport zone (i.e. it is an interface between switching elements in different compute nodes); false when it is the Neutron interface of a SF

actionOffset - offsets the order parameter of the actions gotten from genius RPC

Returns:

The egress instructions to use, or empty when the RPC invocation failed

getTargetInterfaceFromGeniusRPC

public Optional<String> getTargetInterfaceFromGeniusRPC(DpnIdType srcDpid,
                                                        DpnIdType dstDpid)

Given a pair of data plane node identifiers, the method returns the interface to use for sending traffic from the first dpn to the second. This method assumes that a Genius' transport zone exists and that it including all the dataplane nodes involved in the SFC chain, so vxlan-gpe tunnels exist beforehand between all data plane nodes.

Parameters:

srcDpid - DPN ID for the source dataplane node

dstDpid - DPN ID for the target dataplane node

Returns:

The interface to use for traffic steering between the given dataplane nodes(empty when some problem arises during the retrieval)

getDpnIdFromInterfaceNameFromGeniusRPC

public Optional<DpnIdType> getDpnIdFromInterfaceNameFromGeniusRPC(String logicalInterfaceName)

Given a Neutron interface to which a VM (hosting a SF instance) is attached, the method returns the DPN ID for the dataplane node in the compute node where the VM is running.

Parameters:

logicalInterfaceName - the Neutron interface that the SF is attached to

Returns:

the DPN ID for the dataplane node in the compute node hosting the SF, or empty when the value cannot be retrieved

getDpnIpFromGeniusRPC

public List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getDpnIpFromGeniusRPC(DpnIdType theDpnIdType)

Given a DPN ID, the method returns its IP addresses.

Parameters:

theDpnIdType - the dataplane id.

Returns:

the IP addresses.