org.opendaylight.sfc.util.openflow.writer

Class SfcOfFlowWriterImpl

java.lang.Object

org.opendaylight.sfc.util.openflow.writer.SfcOfFlowWriterImpl

All Implemented Interfaces:

SfcOfFlowWriterInterface

public class SfcOfFlowWriterImpl
extends Object
implements SfcOfFlowWriterInterface

Set of instructions in order to interact with MD-SAL datastore.

Since:

2015-11-25

Author:

Brady Johnson (brady.allen.johnson@ericsson.com), Ricardo Noriega (ricardo.noriega.de.soto@ericsson.com), Diego Granados (diego.jesus.granados.lopez@ericsson.com)

Constructor Summary

Constructors

Constructor and Description
SfcOfFlowWriterImpl()
SfcOfFlowWriterImpl(org.opendaylight.controller.md.sal.binding.api.DataBroker theDataBroker)

Method Summary

Modifier and Type	Method and Description
Set<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId>	clearSffsIfNoRspExists() Clear all flows from the SFFs whenever they are not featured in any RSP.
void	deleteFlowSet()
void	deleteRspFlows(Long rspId) Delete all flows created for the given rspId (flows are stored in a deletion buffer; actual transactional deletion is performed when deleteFlowSet() is called.
void	deregisterTransactionListener(Object interestedParty)
void	flushFlows() From previous calls to writeFlowToConfig(), flows were stored per table and per SFF.
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder	getFlowBuilder() Return the last flow builder Used mainly in Unit Testing.
void	injectTransaction(org.opendaylight.controller.md.sal.binding.api.WriteTransaction theTx)
void	purgeFlows() Purge any unwritten flows not written-deleted yet.
void	registerTransactionListener(Object interestedParty)
void	removeFlow(FlowDetails theFlowData)
void	removeFlow(String sffNodeName, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey flowKey, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey tableKey)
boolean	removeFlows(Collection<FlowDetails> theFlows)
void	setDataProvider(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker)
void	shutdown() Shutdown the thread pool.
void	updateTransactionObject() Update the inner transaction object, and notify all transaction listeners through the EventBus.
void	writeFlow(FlowDetails theFlowData)
void	writeFlow(Long rspId, String sffNodeName, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder flow) Store a flow to be written later.
boolean	writeFlows(Collection<FlowDetails> theFlows)
void	writeGroupToDataStore(String sffNodeName, org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder gb, boolean isAdd)

Methods inherited from class java.lang.Object

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

Constructor Detail

SfcOfFlowWriterImpl

public SfcOfFlowWriterImpl()

SfcOfFlowWriterImpl

public SfcOfFlowWriterImpl(org.opendaylight.controller.md.sal.binding.api.DataBroker theDataBroker)

Method Detail

setDataProvider

public void setDataProvider(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker)

injectTransaction

public void injectTransaction(org.opendaylight.controller.md.sal.binding.api.WriteTransaction theTx)

Specified by:

injectTransaction in interface SfcOfFlowWriterInterface

shutdown

public void shutdown()
              throws ExecutionException,
                     InterruptedException

Shutdown the thread pool.

Specified by:

shutdown in interface SfcOfFlowWriterInterface

Throws:

ExecutionException - thrown when attempting to retrieve the result of an aborted task

InterruptedException - thrown when the executor is waiting, sleeping, or occupied, and it is interrupted

registerTransactionListener

public void registerTransactionListener(Object interestedParty)

Specified by:

registerTransactionListener in interface SfcOfFlowWriterInterface

deregisterTransactionListener

public void deregisterTransactionListener(Object interestedParty)

Specified by:

deregisterTransactionListener in interface SfcOfFlowWriterInterface

writeFlow

public void writeFlow(Long rspId,
                      String sffNodeName,
                      org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder flow)

Store a flow to be written later. The flows will be stored per SFF and table. Later, when flushFlows() is called, all the flows will be written. The tableId is taken from the FlowBuilder.

Specified by:

writeFlow in interface SfcOfFlowWriterInterface

Parameters:

sffNodeName - - which SFF to write the flow to

flow - - details of the flow to be written

writeFlow

public void writeFlow(FlowDetails theFlowData)

Specified by:

writeFlow in interface SfcOfFlowWriterInterface

writeFlows

public boolean writeFlows(Collection<FlowDetails> theFlows)

Specified by:

writeFlows in interface SfcOfFlowWriterInterface

removeFlow

public void removeFlow(String sffNodeName,
                       org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey flowKey,
                       org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey tableKey)

Specified by:

removeFlow in interface SfcOfFlowWriterInterface

removeFlow

public void removeFlow(FlowDetails theFlowData)

Specified by:

removeFlow in interface SfcOfFlowWriterInterface

removeFlows

public boolean removeFlows(Collection<FlowDetails> theFlows)

Specified by:

removeFlows in interface SfcOfFlowWriterInterface

flushFlows

public void flushFlows()

From previous calls to writeFlowToConfig(), flows were stored per table and per SFF. Now the flows will be written, one table at at time per SFF.

Specified by:

flushFlows in interface SfcOfFlowWriterInterface

purgeFlows

public void purgeFlows()

Purge any unwritten flows not written-deleted yet. This should be called upon errors, when the remaining buffered flows should not be persisted

Specified by:

purgeFlows in interface SfcOfFlowWriterInterface

writeGroupToDataStore

public void writeGroupToDataStore(String sffNodeName,
                                  org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder gb,
                                  boolean isAdd)

Specified by:

writeGroupToDataStore in interface SfcOfFlowWriterInterface

getFlowBuilder

public org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder getFlowBuilder()

Return the last flow builder Used mainly in Unit Testing.

Specified by:

getFlowBuilder in interface SfcOfFlowWriterInterface

deleteRspFlows

public void deleteRspFlows(Long rspId)

Delete all flows created for the given rspId (flows are stored in a deletion buffer; actual transactional deletion is performed when deleteFlowSet() is called.

Specified by:

deleteRspFlows in interface SfcOfFlowWriterInterface

Parameters:

rspId - - the rspId to delete flows for

deleteFlowSet

public void deleteFlowSet()

Specified by:

deleteFlowSet in interface SfcOfFlowWriterInterface

clearSffsIfNoRspExists

public Set<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId> clearSffsIfNoRspExists()

Clear all flows from the SFFs whenever they are not featured in any RSP.

Specified by:

clearSffsIfNoRspExists in interface SfcOfFlowWriterInterface

Returns:

the SFFs that had their flows removed because they did not feature in any RSP

updateTransactionObject

public void updateTransactionObject()

Update the inner transaction object, and notify all transaction listeners through the EventBus.

Specified by:

updateTransactionObject in interface SfcOfFlowWriterInterface