org.opendaylight.sfc.provider.api

Class SfcServicePathId

java.lang.Object

org.opendaylight.sfc.provider.api.SfcServicePathId

public final class SfcServicePathId
extends Object

This class has the APIs to operate on the Service PathIds.

Since:

2015-08-09

Version:

0.1

Author:

Reinaldo Penno (rapenno@gmail.com)

Method Summary

Modifier and Type	Method and Description
static boolean	allocatePathId(long pathid) Allocate Pathid.
static long	chechAndAllocatePathId(long pathid) Check and allocate Pathid if available.
static long	checkAndAllocatePathId() Generate pathid, check and allocate if available.
static long	checkAndAllocateSymmetricPathId(long pathid) Check and allocate symmetric Pathid if available.
static boolean	checkSuitablePathId(long pathid) Check if Pathid is available.
static boolean	freePathId(long pathid) Free Pathid.
static int	generatePathIdRandomIncrements() Algorithm to randomize the generation of pathIds.
static boolean	setGenerationAlgorithm(GenerationAlgorithmEnum genAlgorithm) Set the PathId Generate-algorithm in the data-store.

Methods inherited from class java.lang.Object

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

Method Detail

generatePathIdRandomIncrements

public static int generatePathIdRandomIncrements()

Algorithm to randomize the generation of pathIds. Provides security by making path-id less predictable. Adapted from NAT port allocation algorithm

Returns:

Pathid or error if none available

chechAndAllocatePathId

public static long chechAndAllocatePathId(long pathid)

Check and allocate Pathid if available.

Parameters:

pathid - Candidate Path Id

Returns:

True if allocated, otherwise false.

checkAndAllocateSymmetricPathId

public static long checkAndAllocateSymmetricPathId(long pathid)

Check and allocate symmetric Pathid if available.

Parameters:

pathid - Candidate Path Id

Returns:

True if allocated, otherwise false.

checkAndAllocatePathId

public static long checkAndAllocatePathId()

Generate pathid, check and allocate if available.

Returns:

True if allocated, otherwise false.

checkSuitablePathId

public static boolean checkSuitablePathId(long pathid)

Check if Pathid is available.

Parameters:

pathid - Candidate Path Id

Returns:

True if available, otherwise false.

allocatePathId

public static boolean allocatePathId(long pathid)

Allocate Pathid.

Parameters:

pathid - Path Id to be allocated

Returns:

True if allocated, otherwise false.

freePathId

public static boolean freePathId(long pathid)

Free Pathid.

Parameters:

pathid - Path Id to be freed

Returns:

True if freed, otherwise false.

setGenerationAlgorithm

public static boolean setGenerationAlgorithm(GenerationAlgorithmEnum genAlgorithm)

Set the PathId Generate-algorithm in the data-store.

Parameters:

genAlgorithm - enum string value as taken from service-path-id.yang

Returns:

True if successful, otherwise false