org.onosproject.net.flow.criteria

Class Criteria

java.lang.Object

org.onosproject.net.flow.criteria.Criteria

public final class Criteria
extends Object

Factory class to create various traffic selection criteria.

Method Summary

Modifier and Type	Method and Description
static Criterion	dummy()
static Criterion	matchEthDst(org.onlab.packet.MacAddress mac) Creates a match on ETH_DST field using the specified value.
static Criterion	matchEthSrc(org.onlab.packet.MacAddress mac) Creates a match on ETH_SRC field using the specified value.
static Criterion	matchEthType(int ethType) Creates a match on ETH_TYPE field using the specified value.
static Criterion	matchIcmpCode(short icmpCode) Creates a match on ICMP code field using the specified value.
static Criterion	matchIcmpType(short icmpType) Creates a match on ICMP type field using the specified value.
static Criterion	matchIcmpv6Code(short icmpv6Code) Creates a match on ICMPv6 code field using the specified value.
static Criterion	matchIcmpv6Type(short icmpv6Type) Creates a match on ICMPv6 type field using the specified value.
static Criterion	matchInPhyPort(PortNumber port) Creates a match on IN_PHY_PORT field using the specified value.
static Criterion	matchInPort(PortNumber port) Creates a match on IN_PORT field using the specified value.
static Criterion	matchIPDscp(byte ipDscp) Creates a match on IP DSCP field using the specified value.
static Criterion	matchIPDst(org.onlab.packet.IpPrefix ip) Creates a match on IPv4 destination field using the specified value.
static Criterion	matchIPEcn(byte ipEcn) Creates a match on IP ECN field using the specified value.
static Criterion	matchIPProtocol(short proto) Creates a match on IP proto field using the specified value.
static Criterion	matchIPSrc(org.onlab.packet.IpPrefix ip) Creates a match on IPv4 source field using the specified value.
static Criterion	matchIPv6Dst(org.onlab.packet.IpPrefix ip) Creates a match on IPv6 destination field using the specified value.
static Criterion	matchIPv6ExthdrFlags(int exthdrFlags) Creates a match on IPv6 Extension Header pseudo-field fiags.
static Criterion	matchIPv6FlowLabel(int flowLabel) Creates a match on IPv6 flow label field using the specified value.
static Criterion	matchIPv6NDSourceLinkLayerAddress(org.onlab.packet.MacAddress mac) Creates a match on IPv6 Neighbor Discovery source link-layer address using the specified value.
static Criterion	matchIPv6NDTargetAddress(org.onlab.packet.Ip6Address targetAddress) Creates a match on IPv6 Neighbor Discovery target address using the specified value.
static Criterion	matchIPv6NDTargetLinkLayerAddress(org.onlab.packet.MacAddress mac) Creates a match on IPv6 Neighbor Discovery target link-layer address using the specified value.
static Criterion	matchIPv6Src(org.onlab.packet.IpPrefix ip) Creates a match on IPv6 source field using the specified value.
static Criterion	matchLambda(int lambda) Deprecated. in Cardinal Release. Use matchLambda(Lambda) instead.
static Criterion	matchLambda(Lambda lambda) Creates a match on lambda using the specified value.
static Criterion	matchMetadata(long metadata) Creates a match on METADATA field using the specified value.
static Criterion	matchMplsLabel(org.onlab.packet.MplsLabel mplsLabel) Creates a match on MPLS label.
static Criterion	matchOchSignalType(OchSignalType signalType) Create a match on OCh (Optical Channel) signal type.
static Criterion	matchOpticalSignalType(short sigType) Deprecated.
static Criterion	matchSctpDst(int sctpPort) Creates a match on SCTP destination port field using the specified value.
static Criterion	matchSctpSrc(int sctpPort) Creates a match on SCTP source port field using the specified value.
static Criterion	matchTcpDst(int tcpPort) Creates a match on TCP destination port field using the specified value.
static Criterion	matchTcpSrc(int tcpPort) Creates a match on TCP source port field using the specified value.
static Criterion	matchUdpDst(int udpPort) Creates a match on UDP destination port field using the specified value.
static Criterion	matchUdpSrc(int udpPort) Creates a match on UDP source port field using the specified value.
static Criterion	matchVlanId(org.onlab.packet.VlanId vlanId) Creates a match on VLAN ID field using the specified value.
static Criterion	matchVlanPcp(byte vlanPcp) Creates a match on VLAN PCP field using the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

