api.flowservice

Class Flow

java.lang.Object

api.flowservice.Flow

All Implemented Interfaces:

FlowInterface

public class Flow
extends java.lang.Object
implements FlowInterface

Represents a flow including a list of match fields and actions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Flow.Builder Builder class to generate a Flow object.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	appId An application ID for a flow rule.
protected java.lang.Integer	cookie Flow rule cookie.
protected java.lang.String	deviceID Flow rule device ID.
protected java.util.List<FlowAction>	flowActions A List of flow actions.
protected java.lang.String	flowID flow rule ID.
protected FlowMatch	flowMatch An object of match fields.
protected boolean	isPermanent
protected java.lang.Integer	priority Priority of a flow.
protected java.lang.Integer	tableID Flow rule table ID.
protected java.lang.Integer	timeOut Flow rule time out.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Flow() Default constructor
protected	Flow(Flow.Builder builder) Constructor based on a builder

Method Summary

Modifier and Type	Method and Description
void	addFlowAction(FlowAction action) Adds a flow action object to a flow rule.
void	addFlowActions(java.util.List<FlowAction> actions) Adds a list of flow actions object to a flow rule.
void	addFlowMatch(FlowMatch match) Adds a flow match object to a flow rule.
static Flow.Builder	builder() Returns a builder object.
java.lang.String	getAppId() Returns the application ID.
java.lang.Integer	getCookie() Returns flow rule cookie.
java.lang.String	getDeviceID() Returns the device ID.
java.util.List<FlowAction>	getFlowActions() Returns the list of flow action objects.
java.lang.String	getFlowID() Returns flow rule ID.
FlowMatch	getFlowMatch() Returns the flow match fields object.
java.lang.Integer	getPriority() Returns the priority.
java.lang.Integer	getTableID() Returns the table ID.
java.lang.Integer	getTimeOut() Returns the flow time out.
boolean	isPermanent() Determine a flow is permenant or not.
void	setFlowID(java.lang.String flowID) Sets flow rule ID.
void	setTableID(int tableID) Sets table ID.

Methods inherited from class java.lang.Object

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

Field Detail

flowMatch

protected FlowMatch flowMatch

An object of match fields.

flowActions

protected java.util.List<FlowAction> flowActions

A List of flow actions.

priority

protected java.lang.Integer priority

Priority of a flow.

tableID

protected java.lang.Integer tableID

Flow rule table ID.

deviceID

protected java.lang.String deviceID

Flow rule device ID.

timeOut

protected java.lang.Integer timeOut

Flow rule time out.

isPermanent

protected boolean isPermanent

cookie

protected java.lang.Integer cookie

Flow rule cookie.

appId

protected java.lang.String appId

An application ID for a flow rule.

flowID

protected java.lang.String flowID

flow rule ID.

Constructor Detail

Flow

protected Flow()

Default constructor

Flow

protected Flow(Flow.Builder builder)

Constructor based on a builder

Parameters:

builder - : Builder object to initialize the flow

Method Detail

builder

public static Flow.Builder builder()

Returns a builder object.

Returns:

Builder object.

isPermanent

public boolean isPermanent()

Determine a flow is permenant or not.

Returns:

a boolean

getPriority

public java.lang.Integer getPriority()

Returns the priority.

Returns:

priority.

getTableID

public java.lang.Integer getTableID()

Returns the table ID.

Returns:

table ID.

setTableID

public void setTableID(int tableID)

Sets table ID.

Parameters:

tableID - flow rule table ID.

getTimeOut

public java.lang.Integer getTimeOut()

Returns the flow time out.

Returns:

time out

getAppId

public java.lang.String getAppId()

Returns the application ID.

Returns:

app ID.

getDeviceID

public java.lang.String getDeviceID()

Returns the device ID.

Returns:

device ID.

getFlowID

public java.lang.String getFlowID()

Returns flow rule ID.

Returns:

flow rule ID.

setFlowID

public void setFlowID(java.lang.String flowID)

Sets flow rule ID.

Parameters:

flowID - flow rule ID.

getCookie

public java.lang.Integer getCookie()

Returns flow rule cookie.

Returns:

flow rule cookie.

getFlowMatch

public FlowMatch getFlowMatch()

Returns the flow match fields object.

Specified by:

getFlowMatch in interface FlowInterface

Returns:

flow match object.

getFlowActions

public java.util.List<FlowAction> getFlowActions()

Returns the list of flow action objects.

Specified by:

getFlowActions in interface FlowInterface

Returns:

flow action objects.

addFlowMatch

public void addFlowMatch(FlowMatch match)

Adds a flow match object to a flow rule.

Specified by:

addFlowMatch in interface FlowInterface

Parameters:

match - match object.

addFlowAction

public void addFlowAction(FlowAction action)

Adds a flow action object to a flow rule.

Specified by:

addFlowAction in interface FlowInterface

Parameters:

action - flow action object.

addFlowActions

public void addFlowActions(java.util.List<FlowAction> actions)

Adds a list of flow actions object to a flow rule.

Specified by:

addFlowActions in interface FlowInterface

Parameters:

actions - a list of flow action objects.