org.onosproject.net.flow

Class DefaultTrafficSelector.Builder

java.lang.Object

org.onosproject.net.flow.DefaultTrafficSelector.Builder

All Implemented Interfaces:

TrafficSelector.Builder

Enclosing class:

DefaultTrafficSelector

public static final class DefaultTrafficSelector.Builder
extends Object
implements TrafficSelector.Builder

Builder of traffic selector entities.

Method Summary

Modifier and Type	Method and Description
DefaultTrafficSelector.Builder	add(Criterion criterion) Adds a traffic selection criterion.
TrafficSelector	build() Builds an immutable traffic selector.
DefaultTrafficSelector.Builder	matchEthDst(org.onlab.packet.MacAddress addr) Matches a l2 dst address.
DefaultTrafficSelector.Builder	matchEthSrc(org.onlab.packet.MacAddress addr) Matches a l2 src address.
DefaultTrafficSelector.Builder	matchEthType(short ethType) Matches the ethernet type.
DefaultTrafficSelector.Builder	matchInport(PortNumber port) Matches an inport.
DefaultTrafficSelector.Builder	matchIPDst(org.onlab.packet.IpPrefix ip) Matches a l3 address.
DefaultTrafficSelector.Builder	matchIPProtocol(Byte proto) Matches the l3 protocol.
DefaultTrafficSelector.Builder	matchIPSrc(org.onlab.packet.IpPrefix ip) Matches a l3 address.
DefaultTrafficSelector.Builder	matchLambda(Short lambda) Matches an optical signal ID or lambda.
DefaultTrafficSelector.Builder	matchMplsLabel(Integer mplsLabel) Matches on a MPLS label .
DefaultTrafficSelector.Builder	matchOpticalSignalType(Short signalType) Matches an optical Signal Type.
DefaultTrafficSelector.Builder	matchTcpDst(Short tcpPort) Matches a TCP destination port number.
DefaultTrafficSelector.Builder	matchTcpSrc(Short tcpPort) Matches a TCP source port number.
DefaultTrafficSelector.Builder	matchVlanId(org.onlab.packet.VlanId vlanId) Matches the vlan id.
DefaultTrafficSelector.Builder	matchVlanPcp(Byte vlanPcp) Matches a vlan priority.

Methods inherited from class java.lang.Object

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

Method Detail

add

public DefaultTrafficSelector.Builder add(Criterion criterion)

Description copied from interface: TrafficSelector.Builder

Adds a traffic selection criterion. If a same type criterion has already been added, it will be replaced by this one.

Specified by:

add in interface TrafficSelector.Builder

Parameters:

criterion - new criterion

Returns:

self

matchInport

public DefaultTrafficSelector.Builder matchInport(PortNumber port)

Description copied from interface: TrafficSelector.Builder

Matches an inport.

Specified by:

matchInport in interface TrafficSelector.Builder

Parameters:

port - the inport

Returns:

a selection builder

matchEthSrc

public DefaultTrafficSelector.Builder matchEthSrc(org.onlab.packet.MacAddress addr)

Description copied from interface: TrafficSelector.Builder

Matches a l2 src address.

Specified by:

matchEthSrc in interface TrafficSelector.Builder

Parameters:

addr - a l2 address

Returns:

a selection builder

matchEthDst

public DefaultTrafficSelector.Builder matchEthDst(org.onlab.packet.MacAddress addr)

Description copied from interface: TrafficSelector.Builder

Matches a l2 dst address.

Specified by:

matchEthDst in interface TrafficSelector.Builder

Parameters:

addr - a l2 address

Returns:

a selection builder

matchEthType

public DefaultTrafficSelector.Builder matchEthType(short ethType)

Description copied from interface: TrafficSelector.Builder

Matches the ethernet type.

Specified by:

matchEthType in interface TrafficSelector.Builder

Parameters:

ethType - an ethernet type

Returns:

a selection builder

matchVlanId

public DefaultTrafficSelector.Builder matchVlanId(org.onlab.packet.VlanId vlanId)

Description copied from interface: TrafficSelector.Builder

Matches the vlan id.

Specified by:

matchVlanId in interface TrafficSelector.Builder

Parameters:

vlanId - a vlan id

Returns:

a selection builder

matchVlanPcp

public DefaultTrafficSelector.Builder matchVlanPcp(Byte vlanPcp)

Description copied from interface: TrafficSelector.Builder

Matches a vlan priority.

Specified by:

matchVlanPcp in interface TrafficSelector.Builder

Parameters:

vlanPcp - a vlan priority

Returns:

a selection builder

matchIPProtocol

public DefaultTrafficSelector.Builder matchIPProtocol(Byte proto)

Description copied from interface: TrafficSelector.Builder

Matches the l3 protocol.

Specified by:

matchIPProtocol in interface TrafficSelector.Builder

Parameters:

proto - a l3 protocol

Returns:

a selection builder

matchIPSrc

public DefaultTrafficSelector.Builder matchIPSrc(org.onlab.packet.IpPrefix ip)

Description copied from interface: TrafficSelector.Builder

Matches a l3 address.

Specified by:

matchIPSrc in interface TrafficSelector.Builder

Parameters:

ip - a l3 address

Returns:

a selection builder

matchIPDst

public DefaultTrafficSelector.Builder matchIPDst(org.onlab.packet.IpPrefix ip)

Description copied from interface: TrafficSelector.Builder

Matches a l3 address.

Specified by:

matchIPDst in interface TrafficSelector.Builder

Parameters:

ip - a l3 address

Returns:

a selection builder

matchTcpSrc

public DefaultTrafficSelector.Builder matchTcpSrc(Short tcpPort)

Description copied from interface: TrafficSelector.Builder

Matches a TCP source port number.

Specified by:

matchTcpSrc in interface TrafficSelector.Builder

Parameters:

tcpPort - a TCP source port number

Returns:

a selection builder

matchTcpDst

public DefaultTrafficSelector.Builder matchTcpDst(Short tcpPort)

Description copied from interface: TrafficSelector.Builder

Matches a TCP destination port number.

Specified by:

matchTcpDst in interface TrafficSelector.Builder

Parameters:

tcpPort - a TCP destination port number

Returns:

a selection builder

matchMplsLabel

public DefaultTrafficSelector.Builder matchMplsLabel(Integer mplsLabel)

Description copied from interface: TrafficSelector.Builder

Matches on a MPLS label .

Specified by:

matchMplsLabel in interface TrafficSelector.Builder

Parameters:

mplsLabel - a MPLS label.

Returns:

a selection builder

matchLambda

public DefaultTrafficSelector.Builder matchLambda(Short lambda)

Description copied from interface: TrafficSelector.Builder

Matches an optical signal ID or lambda.

Specified by:

matchLambda in interface TrafficSelector.Builder

Parameters:

lambda - lamda

Returns:

a selection builder

matchOpticalSignalType

public DefaultTrafficSelector.Builder matchOpticalSignalType(Short signalType)

Description copied from interface: TrafficSelector.Builder

Matches an optical Signal Type.

Specified by:

matchOpticalSignalType in interface TrafficSelector.Builder

Parameters:

signalType - signalType

Returns:

a selection builder

build

public TrafficSelector build()

Description copied from interface: TrafficSelector.Builder

Builds an immutable traffic selector.

Specified by:

build in interface TrafficSelector.Builder

Returns:

traffic selector