org.onosproject.pcelabelstore.api

Interface PceLabelStore

All Known Implementing Classes:

DistributedPceLabelStore

public interface PceLabelStore

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

Method Summary

Modifier and Type	Method and Description
void	addAdjLabel(org.onosproject.net.Link link, LabelResourceId labelId) Stores adjacency label into adjacency label store.
void	addGlobalNodeLabel(org.onosproject.net.DeviceId deviceId, LabelResourceId labelId) Stores node label into global node label store.
boolean	addLsrIdDevice(String lsrId, org.onosproject.net.DeviceId deviceId) Adds lsrid to device id mapping.
boolean	addPccLsr(org.onosproject.net.DeviceId lsrId) Adds lsrId of the PCC in form of device id for the PCC for which sync is pending due to non-availability of BGP.
void	addTunnelInfo(TunnelId tunnelId, List<LspLocalLabelInfo> lspLocalLabelInfoList) Stores local label info with tunnel consumer id into tunnel info store for specified tunnel id.
boolean	existsAdjLabel(org.onosproject.net.Link link) Checks whether link is present in adjacency label store.
boolean	existsGlobalNodeLabel(org.onosproject.net.DeviceId id) Checks whether device id is present in global node label store.
boolean	existsTunnelInfo(TunnelId tunnelId) Checks whether tunnel id is present in tunnel info store.
LabelResourceId	getAdjLabel(org.onosproject.net.Link link) Retrieves adjacency label for specified link.
int	getAdjLabelCount() Retrieves the adjacency label count.
Map<org.onosproject.net.Link,LabelResourceId>	getAdjLabels() Retrieves link and label pairs collection from adjacency label store.
LabelResourceId	getGlobalNodeLabel(org.onosproject.net.DeviceId id) Retrieves node label for specified device id.
int	getGlobalNodeLabelCount() Retrieves the node label count.
Map<org.onosproject.net.DeviceId,LabelResourceId>	getGlobalNodeLabels() Retrieves device id and label pairs collection from global node label store.
org.onosproject.net.DeviceId	getLsrIdDevice(String lsrId) Gets lsrid to device id mapping.
List<LspLocalLabelInfo>	getTunnelInfo(TunnelId tunnelId) Retrieves local label info with tunnel consumer id from tunnel info store.
int	getTunnelInfoCount() Retrieves the tunnel info count.
Map<TunnelId,List<LspLocalLabelInfo>>	getTunnelInfos() Retrieves tunnel id and pcecc tunnel info pairs collection from tunnel info store.
boolean	hasPccLsr(org.onosproject.net.DeviceId lsrId) Gets lsrId of the PCC in form of device id.
boolean	removeAdjLabel(org.onosproject.net.Link link) Removes adjacency label from adjacency label store for specified link information.
boolean	removeGlobalNodeLabel(org.onosproject.net.DeviceId id) Removes device label from global node label store for specified device id.
boolean	removeLsrIdDevice(String lsrId) Removes lsrid to device id mapping.
boolean	removePccLsr(org.onosproject.net.DeviceId lsrId) Removes lsrId of the PCC in form of device id for the PCC for which pending sync is done.
boolean	removeTunnelInfo(TunnelId tunnelId) Removes local label info with tunnel consumer id from tunnel info store for specified tunnel id.

Method Detail

existsGlobalNodeLabel

boolean existsGlobalNodeLabel(org.onosproject.net.DeviceId id)

Checks whether device id is present in global node label store.

Parameters:

id - device id

Returns:

success of failure

existsAdjLabel

boolean existsAdjLabel(org.onosproject.net.Link link)

Checks whether link is present in adjacency label store.

Parameters:

link - link between devices

Returns:

success of failure

existsTunnelInfo

boolean existsTunnelInfo(TunnelId tunnelId)

Checks whether tunnel id is present in tunnel info store.

Parameters:

tunnelId - tunnel id

Returns:

success of failure

getGlobalNodeLabelCount

int getGlobalNodeLabelCount()

Retrieves the node label count.

Returns:

node label count

getAdjLabelCount

int getAdjLabelCount()

Retrieves the adjacency label count.

Returns:

adjacency label count

getTunnelInfoCount

int getTunnelInfoCount()

Retrieves the tunnel info count.

Returns:

tunnel info count

getGlobalNodeLabels

Map<org.onosproject.net.DeviceId,LabelResourceId> getGlobalNodeLabels()

Retrieves device id and label pairs collection from global node label store.

Returns:

collection of device id and label pairs

getAdjLabels

Map<org.onosproject.net.Link,LabelResourceId> getAdjLabels()

Retrieves link and label pairs collection from adjacency label store.

Returns:

collection of link and label pairs

getTunnelInfos

Map<TunnelId,List<LspLocalLabelInfo>> getTunnelInfos()

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

Returns:

collection of tunnel id and pcecc tunnel info pairs

getGlobalNodeLabel

LabelResourceId getGlobalNodeLabel(org.onosproject.net.DeviceId id)

Retrieves node label for specified device id.

Parameters:

id - device id

Returns:

node label

getAdjLabel

LabelResourceId getAdjLabel(org.onosproject.net.Link link)

Retrieves adjacency label for specified link.

Parameters:

link - between devices

Returns:

adjacency label

getTunnelInfo

List<LspLocalLabelInfo> getTunnelInfo(TunnelId tunnelId)

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

Parameters:

tunnelId - tunnel id

Returns:

pcecc tunnel info

addGlobalNodeLabel

void addGlobalNodeLabel(org.onosproject.net.DeviceId deviceId,
                        LabelResourceId labelId)

Stores node label into global node label store.

Parameters:

deviceId - device id

labelId - node label id

addAdjLabel

void addAdjLabel(org.onosproject.net.Link link,
                 LabelResourceId labelId)

Stores adjacency label into adjacency label store.

Parameters:

link - link between nodes

labelId - link label id

addTunnelInfo

void addTunnelInfo(TunnelId tunnelId,
                   List<LspLocalLabelInfo> lspLocalLabelInfoList)

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

Parameters:

tunnelId - tunnel id

lspLocalLabelInfoList - local label info

removeGlobalNodeLabel

boolean removeGlobalNodeLabel(org.onosproject.net.DeviceId id)

Removes device label from global node label store for specified device id.

Parameters:

id - device id

Returns:

success or failure

removeAdjLabel

boolean removeAdjLabel(org.onosproject.net.Link link)

Removes adjacency label from adjacency label store for specified link information.

Parameters:

link - between nodes

Returns:

success or failure

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

addLsrIdDevice

boolean addLsrIdDevice(String lsrId,
                       org.onosproject.net.DeviceId deviceId)

Adds lsrid to device id mapping.

Parameters:

lsrId - lsrId of the device

deviceId - device id

Returns:

success or failure

removeLsrIdDevice

boolean removeLsrIdDevice(String lsrId)

Removes lsrid to device id mapping.

Parameters:

lsrId - lsrId of the device

Returns:

success or failure

getLsrIdDevice

org.onosproject.net.DeviceId getLsrIdDevice(String lsrId)

Gets lsrid to device id mapping.

Parameters:

lsrId - lsrId of the device

Returns:

device id of the lsrId

addPccLsr

boolean addPccLsr(org.onosproject.net.DeviceId lsrId)

Adds lsrId of the PCC in form of device id for the PCC for which sync is pending due to non-availability of BGP. device.

Parameters:

lsrId - LSR id of the PCC in form of device id

Returns:

success or failure

removePccLsr

boolean removePccLsr(org.onosproject.net.DeviceId lsrId)

Removes lsrId of the PCC in form of device id for the PCC for which pending sync is done.

Parameters:

lsrId - LSR id of the PCC in form of device id

Returns:

success or failure

hasPccLsr

boolean hasPccLsr(org.onosproject.net.DeviceId lsrId)

Gets lsrId of the PCC in form of device id.

Parameters:

lsrId - LSR id of the PCC in form of device id

Returns:

success or failure