org.onosproject.provider.of.flow.impl

Class FlowModBuilder

java.lang.Object

org.onosproject.provider.of.flow.impl.FlowModBuilder

Direct Known Subclasses:

FlowModBuilderVer10, FlowModBuilderVer13

public abstract class FlowModBuilder
extends Object

Builder for OpenFlow flow mods based on FlowRules.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.net.DeviceId	deviceId
protected Optional<org.onosproject.net.driver.DriverService>	driverService
protected Long	xid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FlowModBuilder(org.onosproject.net.flow.FlowRule flowRule, org.projectfloodlight.openflow.protocol.OFFactory factory, Optional<Long> xid, Optional<org.onosproject.net.driver.DriverService> driverService) Constructs a flow mod builder.

Method Summary

Modifier and Type	Method and Description
static FlowModBuilder	builder(org.onosproject.net.flow.FlowRule flowRule, org.projectfloodlight.openflow.protocol.OFFactory factory, Optional<Long> xid, Optional<org.onosproject.net.driver.DriverService> driverService) Creates a new flow mod builder.
abstract org.projectfloodlight.openflow.protocol.OFFlowMod	buildFlowAdd() Builds an ADD flow mod.
abstract org.projectfloodlight.openflow.protocol.OFFlowMod	buildFlowDel() Builds a DELETE flow mod.
abstract org.projectfloodlight.openflow.protocol.OFFlowMod	buildFlowMod() Builds a MODIFY flow mod.
protected org.projectfloodlight.openflow.protocol.match.Match	buildMatch() Builds the match for the flow mod.
protected org.projectfloodlight.openflow.protocol.OFFactory	factory() Returns the factory used for building OpenFlow constructs.
protected org.onosproject.net.flow.FlowRule	flowRule() Returns the flow rule for this builder.

Methods inherited from class java.lang.Object

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

Field Detail

xid

protected final Long xid

driverService

protected final Optional<org.onosproject.net.driver.DriverService> driverService

deviceId

protected final org.onosproject.net.DeviceId deviceId

Constructor Detail

FlowModBuilder

protected FlowModBuilder(org.onosproject.net.flow.FlowRule flowRule,
                         org.projectfloodlight.openflow.protocol.OFFactory factory,
                         Optional<Long> xid,
                         Optional<org.onosproject.net.driver.DriverService> driverService)

Constructs a flow mod builder.

Parameters:

flowRule - the flow rule to transform into a flow mod

factory - the OpenFlow factory to use to build the flow mod

driverService - the device driver service

xid - the transaction ID

Method Detail

builder

public static FlowModBuilder builder(org.onosproject.net.flow.FlowRule flowRule,
                                     org.projectfloodlight.openflow.protocol.OFFactory factory,
                                     Optional<Long> xid,
                                     Optional<org.onosproject.net.driver.DriverService> driverService)

Creates a new flow mod builder.

Parameters:

flowRule - the flow rule to transform into a flow mod

factory - the OpenFlow factory to use to build the flow mod

xid - the transaction ID

driverService - the device driver service

Returns:

the new flow mod builder

buildFlowAdd

public abstract org.projectfloodlight.openflow.protocol.OFFlowMod buildFlowAdd()

Builds an ADD flow mod.

Returns:

the flow mod

buildFlowMod

public abstract org.projectfloodlight.openflow.protocol.OFFlowMod buildFlowMod()

Builds a MODIFY flow mod.

Returns:

the flow mod

buildFlowDel

public abstract org.projectfloodlight.openflow.protocol.OFFlowMod buildFlowDel()

Builds a DELETE flow mod.

Returns:

the flow mod

buildMatch

protected org.projectfloodlight.openflow.protocol.match.Match buildMatch()

Builds the match for the flow mod.

Returns:

the match

flowRule

protected org.onosproject.net.flow.FlowRule flowRule()

Returns the flow rule for this builder.

Returns:

the flow rule

factory

protected org.projectfloodlight.openflow.protocol.OFFactory factory()

Returns the factory used for building OpenFlow constructs.

Returns:

the factory