com.hp.sdn.dvc.facet

Interface FlowModFacet

All Superinterfaces:

Facet

public interface FlowModFacet
extends Facet

A generic Facet that provides adjustment of flow mods based on specific device information.

Author:

Julie Britt

Method Summary

Methods

Modifier and Type	Method and Description
Set<OfmFlowMod>	adjustFlowMod(OfmFlowMod flow) Adjusts the given FlowMod based on the table properties of this device.
Set<OfmFlowMod>	generateDefaultFlows() Create a set of default flows for a particular device.
ProtocolVersion	getVersion() Return the protocol version registered with the facet.
void	setTableProperties(PipelineDefinition tableProps, ProtocolVersion pv, boolean isHybrid) Sets the Pipeline Definition from which the facet will retrieve information about the table properties on the device for which the flow mods are being generated.

Methods inherited from interface com.hp.device.Facet

getContext, getTypeName

Method Detail

setTableProperties

void setTableProperties(PipelineDefinition tableProps,
                      ProtocolVersion pv,
                      boolean isHybrid)

Sets the Pipeline Definition from which the facet will retrieve information about the table properties on the device for which the flow mods are being generated.

Parameters:

tableProps - specifying capabilities of the device

pv - indicates the Openflow version running on the device

isHybrid - indicates whether the controller is in hybrid mode

getVersion

ProtocolVersion getVersion()

Return the protocol version registered with the facet.

Returns:

protocol version if set, null otherwise

adjustFlowMod

Set<OfmFlowMod> adjustFlowMod(OfmFlowMod flow)

Adjusts the given FlowMod based on the table properties of this device. This entails adjusting the FlowMod as per the capabilities of the device. Modifications will be documented in the Flare SDK documentation. This method returns the proper FlowMod or FlowMods that should be sent. Decision rests with the caller to actually send the adjusted flows. In general, the code will determine if the flow can be put in any table as is. If so, it will put the flow into that table. If that table is a software table, it will additionally put a goto flow in a hardware table that modifies the match statements to be more generic and points to the software table for just that match. If no table can be identified to support the flow as is, modifications will need to be made to the flow on a device-specific basis.

Parameters:

flow - the FlowMod object to be sent

Returns:

Set of flow mods that should be sent to the device to accomplish the intended flow mod action(s) within the parameters of the device's supported tables

Throws:

FlowUnsupportedException - if it is an unsupported flow

DuplicateFlowException - if it is a duplicate of a default flow

generateDefaultFlows

Set<OfmFlowMod> generateDefaultFlows()

Create a set of default flows for a particular device. These flows will be created with inherent knowledge about what the device supports and some information about its current configuration.

Returns:

Set of flows that need to be pushed to the device upon registration with the controller

Throws:

FlowUnsupportedException - if default flow cannot be handled