org.onosproject.pce.pcestore.api

Interface PceStore

All Known Implementing Classes:

DistributedPceStore

public interface PceStore

Abstraction of an entity providing pool of available labels to devices, links and tunnels.

Method Summary

Modifier and Type	Method and Description
void	addFailedPathInfo(PcePathInfo failedPathInfo) Stores path information into failed path info store.
void	addTunnelInfo(TunnelId tunnelId, ResourceConsumer tunnelConsumerId) Stores local label info with tunnel consumer id into tunnel info store for specified tunnel id.
boolean	existsFailedPathInfo(PcePathInfo failedPathInfo) Checks whether path info is present in failed path info list.
boolean	existsTunnelInfo(TunnelId tunnelId) Checks whether tunnel id is present in tunnel info store.
int	getFailedPathInfoCount() Retrieves the failed path info count.
Iterable<PcePathInfo>	getFailedPathInfos() Retrieves path info collection from failed path info store.
ResourceConsumer	getTunnelInfo(TunnelId tunnelId) Retrieves local label info with tunnel consumer id from tunnel info store.
int	getTunnelInfoCount() Retrieves the tunnel info count.
Map<TunnelId,ResourceConsumer>	getTunnelInfos() Retrieves tunnel id and pcecc tunnel info pairs collection from tunnel info store.
List<ExplicitPathInfo>	getTunnelNameExplicitPathInfoMap(String tunnelName) Gets explicit path info based on tunnel name.
boolean	removeFailedPathInfo(PcePathInfo failedPathInfo) Removes path info from failed path info store.
boolean	removeTunnelInfo(TunnelId tunnelId) Removes local label info with tunnel consumer id from tunnel info store for specified tunnel id.
boolean	tunnelNameExplicitPathInfoMap(String tunnelName, List<ExplicitPathInfo> explicitPathInfo) Adds explicit path info to the map with corresponding tunnel name.

Method Detail

existsTunnelInfo

boolean existsTunnelInfo(TunnelId tunnelId)

Checks whether tunnel id is present in tunnel info store.

Parameters:

tunnelId - tunnel id

Returns:

success of failure

existsFailedPathInfo

boolean existsFailedPathInfo(PcePathInfo failedPathInfo)

Checks whether path info is present in failed path info list.

Parameters:

failedPathInfo - failed path information

Returns:

success or failure

getTunnelInfoCount

int getTunnelInfoCount()

Retrieves the tunnel info count.

Returns:

tunnel info count

getFailedPathInfoCount

int getFailedPathInfoCount()

Retrieves the failed path info count.

Returns:

failed path info count

getTunnelInfos

Map<TunnelId,ResourceConsumer> getTunnelInfos()

Retrieves tunnel id and pcecc tunnel info pairs collection from tunnel info store.

Returns:

collection of tunnel id and resource consumer pairs

getFailedPathInfos

Iterable<PcePathInfo> getFailedPathInfos()

Retrieves path info collection from failed path info store.

Returns:

collection of failed path info

getTunnelInfo

ResourceConsumer getTunnelInfo(TunnelId tunnelId)

Retrieves local label info with tunnel consumer id from tunnel info store.

Parameters:

tunnelId - tunnel id

Returns:

resource consumer

addTunnelInfo

void addTunnelInfo(TunnelId tunnelId,
                   ResourceConsumer tunnelConsumerId)

Stores local label info with tunnel consumer id into tunnel info store for specified tunnel id.

Parameters:

tunnelId - tunnel id

tunnelConsumerId - tunnel consumer id

addFailedPathInfo

void addFailedPathInfo(PcePathInfo failedPathInfo)

Stores path information into failed path info store.

Parameters:

failedPathInfo - failed path information

removeTunnelInfo

boolean removeTunnelInfo(TunnelId tunnelId)

Removes local label info with tunnel consumer id from tunnel info store for specified tunnel id.

Parameters:

tunnelId - tunnel id

Returns:

success or failure

removeFailedPathInfo

boolean removeFailedPathInfo(PcePathInfo failedPathInfo)

Removes path info from failed path info store.

Parameters:

failedPathInfo - failed path information

Returns:

success or failure

tunnelNameExplicitPathInfoMap

boolean tunnelNameExplicitPathInfoMap(String tunnelName,
                                      List<ExplicitPathInfo> explicitPathInfo)

Adds explicit path info to the map with corresponding tunnel name.

Parameters:

tunnelName - tunnel name as key

explicitPathInfo - list of explicit path objects

Returns:

whether it is added to map

getTunnelNameExplicitPathInfoMap

List<ExplicitPathInfo> getTunnelNameExplicitPathInfoMap(String tunnelName)

Gets explicit path info based on tunnel name.

Parameters:

tunnelName - tunnel name as key

Returns:

list of explicit path info