org.onosproject.vtnrsc

Interface PortPair

All Known Implementing Classes:

DefaultPortPair

public interface PortPair

Abstraction of an entity providing Port Pair information. A port pair represents a service function instance.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PortPair.Builder A port pair builder..

Method Summary

Modifier and Type	Method and Description
String	description() Returns the description of this port pair.
String	egress() Returns the egress port of this port pair.
boolean	exactMatch(PortPair portPair) Returns whether this port pair is an exact match to the port pair given in the argument.
String	ingress() Returns the ingress port of this port pair.
String	name() Returns the description of this port pair.
PortPairId	portPairId() Returns the ID of this port Pair.
TenantId	tenantId() Returns the tenant id of this port pair.

Method Detail

portPairId

PortPairId portPairId()

Returns the ID of this port Pair.

Returns:

the port pair id

tenantId

TenantId tenantId()

Returns the tenant id of this port pair.

Returns:

an tenant id

name

String name()

Returns the description of this port pair.

Returns:

description of port pair

description

String description()

Returns the description of this port pair.

Returns:

description of port pair

ingress

String ingress()

Returns the ingress port of this port pair.

Returns:

ingress of port pair

egress

String egress()

Returns the egress port of this port pair.

Returns:

egress of port pair

exactMatch

boolean exactMatch(PortPair portPair)

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

Exact match means the Port port pairs match with the given port pair. It does not consider the port pair id, name and description.

Parameters:

portPair - other port pair to match against

Returns:

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