org.opendaylight.sfc.provider.api

Class SfcProviderRenderedPathAPI

java.lang.Object

org.opendaylight.sfc.provider.api.SfcProviderRenderedPathAPI

public final class SfcProviderRenderedPathAPI
extends Object

This class has the APIs to operate on the Service Classifier 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-11-04

Version:

0.1

Author:

Reinaldo Penno (rapenno@gmail.com)

Method Summary

Modifier and Type	Method and Description
static RenderedServicePath	createRenderedServicePathAndState(ServiceFunctionPath createdServiceFunctionPath, CreateRenderedPathInput createRenderedPathInput) Creates a RSP and all the associated operational state based on the given service function path.
static RenderedServicePath	createRenderedServicePathAndState(ServiceFunctionPath createdServiceFunctionPath, CreateRenderedPathInput createRenderedPathInput, SfcServiceFunctionSchedulerAPI possibleScheduler) Creates a RSP and all the associated operational state based on the given service function path and scheduler.
protected static RenderedServicePath	createRenderedServicePathEntry(ServiceFunctionPath serviceFunctionPath, CreateRenderedPathInput createRenderedPathInput, SfcServiceFunctionSchedulerAPI scheduler) Create a Rendered Path and all the associated operational state based on the given rendered service path and scheduler.
protected static List<RenderedServicePathHop>	createRenderedServicePathHopList(List<SfName> serviceFunctionNameList, List<String> sfgNameList, int startingServiceIndex) Given a list of Service Functions, create a RenderedServicePath Hop List.
static RenderedServicePath	createReverseRenderedServicePathEntry(RenderedServicePath renderedServicePath) Creates a RSP that is mirror image of the given one.
static RenderedServicePath	createSymmetricRenderedServicePathAndState(RenderedServicePath renderedServicePath) Create a Symmetric Path and all the associated operational state based on the given rendered service path.
static boolean	deleteRenderedServicePath(RspName renderedServicePathName) This method deletes a RSP from the datastore and frees the Path ID.
static boolean	deleteRenderedServicePaths(List<RspName> servicePaths) When a SFF is deleted directly we need to delete all associated SFPs.
static boolean	deleteRenderedServicePathsAndStates(List<RspName> rspNames) Delete a list of RSPs and associated states.
static RspName	generateReversedPathName(RspName rspName) Given the name of an RSP, return its reverse RSP name.
static RspName	getReversedRspName(RspName rspName) It returns the Symmetric RSP Name from a RspName if both exist.
static boolean	isChainSymmetric(ServiceFunctionPath sfp, RenderedServicePath rsp) Determine if a Rendered Service Path should be Symmetric.
static RenderedServicePath	readRenderedServicePath(RspName rspName) This function reads a RSP from the datastore.
static RenderedServicePathFirstHop	readRenderedServicePathFirstHop(RspName rspName) This method provides all necessary information for a system to construct a NSH header and associated overlay packet to target the first service hop of a Rendered Service Path.
static RenderedServicePathFirstHop	readRspFirstHopBySftList(Class<? extends ServiceFunctionSchedulerTypeIdentity> serviceFunctionSchedulerType, List<SftTypeName> serviceFunctionTypeList) This method gets all necessary information for a system to construct a NSH header and associated overlay packet to target the first service hop of a Rendered Service Path by ServiceFunctionTypeIdentity list.
static boolean	setSymmetricPathId(RenderedServicePath renderedServicePath, long pathId) This method gets all necessary information for a system to construct a NSH header and associated overlay packet to target the first service hop of a Rendered Service Path by ServiceFunctionTypeIdentity list.

Methods inherited from class java.lang.Object

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

Method Detail

createRenderedServicePathAndState

public static RenderedServicePath createRenderedServicePathAndState(ServiceFunctionPath createdServiceFunctionPath,
                                                                    CreateRenderedPathInput createRenderedPathInput,
                                                                    @Nullable
                                                                    SfcServiceFunctionSchedulerAPI possibleScheduler)

Creates a RSP and all the associated operational state based on the given service function path and scheduler.

Parameters:

createdServiceFunctionPath - Service Function Path

createRenderedPathInput - CreateRenderedPathInput object

possibleScheduler - SfcServiceFunctionSchedulerAPI object

Returns:

RenderedServicePath Created RSP or null

createRenderedServicePathAndState

public static RenderedServicePath createRenderedServicePathAndState(ServiceFunctionPath createdServiceFunctionPath,
                                                                    CreateRenderedPathInput createRenderedPathInput)

Creates a RSP and all the associated operational state based on the given service function path.

Parameters:

createdServiceFunctionPath - Service Function Path

createRenderedPathInput - CreateRenderedPathInput object

Returns:

RenderedServicePath Created RSP or null

createSymmetricRenderedServicePathAndState

public static RenderedServicePath createSymmetricRenderedServicePathAndState(RenderedServicePath renderedServicePath)

Create a Symmetric Path and all the associated operational state based on the given rendered service path.

Parameters:

renderedServicePath - RSP Object

Returns:

