org.onosproject.incubator.store.virtual.impl

Class SimpleVirtualFlowRuleStore

java.lang.Object

org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore<org.onosproject.net.flow.FlowRuleBatchEvent,org.onosproject.net.flow.FlowRuleStoreDelegate>

org.onosproject.incubator.store.virtual.impl.SimpleVirtualFlowRuleStore

All Implemented Interfaces:

VirtualNetworkFlowRuleStore, VirtualStore<org.onosproject.net.flow.FlowRuleBatchEvent,org.onosproject.net.flow.FlowRuleStoreDelegate>

@Service
public class SimpleVirtualFlowRuleStore
extends AbstractVirtualStore<org.onosproject.net.flow.FlowRuleBatchEvent,org.onosproject.net.flow.FlowRuleStoreDelegate>
implements VirtualNetworkFlowRuleStore

Implementation of the virtual network flow rule store to manage inventory of virtual flow rules using trivial in-memory implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.store.service.StorageService	storageService

Fields inherited from class org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore

delegateMap

Constructor Summary

Constructors

Constructor and Description
SimpleVirtualFlowRuleStore()

Method Summary

Modifier and Type	Method and Description
void	activate()
org.onosproject.net.flow.FlowRuleEvent	addOrUpdateFlowRule(NetworkId networkId, org.onosproject.net.flow.FlowEntry rule) Stores a new flow rule, or updates an existing entry.
void	batchOperationComplete(NetworkId networkId, org.onosproject.net.flow.FlowRuleBatchEvent event) Invoked on the completion of a storeBatch operation.
void	deactivate()
void	deleteFlowRule(NetworkId networkId, org.onosproject.net.flow.FlowRule rule) Marks a flow rule for deletion.
java.lang.Iterable<org.onosproject.net.flow.FlowEntry>	getFlowEntries(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Returns the flow entries associated with a device.
org.onosproject.net.flow.FlowEntry	getFlowEntry(NetworkId networkId, org.onosproject.net.flow.FlowRule rule) Returns the stored flow.
int	getFlowRuleCount(NetworkId networkId) Returns the number of flow rule in the store.
java.lang.Iterable<org.onosproject.net.flow.TableStatisticsEntry>	getTableStatistics(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Returns the flow table statistics associated with a device.
void	modified(org.osgi.service.component.ComponentContext context)
org.onosproject.net.flow.FlowRuleEvent	pendingFlowRule(NetworkId networkId, org.onosproject.net.flow.FlowEntry rule) Marks a flow rule as PENDING_ADD during retry.
void	purgeFlowRule(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Removes all flow entries of given device from store.
void	purgeFlowRules(NetworkId networkId) Removes all flow entries from store.
org.onosproject.net.flow.FlowRuleEvent	removeFlowRule(NetworkId networkId, org.onosproject.net.flow.FlowEntry rule) Removes an existing flow entry.
void	storeBatch(NetworkId networkId, org.onosproject.net.flow.FlowRuleBatchOperation batchOperation) Stores a batch of flow rules.
org.onosproject.net.flow.FlowRuleEvent	updateTableStatistics(NetworkId networkId, org.onosproject.net.DeviceId deviceId, java.util.List<org.onosproject.net.flow.TableStatisticsEntry> tableStats) Updates the flow table statistics of the specified device using the given statistics.

Methods inherited from class org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore

hasDelegate, notifyDelegate, notifyDelegate, setDelegate, unsetDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.incubator.net.virtual.VirtualStore

hasDelegate, setDelegate, unsetDelegate

Field Detail

storageService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.service.StorageService storageService

Constructor Detail

SimpleVirtualFlowRuleStore

public SimpleVirtualFlowRuleStore()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

modified

@Modified
public void modified(org.osgi.service.component.ComponentContext context)

getFlowRuleCount

public int getFlowRuleCount(NetworkId networkId)

Description copied from interface: VirtualNetworkFlowRuleStore

Returns the number of flow rule in the store.

Specified by:

getFlowRuleCount in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

Returns:

number of flow rules

getFlowEntry

public org.onosproject.net.flow.FlowEntry getFlowEntry(NetworkId networkId,
                                                       org.onosproject.net.flow.FlowRule rule)

Description copied from interface: VirtualNetworkFlowRuleStore

Returns the stored flow.

Specified by:

getFlowEntry in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

rule - the rule to look for

Returns:

a flow rule

getFlowEntries

public java.lang.Iterable<org.onosproject.net.flow.FlowEntry> getFlowEntries(NetworkId networkId,
                                                                             org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkFlowRuleStore

Returns the flow entries associated with a device.

Specified by:

getFlowEntries in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

deviceId - the device ID

Returns:

the flow entries

storeBatch

public void storeBatch(NetworkId networkId,
                       org.onosproject.net.flow.FlowRuleBatchOperation batchOperation)

Description copied from interface: VirtualNetworkFlowRuleStore

Stores a batch of flow rules.

Specified by:

storeBatch in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

batchOperation - batch of flow rules. A batch can contain flow rules for a single device only.

batchOperationComplete

public void batchOperationComplete(NetworkId networkId,
                                   org.onosproject.net.flow.FlowRuleBatchEvent event)

Description copied from interface: VirtualNetworkFlowRuleStore

Invoked on the completion of a storeBatch operation.

Specified by:

batchOperationComplete in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

event - flow rule batch event

deleteFlowRule

public void deleteFlowRule(NetworkId networkId,
                           org.onosproject.net.flow.FlowRule rule)

Description copied from interface: VirtualNetworkFlowRuleStore

Marks a flow rule for deletion. Actual deletion will occur when the provider indicates that the flow has been removed.

Specified by:

deleteFlowRule in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

rule - the flow rule to delete

addOrUpdateFlowRule

public org.onosproject.net.flow.FlowRuleEvent addOrUpdateFlowRule(NetworkId networkId,
                                                                  org.onosproject.net.flow.FlowEntry rule)

Description copied from interface: VirtualNetworkFlowRuleStore

Stores a new flow rule, or updates an existing entry.

Specified by:

addOrUpdateFlowRule in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

rule - the flow rule to add or update

Returns:

flow_added event, or null if just an update

removeFlowRule

public org.onosproject.net.flow.FlowRuleEvent removeFlowRule(NetworkId networkId,
                                                             org.onosproject.net.flow.FlowEntry rule)

Description copied from interface: VirtualNetworkFlowRuleStore

Removes an existing flow entry.

Specified by:

removeFlowRule in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

rule - the flow entry to remove

Returns:

flow_removed event, or null if nothing removed

pendingFlowRule

public org.onosproject.net.flow.FlowRuleEvent pendingFlowRule(NetworkId networkId,
                                                              org.onosproject.net.flow.FlowEntry rule)

Description copied from interface: VirtualNetworkFlowRuleStore

Marks a flow rule as PENDING_ADD during retry. Emits flow_update event if the state is changed

Specified by:

pendingFlowRule in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

rule - the flow rule that is retrying

Returns:

flow_updated event, or null if nothing updated

purgeFlowRule

public void purgeFlowRule(NetworkId networkId,
                          org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkFlowRuleStore

Removes all flow entries of given device from store.

Specified by:

purgeFlowRule in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

deviceId - device id

purgeFlowRules

public void purgeFlowRules(NetworkId networkId)

Description copied from interface: VirtualNetworkFlowRuleStore

Removes all flow entries from store.

Specified by:

purgeFlowRules in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

updateTableStatistics

public org.onosproject.net.flow.FlowRuleEvent updateTableStatistics(NetworkId networkId,
                                                                    org.onosproject.net.DeviceId deviceId,
                                                                    java.util.List<org.onosproject.net.flow.TableStatisticsEntry> tableStats)

Description copied from interface: VirtualNetworkFlowRuleStore

Updates the flow table statistics of the specified device using the given statistics.

Specified by:

updateTableStatistics in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

deviceId - device identifier

tableStats - list of table statistics

Returns:

ready to send event describing what occurred;

getTableStatistics

public java.lang.Iterable<org.onosproject.net.flow.TableStatisticsEntry> getTableStatistics(NetworkId networkId,
                                                                                            org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkFlowRuleStore

Returns the flow table statistics associated with a device.

Specified by:

getTableStatistics in interface VirtualNetworkFlowRuleStore

Parameters:

networkId - virtual network identifier

deviceId - the device ID

Returns:

the flow table statistics