matchInPort

public static Criterion matchInPort(PortNumber port)

Creates a match on IN_PORT field using the specified value.

Parameters:

port - inport value

Returns:

match criterion

matchInPhyPort

public static Criterion matchInPhyPort(PortNumber port)

Creates a match on IN_PHY_PORT field using the specified value.

Parameters:

port - inport value

Returns:

match criterion

matchMetadata

public static Criterion matchMetadata(long metadata)

Creates a match on METADATA field using the specified value.

Parameters:

metadata - metadata value (64 bits data)

Returns:

match criterion

matchEthDst

public static Criterion matchEthDst(org.onlab.packet.MacAddress mac)

Creates a match on ETH_DST field using the specified value. This value may be a wildcard mask.

Parameters:

mac - MAC address value or wildcard mask

Returns:

match criterion

matchEthSrc

public static Criterion matchEthSrc(org.onlab.packet.MacAddress mac)

Creates a match on ETH_SRC field using the specified value. This value may be a wildcard mask.

Parameters:

mac - MAC address value or wildcard mask

Returns:

match criterion

matchEthType

public static Criterion matchEthType(int ethType)

Creates a match on ETH_TYPE field using the specified value.

Parameters:

ethType - eth type value (16 bits unsigned integer)

Returns:

match criterion

matchVlanId

public static Criterion matchVlanId(org.onlab.packet.VlanId vlanId)

Creates a match on VLAN ID field using the specified value.

Parameters:

vlanId - vlan id value

Returns:

match criterion

matchVlanPcp

public static Criterion matchVlanPcp(byte vlanPcp)

Creates a match on VLAN PCP field using the specified value.

Parameters:

vlanPcp - vlan pcp value (3 bits)

Returns:

match criterion

matchIPDscp

public static Criterion matchIPDscp(byte ipDscp)

Creates a match on IP DSCP field using the specified value.

Parameters:

ipDscp - ip dscp value (6 bits)

Returns:

match criterion

matchIPEcn

public static Criterion matchIPEcn(byte ipEcn)

Creates a match on IP ECN field using the specified value.

Parameters:

ipEcn - ip ecn value (2 bits)

Returns:

match criterion

matchIPProtocol

public static Criterion matchIPProtocol(short proto)

Creates a match on IP proto field using the specified value.

Parameters:

proto - ip protocol value (8 bits unsigned integer)

Returns:

match criterion

matchIPSrc

public static Criterion matchIPSrc(org.onlab.packet.IpPrefix ip)

Creates a match on IPv4 source field using the specified value.

Parameters:

ip - ipv4 source value

Returns:

match criterion

matchIPDst

public static Criterion matchIPDst(org.onlab.packet.IpPrefix ip)

Creates a match on IPv4 destination field using the specified value.

Parameters:

ip - ipv4 source value

Returns:

match criterion

matchTcpSrc

public static Criterion matchTcpSrc(int tcpPort)

Creates a match on TCP source port field using the specified value.

Parameters:

tcpPort - TCP source port (16 bits unsigned integer)

Returns:

match criterion

matchTcpDst

public static Criterion matchTcpDst(int tcpPort)

Creates a match on TCP destination port field using the specified value.

Parameters:

tcpPort - TCP destination port (16 bits unsigned integer)

Returns:

match criterion

matchUdpSrc

public static Criterion matchUdpSrc(int udpPort)

Creates a match on UDP source port field using the specified value.

Parameters:

udpPort - UDP source port (16 bits unsigned integer)

Returns:

match criterion

matchUdpDst

public static Criterion matchUdpDst(int udpPort)

Creates a match on UDP destination port field using the specified value.

Parameters:

udpPort - UDP destination port (16 bits unsigned integer)

Returns:

match criterion

matchSctpSrc

public static Criterion matchSctpSrc(int sctpPort)

Creates a match on SCTP source port field using the specified value.

Parameters:

sctpPort - SCTP source port (16 bits unsigned integer)

Returns:

match criterion

matchSctpDst

public static Criterion matchSctpDst(int sctpPort)

Creates a match on SCTP destination port field using the specified value.

Parameters:

sctpPort - SCTP destination port (16 bits unsigned integer)

