org.opendaylight.sfc.provider.api

Class SfcProviderServiceFunctionAPI

java.lang.Object

org.opendaylight.sfc.provider.api.SfcProviderServiceFunctionAPI

public final class SfcProviderServiceFunctionAPI
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	addPathToServiceFunctionState(RenderedServicePath renderedServicePath) This method adds a RSP name to the corresponding SF operational state.
static boolean	deleteRspFromServiceFunctionState(RspName rspName) This method removes the given Rendered Service Path from the all SF operational states that use it.
static boolean	deleteServiceFunctionState(SfName serviceFunctionName) This method deletes the operational state for a service function.
static boolean	deleteServicePathFromServiceFunctionState(List<RspName> rspNames) Delete the given list of RSP from the SFF operational state.
static boolean	deleteServicePathFromServiceFunctionState(SfpName sfpName) This method removes the given Service Path from the all SF operational states that use it.
static List<RspName>	getRspsBySfName(SfName serviceFunctionName) This method reads the operational state for a service function.
static boolean	mergeServiceFunctionState(ServiceFunctionState sfState)
static boolean	putServiceFunction(ServiceFunction sf) This method puts a SF to data store.
static boolean	putServiceFunctionState(ServiceFunctionState sfState) Add ServiceFunctionState to datastore.
static ServiceFunctions	readAllServiceFunctions()
static ServiceFunction	readServiceFunction(SfName serviceFunctionName) This method reads a SF from the datastore.
static SfcSfDescMon	readServiceFunctionDescriptionMonitor(SfName serviceFunctionName) This method reads the operational state for a service function.
static List<SfServicePath>	readServiceFunctionState(SfName serviceFunctionName) This method reads the operational state for a service function.

Methods inherited from class java.lang.Object

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

Method Detail

readServiceFunctionState

public static List<SfServicePath> readServiceFunctionState(SfName serviceFunctionName)

This method reads the operational state for a service function.

Parameters:

serviceFunctionName - SF name

Returns:

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

getRspsBySfName

public static List<RspName> getRspsBySfName(SfName serviceFunctionName)

This method reads the operational state for a service function.

Parameters:

serviceFunctionName - SF name

Returns:

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

readServiceFunctionDescriptionMonitor

public static SfcSfDescMon readServiceFunctionDescriptionMonitor(SfName serviceFunctionName)

This method reads the operational state for a service function.

Parameters:

serviceFunctionName - SF name

Returns:

service function description and monitor information null otherwise

deleteServiceFunctionState

public static boolean deleteServiceFunctionState(SfName serviceFunctionName)

This method deletes the operational state for a service function.

Parameters:

serviceFunctionName - SF name

Returns:

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

addPathToServiceFunctionState

public static boolean addPathToServiceFunctionState(RenderedServicePath renderedServicePath)

This method adds a RSP name to the corresponding SF operational state.

Parameters:

renderedServicePath - RSP object

Returns:

true if SFP was added, false otherwise

putServiceFunction

public static boolean putServiceFunction(ServiceFunction sf)

This method puts a SF to data store.

Parameters:

sf - Service Function

Returns:

true if SF was added, false otherwise

putServiceFunctionState

public static boolean putServiceFunctionState(ServiceFunctionState sfState)

Add ServiceFunctionState to datastore.

Parameters:

sfState - ServiceFunctionState Object

Returns:

true if state was added, false otherwise

mergeServiceFunctionState

public static boolean mergeServiceFunctionState(ServiceFunctionState sfState)

readServiceFunction

public static ServiceFunction readServiceFunction(SfName serviceFunctionName)

This method reads a SF from the datastore.

Parameters:

serviceFunctionName - SF name

Returns:

SF object or null if not found

readAllServiceFunctions

public static ServiceFunctions readAllServiceFunctions()

deleteServicePathFromServiceFunctionState

public static boolean deleteServicePathFromServiceFunctionState(SfpName sfpName)

This method removes the given Service Path from the all SF operational states that use it. It assumes that the associated Rendered Service Path has not been deleted yet since it reads it in order to have access to all SFs that are used by this RSP.

Parameters:

sfpName - SFP name

Returns:

true if SF was deleted, false otherwise

deleteServicePathFromServiceFunctionState

public static boolean deleteServicePathFromServiceFunctionState(List<RspName> rspNames)

Delete the given list of RSP from the SFF operational state.

Parameters:

rspNames - list of RSP names.

Returns:

True if everything went ok, false otherwise.

deleteRspFromServiceFunctionState

public static boolean deleteRspFromServiceFunctionState(RspName rspName)

This method removes the given Rendered Service Path from the all SF operational states that use it. It assumes that the associated Rendered Service Path has not been deleted yet since it reads it in order to have access to all SFs that are used by this RSP.

Parameters:

rspName - Rendered Service Path name

Returns:

true if RSP was deleted, false otherwise