org.onosproject.vtnrsc

Class DefaultPortChain

java.lang.Object

org.onosproject.vtnrsc.DefaultPortChain

All Implemented Interfaces:

PortChain

public final class DefaultPortChain
extends Object
implements PortChain

Implementation of port chain.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPortChain.Builder Builder class for Port chain.

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.
static DefaultPortChain.Builder	builder() To create an instance of the builder.
static PortChain	create(PortChain newPortChain, PortChain oldPortChain) To create port chain for update with old port chain.
String	description() Returns the description of this port chain.
boolean	equals(Object obj)
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.
int	hashCode()
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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static PortChain create(PortChain newPortChain,
                               PortChain oldPortChain)

To create port chain for update with old port chain.

Parameters:

newPortChain - updated port chain

oldPortChain - old port chain

Returns:

port chain

portChainId

public PortChainId portChainId()

Description copied from interface: PortChain

Returns the ID of this port chain.

Specified by:

portChainId in interface PortChain

Returns:

the port chain id

tenantId

public TenantId tenantId()

Description copied from interface: PortChain

Returns the tenant id of this port chain.

Specified by:

tenantId in interface PortChain

Returns:

the tenant id

name

public String name()

Description copied from interface: PortChain

Returns the name of this port chain.

Specified by:

name in interface PortChain

Returns:

name of port chain

description

public String description()

Description copied from interface: PortChain

Returns the description of this port chain.

Specified by:

description in interface PortChain

Returns:

description of port chain

portPairGroups

public List<PortPairGroupId> portPairGroups()

Description copied from interface: PortChain

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

Specified by:

portPairGroups in interface PortChain

Returns:

list of port pair groups

flowClassifiers

public List<FlowClassifierId> flowClassifiers()

Description copied from interface: PortChain

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

Specified by:

flowClassifiers in interface PortChain

Returns:

list of flow classifiers

oldPortChain

public PortChain oldPortChain()

Description copied from interface: PortChain

Returns the old port chain.

Specified by:

oldPortChain in interface PortChain

Returns:

old port chain

addLoadBalancePath

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

Description copied from interface: PortChain

Adds a new load balanced path.

Specified by:

addLoadBalancePath in interface PortChain

Parameters:

fiveTuple - five tuple from the packet

id - load balance path identifier

path - load balanced path of list of port pairs

addSfcClassifiers

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

Description copied from interface: PortChain

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

Specified by:

addSfcClassifiers in interface PortChain

Parameters:

id - load balance path identifier

classifierList - list of classifier devices

addSfcForwarders

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

Description copied from interface: PortChain

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

Specified by:

addSfcForwarders in interface PortChain

Parameters:

id - load balance path identifier

forwarderList - list of forwarder devices

removeSfcClassifiers

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

Description copied from interface: PortChain

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

Specified by:

removeSfcClassifiers in interface PortChain

Parameters:

id - load balance path identifier

classifierList - list of classifier devices

removeSfcForwarders

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

Description copied from interface: PortChain

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

Specified by:

removeSfcForwarders in interface PortChain

Parameters:

id - load balance path identifier

forwarderList - list of forwarder devices

getSfcClassifiers

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

Description copied from interface: PortChain

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

Specified by:

getSfcClassifiers in interface PortChain

Parameters:

id - load balance path identifier

Returns:

list of classifier devices

getSfcForwarders

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

Description copied from interface: PortChain

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

Specified by:

getSfcForwarders in interface PortChain

Parameters:

id - load balance path identifier

Returns:

list of forwarder devices

getLoadBalanceId

public LoadBalanceId getLoadBalanceId(FiveTuple fiveTuple)

Description copied from interface: PortChain

Returns the load balance id from five tuple.

Specified by:

getLoadBalanceId in interface PortChain

Parameters:

fiveTuple - five tuple from the packet

Returns:

load balance identifier for the given packet

getLoadBalanceIdMapKeys

public Set<FiveTuple> getLoadBalanceIdMapKeys()

Description copied from interface: PortChain

Returns the keys set from load balance id map.

Specified by:

getLoadBalanceIdMapKeys in interface PortChain

Returns:

set of five tuple info

getLoadBalancePathMapKeys

public Set<LoadBalanceId> getLoadBalancePathMapKeys()

Description copied from interface: PortChain

Returns the keys set from load balance path map.

Specified by:

getLoadBalancePathMapKeys in interface PortChain

Returns:

set of load balance id's

getLoadBalancePath

public List<PortPairId> getLoadBalancePath(LoadBalanceId id)

Description copied from interface: PortChain

Returns the load balanced path from load balance Id.

Specified by:

getLoadBalancePath in interface PortChain

Parameters:

id - load balance id.

Returns:

path containing list of port pairs

getLoadBalancePath

public List<PortPairId> getLoadBalancePath(FiveTuple fiveTuple)

Description copied from interface: PortChain

Returns the load balanced path from five tuple.

Specified by:

getLoadBalancePath in interface PortChain

Parameters:

fiveTuple - five tuple from the packet

Returns:

path containing list of port pairs

getLoadBalancePathSize

public int getLoadBalancePathSize()

Description copied from interface: PortChain

Returns the no of load balance paths created.

Specified by:

getLoadBalancePathSize in interface PortChain

Returns:

size of load balanced paths

matchPath

public LoadBalanceId matchPath(List<PortPairId> path)

Description copied from interface: PortChain

Match the given path with existing load balanced paths.

Specified by:

matchPath in interface PortChain

Parameters:

path - load balanced path

Returns:

load balance id if the path matches, null otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

exactMatch

public boolean exactMatch(PortChain portChain)

Description copied from interface: 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.

Specified by:

exactMatch in interface PortChain

Parameters:

portChain - other port chain to match against

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

builder

public static DefaultPortChain.Builder builder()

To create an instance of the builder.

Returns:

instance of builder