org.opendaylight.sfc.provider.api

Class SfcProviderServiceForwarderAPI

java.lang.Object

org.opendaylight.sfc.provider.api.SfcProviderServiceForwarderAPI

public final class SfcProviderServiceForwarderAPI
extends Object

This class has the APIs to operate on the ServiceFunction datastore.

It is normally called from onDataChanged() through a executor service. We need to use an executor service because we can not operate on a datastore while on onDataChanged() context.

Since:

2014-06-30

Version:

0.1

Author:

Reinaldo Penno (rapenno@gmail.com), Konstantin Blagov (blagov.sk@hotmail.com)

See Also:

ServiceFunctionListener

Method Summary

Modifier and Type	Method and Description
static boolean	addPathToServiceForwarderState(RenderedServicePath renderedServicePath) We add the path name to the operational store of each SFF.
static boolean	deletePathFromServiceForwarderState(List<RspName> renderedServicePaths) Delete the given list of service paths from the SFF operational state.
static boolean	deletePathFromServiceForwarderState(RspName rspName) When a SFF is deleted we need to delete all SFPs from the associated SFF.
static boolean	deletePathFromServiceForwarderState(ServiceFunctionPath serviceFunctionPath) When a SFF is deleted we need to delete all SFPs from the associated SFF operational state.
static boolean	deleteServiceFunctionForwarder(SffName serviceFunctionForwarderName) This method deletes a SFF from the datastore.
static boolean	deleteServiceFunctionForwarderState(SffName sffName) This method deletes the operational state for a service function.
static List<SffDataPlaneLocator>	getNonSfDataPlaneLocators(ServiceFunctionForwarder sff) Return a list of SffDataPlaneLocator that are not used by any SF, which is determined by looking at the Sff.SfDictionary.SffSfDpl.SffDpl.
static SffName	getSffName(String nodeName)
static ConnectedSffDictionary	getSffSffConnectedDictionary(SffName sffName, SffName dstSffName)
static boolean	putServiceFunctionForwarder(ServiceFunctionForwarder sff) This method creates a SFF in the data store.
static ServiceFunctionForwarders	readAllServiceFunctionForwarders() Read all Service Function Forwarders devices.
static List<RspName>	readRspNamesFromSffState(SffName sffName) Returns the list of RspName anchored by a SFF.
static ServiceFunctionForwarder	readServiceFunctionForwarder(SffName serviceFunctionForwarderName) This method reads a SFF from the datastore.
static SffDataPlaneLocator	readServiceFunctionForwarderDataPlaneLocator(SffName sffName, SffDataPlaneLocatorName sffLocatorName) This method searches for a data plane locator of a given name within a SFF.
static List<SffServicePath>	readSffState(SffName sffName) Returns the list of SFPs anchored by a SFF.

Methods inherited from class java.lang.Object

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

Method Detail

putServiceFunctionForwarder

public static boolean putServiceFunctionForwarder(ServiceFunctionForwarder sff)

This method creates a SFF in the data store.

Parameters:

sff - SFF object

Returns:

true if SFF was created, false otherwise

readServiceFunctionForwarderDataPlaneLocator

public static SffDataPlaneLocator readServiceFunctionForwarderDataPlaneLocator(SffName sffName,
                                                                               SffDataPlaneLocatorName sffLocatorName)

This method searches for a data plane locator of a given name within a SFF.

Parameters:

sffName - SFF name

sffLocatorName - SFF data plane locator name

Returns:

SffDataPlaneLocator object or null if not found

readServiceFunctionForwarder

public static ServiceFunctionForwarder readServiceFunctionForwarder(SffName serviceFunctionForwarderName)

This method reads a SFF from the datastore.

Parameters:

serviceFunctionForwarderName - SFF name

Returns:

SF object or null if not found

deleteServiceFunctionForwarder

public static boolean deleteServiceFunctionForwarder(SffName serviceFunctionForwarderName)

This method deletes a SFF from the datastore.

Parameters:

serviceFunctionForwarderName - SFF name

Returns:

true if SF was deleted, false otherwise

readAllServiceFunctionForwarders

public static ServiceFunctionForwarders readAllServiceFunctionForwarders()

Read all Service Function Forwarders devices.

Returns:

ServiceFunctionForwarders object

addPathToServiceForwarderState

public static boolean addPathToServiceForwarderState(RenderedServicePath renderedServicePath)

We add the path name to the operational store of each SFF.

Parameters:

renderedServicePath - RSP Object

Returns:

Nothing.

deletePathFromServiceForwarderState

public static boolean deletePathFromServiceForwarderState(ServiceFunctionPath serviceFunctionPath)

When a SFF is deleted we need to delete all SFPs from the associated SFF operational state.

Parameters:

serviceFunctionPath - SFP object

Returns:

true if all paths were deleted, false otherwise.

deletePathFromServiceForwarderState

public static boolean deletePathFromServiceForwarderState(List<RspName> renderedServicePaths)

Delete the given list of service paths from the SFF operational state.

Parameters:

renderedServicePaths - String List of Service Path names

Returns:

True if paths were deleted, false otherwise

deletePathFromServiceForwarderState

public static boolean deletePathFromServiceForwarderState(RspName rspName)

When a SFF is deleted we need to delete all SFPs from the associated SFF. operational state

Parameters:

rspName - SFP object

Returns:

true if all path was deleted, false otherwise.

deleteServiceFunctionForwarderState

public static boolean deleteServiceFunctionForwarderState(SffName sffName)

This method deletes the operational state for a service function.

Parameters:

sffName - SFF name

Returns:

A ServiceFunctionState object that is a list of all paths using this service function, null otherwise

readSffState

public static List<SffServicePath> readSffState(SffName sffName)

Returns the list of SFPs anchored by a SFF.

Parameters:

sffName - SFF name

Returns:

List of SFF service paths or null if no SFF state info exists

readRspNamesFromSffState

public static List<RspName> readRspNamesFromSffState(SffName sffName)

Returns the list of RspName anchored by a SFF.

Parameters:

sffName - the SFF name.

Returns:

the list of RspName.

getNonSfDataPlaneLocators

public static List<SffDataPlaneLocator> getNonSfDataPlaneLocators(ServiceFunctionForwarder sff)

Return a list of SffDataPlaneLocator that are not used by any SF, which is determined by looking at the Sff.SfDictionary.SffSfDpl.SffDpl. This is useful when there are multiple SFF DPLs, this returns the DPLs that are not used by SFs. For example, in the case of Vxgpe+NSH between the SFFs, and Eth+NSH to the SFs, there will be a Eth+NSH Dpl per SF, and just 1 Vxgpe+NSH DPL for the SFF-SFF, which will be returned by this method.

Parameters:

sff - - The SFF to process

Returns:

List of SffDataPlaneLocator not used by any SF

getSffSffConnectedDictionary

public static ConnectedSffDictionary getSffSffConnectedDictionary(SffName sffName,
                                                                  SffName dstSffName)

getSffName

public static SffName getSffName(String nodeName)