org.onosproject.pce.pceservice.api

Interface PceService

All Known Implementing Classes:

PceManager

public interface PceService

Service to compute path based on constraints, release path, update path with new constraints and query existing tunnels.

Method Summary

Modifier and Type	Method and Description
List<ExplicitPathInfo>	explicitPathInfoList(String tunnelName) Returns list of explicit path info.
Iterable<Tunnel>	queryAllPath() Queries all paths.
Tunnel	queryPath(TunnelId tunnelId) Queries particular path based on tunnel identifier.
boolean	releasePath(TunnelId tunnelId) Releases an existing path.
boolean	setupPath(DeviceId src, DeviceId dst, String tunnelName, List<Constraint> constraints, LspType lspType) Creates new path based on constraints and LSP type.
boolean	setupPath(DeviceId src, DeviceId dst, String tunnelName, List<Constraint> constraints, LspType lspType, List<ExplicitPathInfo> explicitPathInfo) Creates new path based on constraints and LSP type.
boolean	updatePath(TunnelId tunnelId, List<Constraint> constraints) Updates an existing path.

Method Detail

setupPath

boolean setupPath(DeviceId src,
                  DeviceId dst,
                  String tunnelName,
                  List<Constraint> constraints,
                  LspType lspType)

Creates new path based on constraints and LSP type.

Parameters:

src - source device

dst - destination device

tunnelName - name of the tunnel

constraints - list of constraints to be applied on path

lspType - type of path to be setup

Returns:

false on failure and true on successful path creation

setupPath

boolean setupPath(DeviceId src,
                  DeviceId dst,
                  String tunnelName,
                  List<Constraint> constraints,
                  LspType lspType,
                  List<ExplicitPathInfo> explicitPathInfo)

Creates new path based on constraints and LSP type.

Parameters:

src - source device

dst - destination device

tunnelName - name of the tunnel

constraints - list of constraints to be applied on path

lspType - type of path to be setup

explicitPathInfo - list of explicit path info

Returns:

false on failure and true on successful path creation

updatePath

boolean updatePath(TunnelId tunnelId,
                   List<Constraint> constraints)

Updates an existing path.

Parameters:

tunnelId - tunnel identifier

constraints - list of constraints to be applied on path

Returns:

false on failure and true on successful path update

releasePath

boolean releasePath(TunnelId tunnelId)

Releases an existing path.

Parameters:

tunnelId - tunnel identifier

Returns:

false on failure and true on successful path removal

queryAllPath

Iterable<Tunnel> queryAllPath()

Queries all paths.

Returns:

iterable of existing tunnels

queryPath

Tunnel queryPath(TunnelId tunnelId)

Queries particular path based on tunnel identifier.

Parameters:

tunnelId - tunnel identifier

Returns:

tunnel if path exists, otherwise null

explicitPathInfoList

List<ExplicitPathInfo> explicitPathInfoList(String tunnelName)

Returns list of explicit path info.

Parameters:

tunnelName - tunnel name

Returns:

list of explicit path info