org.opendaylight.sfc.ofrenderer.utils

Class SfcOfBaseProviderUtils

java.lang.Object

org.opendaylight.sfc.ofrenderer.utils.SfcOfBaseProviderUtils

Direct Known Subclasses:

SfcOfProviderUtils

public abstract class SfcOfBaseProviderUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
SfcOfBaseProviderUtils()

Method Summary

Modifier and Type	Method and Description
abstract void	addRsp(long rspId)
String	getDictPortInfoMac(ServiceFunctionForwarder sff, ServiceFunctionDictionary dict) Given an SFF object and SFF-SF dictionary entry, return the SFF Mac.
String	getDictPortInfoPort(ServiceFunctionForwarder sff, ServiceFunctionDictionary dict) Given an SFF object and SFF-SF dictionary entry, return the switch port string.
String	getDplPortInfoMac(SffDataPlaneLocator dpl) Given a possibly augmented SFF DPL, return the DPL mac address.
String	getDplPortInfoPort(SffDataPlaneLocator dpl) Given a possibly augmented SFF DPL, return the DPL switch port.
abstract Long	getPortNumberFromName(String bridgeName, String portName, long rspId)
abstract ServiceFunction	getServiceFunction(SfName sfName, long rspId)
abstract ServiceFunctionForwarder	getServiceFunctionForwarder(SffName sffName, long rspId)
abstract ServiceFunctionGroup	getServiceFunctionGroup(String sfgName, long rspId)
abstract ServiceFunctionType	getServiceFunctionType(SfName sfName, long rspId)
SfDataPlaneLocator	getSfDataPlaneLocator(ServiceFunction sf, SffName sffName) Return the SfDataPlaneLocator on the SF that connects to the named SFF.
SfDataPlaneLocator	getSfDataPlaneLocator(ServiceFunction sf, SffSfDataPlaneLocator sffSfDpl) Given a ServiceFunction get the SF DPL name from the SffSfDataPlaneLocator and return the SF DPL.
String	getSfDplMac(SfDataPlaneLocator sfDpl) Return the mac address from a SF DPL, only if its a MAC DPL.
SffDataPlaneLocator	getSffDataPlaneLocator(ServiceFunctionForwarder sff, SffDataPlaneLocatorName dplName) Return a named SffDataPlaneLocator on a SFF.
List<SffDataPlaneLocator>	getSffDataPlaneLocators(SffName sffName, long rspId) Return a named SffDataPlaneLocator on a SFF.
String	getSffDplMac(SffDataPlaneLocator sfDpl) Return the mac address from a SFF DPL, only if its a MAC DPL.
abstract List<SffDataPlaneLocator>	getSffNonSfDataPlaneLocators(ServiceFunctionForwarder sff)
String	getSffOpenFlowNodeName(ServiceFunctionForwarder sff) Given an SFF object, return the augmented OpenFlow NodeName.
String	getSffOpenFlowNodeName(SffName sffName, long rspId) Given an SFF name, return the augmented OpenFlow NodeName.
String	getSffOpenFlowNodeName(SffName sffName, long rspId, DpnIdType dpnid) Given an SFF name, return the augmented OpenFlow NodeName.
OfsPort	getSffPortInfoFromDpl(SffDataPlaneLocator sffDpl) Given a possibly augmented SFF DPL, return the augmented OfsPort object.
SffSfDataPlaneLocator	getSffSfDataPlaneLocator(ServiceFunctionForwarder sff, SfName sfName) Return the named SF ServiceFunctionDictionary SffSfDataPlaneLocator from the sff sf-dictionary list.
ServiceFunctionDictionary	getSffSfDictionary(ServiceFunctionForwarder sff, SfName sfName) Return the named SF ServiceFunctionDictionary element from the sff sf-dictionary list.
SffDataPlaneLocator	getSffSfDictSffDpl(SfName sfName, SffName sffName, long rspId)
String	getSfLogicalInterfaceName(ServiceFunction sf) Given a SF, retrieve the logical interface name.
abstract void	removeRsp(long rspId)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

SfcOfBaseProviderUtils

public SfcOfBaseProviderUtils()

Method Detail

addRsp

public abstract void addRsp(long rspId)

removeRsp

public abstract void removeRsp(long rspId)

getServiceFunction

public abstract ServiceFunction getServiceFunction(SfName sfName,
                                                   long rspId)

getServiceFunctionType

public abstract ServiceFunctionType getServiceFunctionType(SfName sfName,
                                                           long rspId)

getServiceFunctionForwarder

public abstract ServiceFunctionForwarder getServiceFunctionForwarder(SffName sffName,
                                                                     long rspId)

getServiceFunctionGroup

public abstract ServiceFunctionGroup getServiceFunctionGroup(String sfgName,
                                                             long rspId)

getPortNumberFromName

public abstract Long getPortNumberFromName(String bridgeName,
                                           String portName,
                                           long rspId)

getSffNonSfDataPlaneLocators

public abstract List<SffDataPlaneLocator> getSffNonSfDataPlaneLocators(ServiceFunctionForwarder sff)

getSffDataPlaneLocator

public SffDataPlaneLocator getSffDataPlaneLocator(ServiceFunctionForwarder sff,
                                                  SffDataPlaneLocatorName dplName)

Return a named SffDataPlaneLocator on a SFF.

Parameters:

sff - - The SFF to search in

dplName - - The name of the DPL to look for

Returns:

SffDataPlaneLocator or null if not found

getSfDataPlaneLocator

public SfDataPlaneLocator getSfDataPlaneLocator(ServiceFunction sf,
                                                SffName sffName)

Return the SfDataPlaneLocator on the SF that connects to the named SFF.

Parameters:

