org.onosproject.net.flow

Class DefaultFlowRule

java.lang.Object

org.onosproject.net.flow.DefaultFlowRule

All Implemented Interfaces:

FlowRule

Direct Known Subclasses:

DefaultFlowEntry

public class DefaultFlowRule
extends Object
implements FlowRule

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultFlowRule.Builder

Nested classes/interfaces inherited from interface org.onosproject.net.flow.FlowRule

FlowRule.Type

Field Summary

Fields inherited from interface org.onosproject.net.flow.FlowRule

MAX_TIMEOUT, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, ApplicationId appId, GroupId groupId, int timeout, boolean permanent) Deprecated.
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, ApplicationId appId, GroupId groupId, int timeout, boolean permanent, FlowRuleExtPayLoad payLoad) Support for the third party flow rule.
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, ApplicationId appId, int timeout, boolean permanent) Deprecated.
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, ApplicationId appId, int timeout, boolean permanent, FlowRule.Type type) Deprecated.
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, ApplicationId appId, int timeout, boolean permanent, FlowRuleExtPayLoad payLoad) Support for the third party flow rule.
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, long flowId, int timeout, boolean permanent) Deprecated.
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, long flowId, int timeout, boolean permanent, FlowRule.Type tableType) Deprecated.
DefaultFlowRule(FlowRule rule)

Method Summary

Modifier and Type	Method and Description
short	appId() Returns the application id of this flow.
static DefaultFlowRule.Builder	builder()
DeviceId	deviceId() Returns the identity of the device where this rule applies.
boolean	equals(Object obj)
GroupId	groupId() Returns the group id of this flow.
int	hashCode()
FlowId	id() Returns the ID of this flow.
boolean	isPermanent() Returns whether the flow is permanent i.e.
FlowRuleExtPayLoad	payLoad() Returns the third party original flow rule.
int	priority() Returns the flow rule priority given in natural order; higher numbers mean higher priorities.
TrafficSelector	selector() Returns the traffic selector that identifies what traffic this rule should apply to.
int	tableId() Returns the table id for this rule.
int	timeout() Returns the timeout for this flow requested by an application.
String	toString()
TrafficTreatment	treatment() Returns the traffic treatment that applies to selected traffic.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFlowRule

@Deprecated
public DefaultFlowRule(DeviceId deviceId,
                                   TrafficSelector selector,
                                   TrafficTreatment treatment,
                                   int priority,
                                   long flowId,
                                   int timeout,
                                   boolean permanent)

Deprecated.

DefaultFlowRule

@Deprecated
public DefaultFlowRule(DeviceId deviceId,
                                   TrafficSelector selector,
                                   TrafficTreatment treatment,
                                   int priority,
                                   long flowId,
                                   int timeout,
                                   boolean permanent,
                                   FlowRule.Type tableType)

Deprecated.

DefaultFlowRule

@Deprecated
public DefaultFlowRule(DeviceId deviceId,
                                   TrafficSelector selector,
                                   TrafficTreatment treatment,
                                   int priority,
                                   ApplicationId appId,
                                   int timeout,
                                   boolean permanent)

Deprecated.

DefaultFlowRule

@Deprecated
public DefaultFlowRule(DeviceId deviceId,
                                   TrafficSelector selector,
                                   TrafficTreatment treatment,
                                   int priority,
                                   ApplicationId appId,
                                   int timeout,
                                   boolean permanent,
                                   FlowRule.Type type)

Deprecated.

DefaultFlowRule

@Deprecated
public DefaultFlowRule(DeviceId deviceId,
                                   TrafficSelector selector,
                                   TrafficTreatment treatment,
                                   int priority,
                                   ApplicationId appId,
                                   GroupId groupId,
                                   int timeout,
                                   boolean permanent)

Deprecated.

DefaultFlowRule

public DefaultFlowRule(FlowRule rule)

DefaultFlowRule

public DefaultFlowRule(DeviceId deviceId,
                       TrafficSelector selector,
                       TrafficTreatment treatment,
                       int priority,
                       ApplicationId appId,
                       int timeout,
                       boolean permanent,
                       FlowRuleExtPayLoad payLoad)

Support for the third party flow rule. Creates a flow rule of flow table.

Parameters:

deviceId - the identity of the device where this rule applies

selector - the traffic selector that identifies what traffic this rule

treatment - the traffic treatment that applies to selected traffic

priority - the flow rule priority given in natural order

appId - the application id of this flow

timeout - the timeout for this flow requested by an application

permanent - whether the flow is permanent i.e. does not time out

payLoad - 3rd-party origin private flow

DefaultFlowRule

public DefaultFlowRule(DeviceId deviceId,
                       TrafficSelector selector,
                       TrafficTreatment treatment,
                       int priority,
                       ApplicationId appId,
                       GroupId groupId,
                       int timeout,
                       boolean permanent,
                       FlowRuleExtPayLoad payLoad)

Support for the third party flow rule. Creates a flow rule of group table.

Parameters:

deviceId - the identity of the device where this rule applies

selector - the traffic selector that identifies what traffic this rule

treatment - the traffic treatment that applies to selected traffic

priority - the flow rule priority given in natural order

appId - the application id of this flow

groupId - the group id of this flow

timeout - the timeout for this flow requested by an application

permanent - whether the flow is permanent i.e. does not time out

payLoad - 3rd-party origin private flow

Method Detail

id

public FlowId id()

Description copied from interface: FlowRule

Returns the ID of this flow.

Specified by:

id in interface FlowRule

Returns:

the flow ID

appId

public short appId()

Description copied from interface: FlowRule

Returns the application id of this flow.

Specified by:

appId in interface FlowRule

Returns:

an applicationId

groupId

public GroupId groupId()

Description copied from interface: FlowRule

Returns the group id of this flow.

Specified by:

groupId in interface FlowRule

Returns:

an groupId

priority

public int priority()

Description copied from interface: FlowRule

Returns the flow rule priority given in natural order; higher numbers mean higher priorities.

Specified by:

priority in interface FlowRule

Returns:

flow rule priority

deviceId

public DeviceId deviceId()

Description copied from interface: FlowRule

Returns the identity of the device where this rule applies.

Specified by:

deviceId in interface FlowRule

Returns:

device identifier

selector

public TrafficSelector selector()

Description copied from interface: FlowRule

Returns the traffic selector that identifies what traffic this rule should apply to.

Specified by:

selector in interface FlowRule

Returns:

traffic selector

treatment

public TrafficTreatment treatment()

Description copied from interface: FlowRule

Returns the traffic treatment that applies to selected traffic.

Specified by:

treatment in interface FlowRule

Returns:

traffic treatment

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

timeout

public int timeout()

Description copied from interface: FlowRule

Returns the timeout for this flow requested by an application.

Specified by:

timeout in interface FlowRule

Returns:

integer value of the timeout

isPermanent

public boolean isPermanent()

Description copied from interface: FlowRule

Returns whether the flow is permanent i.e. does not time out.

Specified by:

isPermanent in interface FlowRule

Returns:

true if the flow is permanent, otherwise false

tableId

public int tableId()

Description copied from interface: FlowRule

Returns the table id for this rule.

Specified by:

tableId in interface FlowRule

Returns:

an integer.

builder

public static DefaultFlowRule.Builder builder()

payLoad

public FlowRuleExtPayLoad payLoad()

Description copied from interface: FlowRule

Returns the third party original flow rule.

Specified by:

payLoad in interface FlowRule

Returns:

FlowRuleExtPayLoad