Returns:

match criterion

matchIcmpType

public static Criterion matchIcmpType(short icmpType)

Creates a match on ICMP type field using the specified value.

Parameters:

icmpType - ICMP type (8 bits unsigned integer)

Returns:

match criterion

matchIcmpCode

public static Criterion matchIcmpCode(short icmpCode)

Creates a match on ICMP code field using the specified value.

Parameters:

icmpCode - ICMP code (8 bits unsigned integer)

Returns:

match criterion

matchIPv6Src

public static Criterion matchIPv6Src(org.onlab.packet.IpPrefix ip)

Creates a match on IPv6 source field using the specified value.

Parameters:

ip - ipv6 source value

Returns:

match criterion

matchIPv6Dst

public static Criterion matchIPv6Dst(org.onlab.packet.IpPrefix ip)

Creates a match on IPv6 destination field using the specified value.

Parameters:

ip - ipv6 destination value

Returns:

match criterion

matchIPv6FlowLabel

public static Criterion matchIPv6FlowLabel(int flowLabel)

Creates a match on IPv6 flow label field using the specified value.

Parameters:

flowLabel - IPv6 flow label (20 bits)

Returns:

match criterion

matchIcmpv6Type

public static Criterion matchIcmpv6Type(short icmpv6Type)

Creates a match on ICMPv6 type field using the specified value.

Parameters:

icmpv6Type - ICMPv6 type (8 bits unsigned integer)

Returns:

match criterion

matchIcmpv6Code

public static Criterion matchIcmpv6Code(short icmpv6Code)

Creates a match on ICMPv6 code field using the specified value.

Parameters:

icmpv6Code - ICMPv6 code (8 bits unsigned integer)

Returns:

match criterion

matchIPv6NDTargetAddress

public static Criterion matchIPv6NDTargetAddress(org.onlab.packet.Ip6Address targetAddress)

Creates a match on IPv6 Neighbor Discovery target address using the specified value.

Parameters:

targetAddress - IPv6 Neighbor Discovery target address

Returns:

match criterion

matchIPv6NDSourceLinkLayerAddress

public static Criterion matchIPv6NDSourceLinkLayerAddress(org.onlab.packet.MacAddress mac)

Creates a match on IPv6 Neighbor Discovery source link-layer address using the specified value.

Parameters:

mac - IPv6 Neighbor Discovery source link-layer address

Returns:

match criterion

matchIPv6NDTargetLinkLayerAddress

public static Criterion matchIPv6NDTargetLinkLayerAddress(org.onlab.packet.MacAddress mac)

Creates a match on IPv6 Neighbor Discovery target link-layer address using the specified value.

Parameters:

mac - IPv6 Neighbor Discovery target link-layer address

Returns:

match criterion

matchMplsLabel

public static Criterion matchMplsLabel(org.onlab.packet.MplsLabel mplsLabel)

Creates a match on MPLS label.

Parameters:

mplsLabel - MPLS label (20 bits)

Returns:

match criterion

matchIPv6ExthdrFlags

public static Criterion matchIPv6ExthdrFlags(int exthdrFlags)

Creates a match on IPv6 Extension Header pseudo-field fiags. Those are defined in Criterion.IPv6ExthdrFlags.

Parameters:

exthdrFlags - IPv6 Extension Header pseudo-field flags (16 bits)

Returns:

match criterion

matchLambda

@Deprecated
public static Criterion matchLambda(int lambda)

Deprecated. in Cardinal Release. Use matchLambda(Lambda) instead.

Creates a match on lambda field using the specified value.

Parameters:

lambda - lambda to match on (16 bits unsigned integer)

Returns:

match criterion

matchLambda

public static Criterion matchLambda(Lambda lambda)

Creates a match on lambda using the specified value.

Parameters:

lambda - lambda

Returns:

match criterion

matchOpticalSignalType

@Deprecated
public static Criterion matchOpticalSignalType(short sigType)

Deprecated.

Creates a match on optical signal type using the specified value.

Parameters:

sigType - optical signal type (8 bits unsigned integer)

Returns:

match criterion

matchOchSignalType

public static Criterion matchOchSignalType(OchSignalType signalType)

Create a match on OCh (Optical Channel) signal type.

Parameters:

signalType - OCh signal type

Returns:

match criterion

dummy

public static Criterion dummy()