Nothing.

createRenderedServicePathHopList

protected static List<RenderedServicePathHop> createRenderedServicePathHopList(List<SfName> serviceFunctionNameList,
                                                                               List<String> sfgNameList,
                                                                               int startingServiceIndex)

Given a list of Service Functions, create a RenderedServicePath Hop List.

Parameters:

serviceFunctionNameList - List of ServiceFunctions

sfgNameList - List of ServiceFunctionGroups

startingServiceIndex - Starting index

Returns:

List of RenderedServicePathHop

createRenderedServicePathEntry

protected static RenderedServicePath createRenderedServicePathEntry(ServiceFunctionPath serviceFunctionPath,
                                                                    CreateRenderedPathInput createRenderedPathInput,
                                                                    SfcServiceFunctionSchedulerAPI scheduler)

Create a Rendered Path and all the associated operational state based on the given rendered service path and scheduler.

Parameters:

serviceFunctionPath - RSP Object

createRenderedPathInput - CreateRenderedPathInput object

scheduler - SfcServiceFunctionSchedulerAPI object

Returns:

RenderedServicePath

createReverseRenderedServicePathEntry

public static RenderedServicePath createReverseRenderedServicePathEntry(RenderedServicePath renderedServicePath)

Creates a RSP that is mirror image of the given one. It reverses the hop list and adjusts hop number and service index accordingly.

Parameters:

renderedServicePath - RSP object

Returns:

Nothing

generateReversedPathName

public static RspName generateReversedPathName(RspName rspName)

Given the name of an RSP, return its reverse RSP name.

Parameters:

rspName - the RSP name

Returns:

the reverse RSP name

getReversedRspName

public static RspName getReversedRspName(RspName rspName)

It returns the Symmetric RSP Name from a RspName if both exist.

Parameters:

rspName - RspName object with the primary Rendered Service Path Name

Returns:

The Symmetric (Reversed) RSP; null in case the RSP does not exist or if it has not a symmetric Path Id

readRenderedServicePath

public static RenderedServicePath readRenderedServicePath(RspName rspName)

This function reads a RSP from the datastore.

Parameters:

rspName - RSP name

Returns:

Nothing.

deleteRenderedServicePaths

public static boolean deleteRenderedServicePaths(List<RspName> servicePaths)

When a SFF is deleted directly we need to delete all associated SFPs.

Parameters:

servicePaths - SffServicePath object

Returns:

Nothing.

deleteRenderedServicePathsAndStates

public static boolean deleteRenderedServicePathsAndStates(List<RspName> rspNames)

Delete a list of RSPs and associated states.

Parameters:

rspNames - the list of RSP names.

Returns:

true if everything was deleted ok, false otherwise.

deleteRenderedServicePath

public static boolean deleteRenderedServicePath(RspName renderedServicePathName)

This method deletes a RSP from the datastore and frees the Path ID.

Parameters:

renderedServicePathName - RSP name

Returns:

Nothing.

readRenderedServicePathFirstHop

public static RenderedServicePathFirstHop readRenderedServicePathFirstHop(RspName rspName)

This method provides all necessary information for a system to construct a NSH header and associated overlay packet to target the first service hop of a Rendered Service Path.

Parameters:

rspName - RSP name

Returns:

Nothing.

readRspFirstHopBySftList

public static RenderedServicePathFirstHop readRspFirstHopBySftList(Class<? extends ServiceFunctionSchedulerTypeIdentity> serviceFunctionSchedulerType,
                                                                   List<SftTypeName> serviceFunctionTypeList)

This method gets all necessary information for a system to construct a NSH header and associated overlay packet to target the first service hop of a Rendered Service Path by ServiceFunctionTypeIdentity list.

Parameters:

serviceFunctionSchedulerType - schedulertype for the Service Function

serviceFunctionTypeList - ServiceFunctionTypeIdentity list

Returns:

RenderedServicePathFirstHop first hop of the rendered path

setSymmetricPathId

public static boolean setSymmetricPathId(RenderedServicePath renderedServicePath,
                                         long pathId)

This method gets all necessary information for a system to construct a NSH header and associated overlay packet to target the first service hop of a Rendered Service Path by ServiceFunctionTypeIdentity list.

Parameters:

renderedServicePath - RenderedServicePath Object

pathId - Symmetric Path Id

Returns:

true if symmetric path-id was set, otherwise false

isChainSymmetric

public static boolean isChainSymmetric(ServiceFunctionPath sfp,
                                       RenderedServicePath rsp)

Determine if a Rendered Service Path should be Symmetric. The Service Function Path symmetric field, if present, has priority over the SF SF-type bidirectionality fields. First use the SFP symmetric value, if its not present, then use the SF SF-type bidirectionality values by iterating the ServiceFunctions in the RSP Hops to check if there is at least one SF with an SF-Type that has the bidirectionality field set true.

Parameters:

sfp - - used to get the symmetric flag

rsp - - the RSP to iterate over the SFs in the hops

Returns:

True is there the RSP is symmetric, false otherwise.