sf - the ServiceFunction to search through

sffName - the SFF name to search for

Returns:

SfDataPlaneLocator or null if not found

getSfDataPlaneLocator

public SfDataPlaneLocator getSfDataPlaneLocator(ServiceFunction sf,
                                                SffSfDataPlaneLocator sffSfDpl)

Given a ServiceFunction get the SF DPL name from the SffSfDataPlaneLocator and return the SF DPL.

Parameters:

sf - the ServiceFunction to search through

sffSfDpl - The SffSf DPL to compare against

Returns:

SfDataPlaneLocator if found, else null

getSffSfDataPlaneLocator

public SffSfDataPlaneLocator getSffSfDataPlaneLocator(ServiceFunctionForwarder sff,
                                                      SfName sfName)

Return the named SF ServiceFunctionDictionary SffSfDataPlaneLocator from the sff sf-dictionary list.

Parameters:

sff - - The SFF to search in

sfName - - The name of the DPL to look for

Returns:

SffSfDataPlaneLocator or null if not found

getSffSfDictionary

public ServiceFunctionDictionary getSffSfDictionary(ServiceFunctionForwarder sff,
                                                    SfName sfName)

Return the named SF ServiceFunctionDictionary element from the sff sf-dictionary list.

Parameters:

sff - the SFF to search through

sfName - the SF name to look for

Returns:

A ServiceFunctionDictionary entry or null if not found

getSfDplMac

public String getSfDplMac(SfDataPlaneLocator sfDpl)

Return the mac address from a SF DPL, only if its a MAC DPL.

Parameters:

sfDpl - the SF DPL to process

Returns:

macAddress string or null if its not a MAC DPL

getSffDplMac

public String getSffDplMac(SffDataPlaneLocator sfDpl)

Return the mac address from a SFF DPL, only if its a MAC DPL.

Parameters:

sfDpl - the SFF DPL to process

Returns:

macAddress string or null if its not a MAC DPL

getDictPortInfoPort

public String getDictPortInfoPort(ServiceFunctionForwarder sff,
                                  ServiceFunctionDictionary dict)

Given an SFF object and SFF-SF dictionary entry, return the switch port string. Looks for the SFF DPL name in the SFF-SF dictionary, then looks up that DPL name on the SFF.

Parameters:

sff - the SFF to process

dict - used to get the SFF DPL name

Returns:

switch port string, INPORT if not augmented, INPORT if not found

getSffPortInfoFromDpl

public OfsPort getSffPortInfoFromDpl(SffDataPlaneLocator sffDpl)

Given a possibly augmented SFF DPL, return the augmented OfsPort object.

Parameters:

sffDpl - The SFF DPL to process

Returns:

OfsPort, null if not augmented, null if not found

getDplPortInfoPort

public String getDplPortInfoPort(SffDataPlaneLocator dpl)

Given a possibly augmented SFF DPL, return the DPL switch port. The augmentation will be a OfsPort object.

Parameters:

dpl - the SFF DPL to process

Returns:

switch port string, INPORT if not augmented, INPORT if not found

getDplPortInfoMac

public String getDplPortInfoMac(SffDataPlaneLocator dpl)

Given a possibly augmented SFF DPL, return the DPL mac address. The augmentation will be a OfsPort object.

Parameters:

dpl - the SFF DPL to process

Returns:

mac address string, null if not augmented, null if not found

getDictPortInfoMac

public String getDictPortInfoMac(ServiceFunctionForwarder sff,
                                 ServiceFunctionDictionary dict)

Given an SFF object and SFF-SF dictionary entry, return the SFF Mac. Looks for the SFF DPL name in the SFF-SF dictionary, then looks up that DPL name on the SFF.

Parameters:

sff - The SFF to process

dict - contains the SFF DPL name to process

Returns:

MAC Address string, null if the DPL is not mac, null if not found

getSffOpenFlowNodeName

public String getSffOpenFlowNodeName(SffName sffName,
                                     long rspId)

Given an SFF name, return the augmented OpenFlow NodeName.

Parameters:

sffName - The SFF name to process

rspId - the rsp the SFF is being processed on

Returns:

OpenFlow NodeName, null if not augmented, null if not found

getSffOpenFlowNodeName

public String getSffOpenFlowNodeName(SffName sffName,
                                     long rspId,
                                     DpnIdType dpnid)

Given an SFF name, return the augmented OpenFlow NodeName.

Parameters:

sffName - The SFF name to process

rspId - the rsp the SFF is being processed on

dpnid - data plane node identifier for the switch. It is null when it is not known; when provided, it is used directly to build the openflow node name

Returns:

OpenFlow NodeName, null if not augmented, null if not found

getSffOpenFlowNodeName

public String getSffOpenFlowNodeName(ServiceFunctionForwarder sff)

Given an SFF object, return the augmented OpenFlow NodeName.

Parameters:

sff - The SFF name to process

Returns:

OpenFlow NodeName or null if augmented or not found

getSfLogicalInterfaceName

public String getSfLogicalInterfaceName(ServiceFunction sf)

Given a SF, retrieve the logical interface name.

Parameters:

sf - The service function to use

Returns:

String the logical interface name when the SF is using a logical interface; null otherwise

getSffSfDictSffDpl

public SffDataPlaneLocator getSffSfDictSffDpl(SfName sfName,
                                              SffName sffName,
                                              long rspId)

getSffDataPlaneLocators

public List<SffDataPlaneLocator> getSffDataPlaneLocators(SffName sffName,
                                                         long rspId)

Return a named SffDataPlaneLocator on a SFF.

Parameters:

sffName - The SFF name to search in

rspId - rendered service path ID

Returns:

list of SffDataPlaneLocator or null if not found