org.onosproject.vtnrsc

Interface PortChain

All Known Implementing Classes:

DefaultPortChain

public interface PortChain

Abstraction of an entity providing Port Chain information. A Port Chain (Service Function Path) consists of a set of Neutron ports, to define the sequence of service functions a set of flow classifiers, to specify the classified traffic flows to enter the chain

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PortChain.Builder A port chain builder..

Method Summary

Modifier and Type	Method and Description
void	addLoadBalancePath(FiveTuple fiveTuple, LoadBalanceId id, List<PortPairId> path) Adds a new load balanced path.
void	addSfcClassifiers(LoadBalanceId id, List<org.onosproject.net.DeviceId> classifierList) Adds sfc classifiers to the given load balance id for a port chain.
void	addSfcForwarders(LoadBalanceId id, List<org.onosproject.net.DeviceId> forwarderList) Adds sfc forwarders to the given load balance id for a port chain.
String	description() Returns the description of this port chain.
boolean	exactMatch(PortChain portChain) Returns whether this port chain is an exact match to the port chain given in the argument.
List<FlowClassifierId>	flowClassifiers() Returns the list of flow classifiers associated with this port chain.
LoadBalanceId	getLoadBalanceId(FiveTuple fiveTuple) Returns the load balance id from five tuple.
Set<FiveTuple>	getLoadBalanceIdMapKeys() Returns the keys set from load balance id map.
List<PortPairId>	getLoadBalancePath(FiveTuple fiveTuple) Returns the load balanced path from five tuple.
List<PortPairId>	getLoadBalancePath(LoadBalanceId id) Returns the load balanced path from load balance Id.
Set<LoadBalanceId>	getLoadBalancePathMapKeys() Returns the keys set from load balance path map.
int	getLoadBalancePathSize() Returns the no of load balance paths created.
List<org.onosproject.net.DeviceId>	getSfcClassifiers(LoadBalanceId id) Returns sfc classifiers to the given load balance id for a port chain.
List<org.onosproject.net.DeviceId>	getSfcForwarders(LoadBalanceId id) Returns sfc forwarders to the given load balance id for a port chain.
LoadBalanceId	matchPath(List<PortPairId> path) Match the given path with existing load balanced paths.
String	name() Returns the name of this port chain.
PortChain	oldPortChain() Returns the old port chain.
PortChainId	portChainId() Returns the ID of this port chain.
List<PortPairGroupId>	portPairGroups() Returns the list of port pair groups associated with this port chain.
void	removeSfcClassifiers(LoadBalanceId id, List<org.onosproject.net.DeviceId> classifierList) Removes sfc classifiers to the given load balance id for a port chain.
void	removeSfcForwarders(LoadBalanceId id, List<org.onosproject.net.DeviceId> forwarderList) Removes sfc forwarders to the given load balance id for a port chain.
TenantId	tenantId() Returns the tenant id of this port chain.

Method Detail

portChainId

PortChainId portChainId()

Returns the ID of this port chain.

Returns:

the port chain id

tenantId

TenantId tenantId()

Returns the tenant id of this port chain.

Returns:

the tenant id

name

String name()

Returns the name of this port chain.

Returns:

name of port chain

description

String description()

Returns the description of this port chain.

Returns:

description of port chain

portPairGroups

List<PortPairGroupId> portPairGroups()

Returns the list of port pair groups associated with this port chain.

Returns:

list of port pair groups

flowClassifiers

List<FlowClassifierId> flowClassifiers()

Returns the list of flow classifiers associated with this port chain.

Returns:

list of flow classifiers

oldPortChain

PortChain oldPortChain()

Returns the old port chain.

Returns:

old port chain

addLoadBalancePath

void addLoadBalancePath(FiveTuple fiveTuple,
                        LoadBalanceId id,
                        List<PortPairId> path)

Adds a new load balanced path.

Parameters:

fiveTuple - five tuple from the packet

id - load balance path identifier

path - load balanced path of list of port pairs

addSfcClassifiers

void addSfcClassifiers(LoadBalanceId id,
                       List<org.onosproject.net.DeviceId> classifierList)

Adds sfc classifiers to the given load balance id for a port chain.

Parameters:

id - load balance path identifier

classifierList - list of classifier devices

addSfcForwarders

void addSfcForwarders(LoadBalanceId id,
                      List<org.onosproject.net.DeviceId> forwarderList)

Adds sfc forwarders to the given load balance id for a port chain.

Parameters:

id - load balance path identifier

forwarderList - list of forwarder devices

removeSfcClassifiers

void removeSfcClassifiers(LoadBalanceId id,
                          List<org.onosproject.net.DeviceId> classifierList)

Removes sfc classifiers to the given load balance id for a port chain.

Parameters:

id - load balance path identifier

classifierList - list of classifier devices

removeSfcForwarders

void removeSfcForwarders(LoadBalanceId id,
                         List<org.onosproject.net.DeviceId> forwarderList)

Removes sfc forwarders to the given load balance id for a port chain.

Parameters:

id - load balance path identifier

forwarderList - list of forwarder devices

getSfcClassifiers

List<org.onosproject.net.DeviceId> getSfcClassifiers(LoadBalanceId id)

Returns sfc classifiers to the given load balance id for a port chain.

Parameters:

id - load balance path identifier

Returns:

list of classifier devices

getSfcForwarders

List<org.onosproject.net.DeviceId> getSfcForwarders(LoadBalanceId id)

Returns sfc forwarders to the given load balance id for a port chain.

Parameters:

id - load balance path identifier

Returns:

list of forwarder devices

getLoadBalanceId

LoadBalanceId getLoadBalanceId(FiveTuple fiveTuple)

Returns the load balance id from five tuple.

Parameters:

fiveTuple - five tuple from the packet

Returns:

load balance identifier for the given packet

getLoadBalanceIdMapKeys

Set<FiveTuple> getLoadBalanceIdMapKeys()

Returns the keys set from load balance id map.

Returns:

set of five tuple info

getLoadBalancePathMapKeys

Set<LoadBalanceId> getLoadBalancePathMapKeys()

Returns the keys set from load balance path map.

Returns:

set of load balance id's

getLoadBalancePath

List<PortPairId> getLoadBalancePath(LoadBalanceId id)

Returns the load balanced path from load balance Id.

Parameters:

id - load balance id.

Returns:

path containing list of port pairs

getLoadBalancePath

List<PortPairId> getLoadBalancePath(FiveTuple fiveTuple)

Returns the load balanced path from five tuple.

Parameters:

fiveTuple - five tuple from the packet

Returns:

path containing list of port pairs

getLoadBalancePathSize

int getLoadBalancePathSize()

Returns the no of load balance paths created.

Returns:

size of load balanced paths

matchPath

LoadBalanceId matchPath(List<PortPairId> path)

Match the given path with existing load balanced paths.

Parameters:

path - load balanced path

Returns:

load balance id if the path matches, null otherwise.

exactMatch

boolean exactMatch(PortChain portChain)

Returns whether this port chain is an exact match to the port chain given in the argument.

Exact match means the port pair groups and flow classifiers match with the given port chain. It does not consider the port chain id, name and description.

Parameters:

portChain - other port chain to match against

Returns:

true if the port chains are an exact match, otherwise false