org.opendaylight.genius.mdsalutil.internal

Class MDSALManager

java.lang.Object

org.opendaylight.infrautils.inject.AbstractLifecycle

org.opendaylight.genius.mdsalutil.internal.MDSALManager

All Implemented Interfaces:

IMdsalApiManager, org.opendaylight.infrautils.inject.Lifecycle

@Singleton
public class MDSALManager
extends org.opendaylight.infrautils.inject.AbstractLifecycle
implements IMdsalApiManager

Constructor Summary

Constructors

Constructor and Description
MDSALManager(org.opendaylight.controller.md.sal.binding.api.DataBroker db)
MDSALManager(org.opendaylight.controller.md.sal.binding.api.DataBroker db, org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingService pktProcService) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addBucket(TypedReadWriteTransaction<Datastore.Configuration> tx, BigInteger dpId, long groupId, org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket bucket)
void	addFlow(TypedWriteTransaction<Datastore.Configuration> tx, BigInteger dpId, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flow) Adds the given flow.
void	addFlow(TypedWriteTransaction<Datastore.Configuration> tx, FlowEntity flowEntity) Adds the given flow.
void	addGroup(TypedWriteTransaction<Datastore.Configuration> tx, BigInteger dpId, org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group group) Adds the given group using the given transaction.
void	addGroup(TypedWriteTransaction<Datastore.Configuration> tx, GroupEntity groupEntity) Adds the given group using the given transaction.
boolean	groupExists(BigInteger dpId, long groupId) Check if OF group exist on DPN.
com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException>	installFlow(BigInteger dpId, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flowEntity) Adds a flow.
com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException>	installFlow(BigInteger dpId, FlowEntity flowEntity) Adds a flow.
com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException>	installFlow(FlowEntity flowEntity) Adds a flow.
void	removeBucket(TypedReadWriteTransaction<Datastore.Configuration> tx, BigInteger dpId, long groupId, long bucketId)
com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException>	removeFlow(BigInteger dpId, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flowEntity) Removes a flow.
com.google.common.util.concurrent.ListenableFuture<Void>	removeFlow(BigInteger dpId, short tableId, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId flowId) Removes a flow.
com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException>	removeFlow(FlowEntity flowEntity) Removes a flow.
void	removeFlow(TypedReadWriteTransaction<Datastore.Configuration> tx, BigInteger dpId, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flow) Removes the given flow.
void	removeFlow(TypedReadWriteTransaction<Datastore.Configuration> tx, BigInteger dpId, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey flowKey, short tableId) Removes the given flow.
void	removeFlow(TypedReadWriteTransaction<Datastore.Configuration> tx, BigInteger dpId, String flowId, short tableId) Removes the given flow.
void	removeFlow(TypedReadWriteTransaction<Datastore.Configuration> tx, FlowEntity flowEntity) Removes the given flow.
void	removeGroup(GroupEntity groupEntity) Remove a group.
void	removeGroup(TypedReadWriteTransaction<Datastore.Configuration> tx, BigInteger dpId, org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group group) Remove a group using the given transaction.
void	removeGroup(TypedReadWriteTransaction<Datastore.Configuration> tx, BigInteger dpId, long groupId) Remove a group using the given transaction.
void	removeGroup(TypedReadWriteTransaction<Datastore.Configuration> tx, GroupEntity groupEntity) Remove a group using the given transaction.
protected void	start()
protected void	stop()
void	syncInstallFlow(FlowEntity flowEntity) Installs a flow.
void	syncInstallFlow(FlowEntity flowEntity, long delayTime) Install a flow.
void	syncInstallGroup(GroupEntity groupEntity) Installs a group.
void	syncRemoveFlow(FlowEntity flowEntity) Removes a flow.
void	syncRemoveFlow(FlowEntity flowEntity, long delayTime) API to remove the flow on Data Plane Node synchronously.
void	syncRemoveGroup(GroupEntity groupEntity) API to remove the Group on Data Plane Node synchronously.

Methods inherited from class org.opendaylight.infrautils.inject.AbstractLifecycle

checkIsRunning, destroy, init, isRunning

Methods inherited from class java.lang.Object

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

Constructor Detail

MDSALManager

@Deprecated
public MDSALManager(org.opendaylight.controller.md.sal.binding.api.DataBroker db,
                                org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingService pktProcService)

Deprecated.

Writes the flows and Groups to the MD SAL DataStore which will be sent to the openflowplugin for installing flows/groups on the switch. Other modules of VPN service that wants to install flows / groups on the switch uses this utility

Parameters:

db - dataBroker reference

pktProcService - PacketProcessingService for sending the packet outs

MDSALManager

@Inject
public MDSALManager(org.opendaylight.controller.md.sal.binding.api.DataBroker db)

Method Detail

start

protected void start()

Specified by:

start in class org.opendaylight.infrautils.inject.AbstractLifecycle

stop

protected void stop()

Specified by:

stop in class org.opendaylight.infrautils.inject.AbstractLifecycle

installFlow

public com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException> installFlow(FlowEntity flowEntity)

Description copied from interface: IMdsalApiManager

Adds a flow.

Specified by:

installFlow in interface IMdsalApiManager

installFlow

public com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException> installFlow(BigInteger dpId,
                                                                                                                                                             org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flowEntity)

Description copied from interface: IMdsalApiManager

Adds a flow.

Specified by:

installFlow in interface IMdsalApiManager

installFlow

public com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException> installFlow(BigInteger dpId,
                                                                                                                                                             FlowEntity flowEntity)

Description copied from interface: IMdsalApiManager

Adds a flow.

Specified by:

installFlow in interface IMdsalApiManager

removeFlow

public com.google.common.util.concurrent.ListenableFuture<Void> removeFlow(BigInteger dpId,
                                                                           short tableId,
                                                                           org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId flowId)

Description copied from interface: IMdsalApiManager

Removes a flow.

Specified by:

removeFlow in interface IMdsalApiManager

removeFlow

public com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException> removeFlow(BigInteger dpId,
                                                                                                                                                            org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flowEntity)

Description copied from interface: IMdsalApiManager

Removes a flow.

Specified by:

removeFlow in interface IMdsalApiManager

removeFlow

public com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException> removeFlow(FlowEntity flowEntity)

Description copied from interface: IMdsalApiManager

Removes a flow.

Specified by:

removeFlow in interface IMdsalApiManager

removeFlow

public void removeFlow(TypedReadWriteTransaction<Datastore.Configuration> tx,
                       FlowEntity flowEntity)
                throws ExecutionException,
                       InterruptedException

Description copied from interface: IMdsalApiManager

Removes the given flow.

Specified by:

removeFlow in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

flowEntity - The flow entity.

Throws:

ExecutionException

InterruptedException

removeFlow

public void removeFlow(TypedReadWriteTransaction<Datastore.Configuration> tx,
                       BigInteger dpId,
                       org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flow)
                throws ExecutionException,
                       InterruptedException

Description copied from interface: IMdsalApiManager

Removes the given flow.

Specified by:

removeFlow in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

dpId - The DPN identifier.

flow - The flow.

Throws:

ExecutionException

InterruptedException

removeFlow

public void removeFlow(TypedReadWriteTransaction<Datastore.Configuration> tx,
                       BigInteger dpId,
                       String flowId,
                       short tableId)
                throws ExecutionException,
                       InterruptedException

Description copied from interface: IMdsalApiManager

Removes the given flow.

Specified by:

removeFlow in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

dpId - The DPN identifier.

flowId - The flow identifier.

tableId - The table identifier.

Throws:

ExecutionException

InterruptedException

removeFlow

public void removeFlow(TypedReadWriteTransaction<Datastore.Configuration> tx,
                       BigInteger dpId,
                       org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey flowKey,
                       short tableId)
                throws ExecutionException,
                       InterruptedException

Description copied from interface: IMdsalApiManager

Removes the given flow.

Specified by:

removeFlow in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

dpId - The DPN identifier.

flowKey - The flow key.

tableId - The table identifier.

Throws:

ExecutionException

InterruptedException

removeGroup

public void removeGroup(GroupEntity groupEntity)

Description copied from interface: IMdsalApiManager

Remove a group.

Specified by:

removeGroup in interface IMdsalApiManager

removeGroup

public void removeGroup(TypedReadWriteTransaction<Datastore.Configuration> tx,
                        GroupEntity groupEntity)
                 throws ExecutionException,
                        InterruptedException

Description copied from interface: IMdsalApiManager

Remove a group using the given transaction.

Specified by:

removeGroup in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

groupEntity - The group to remove.

Throws:

ExecutionException

InterruptedException

removeGroup

public void removeGroup(TypedReadWriteTransaction<Datastore.Configuration> tx,
                        BigInteger dpId,
                        org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group group)
                 throws ExecutionException,
                        InterruptedException

Description copied from interface: IMdsalApiManager

Remove a group using the given transaction.

Specified by:

removeGroup in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

dpId - The DPN identifier.

group - The group to remove.

Throws:

ExecutionException

InterruptedException

removeGroup

public void removeGroup(TypedReadWriteTransaction<Datastore.Configuration> tx,
                        BigInteger dpId,
                        long groupId)
                 throws ExecutionException,
                        InterruptedException

Description copied from interface: IMdsalApiManager

Remove a group using the given transaction.

Specified by:

removeGroup in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

dpId - The DPN identifier.

groupId - The group identifier of the group to remove.

Throws:

ExecutionException

InterruptedException

syncRemoveFlow

public void syncRemoveFlow(FlowEntity flowEntity,
                           long delayTime)

Description copied from interface: IMdsalApiManager

API to remove the flow on Data Plane Node synchronously. It internally waits for Flow Change Notification to confirm flow delete request is being sent with-in delayTime.

Specified by:

syncRemoveFlow in interface IMdsalApiManager

syncRemoveFlow

public void syncRemoveFlow(FlowEntity flowEntity)

Description copied from interface: IMdsalApiManager

Removes a flow.

Specified by:

syncRemoveFlow in interface IMdsalApiManager

syncInstallFlow

public void syncInstallFlow(FlowEntity flowEntity,
                            long delayTime)

Description copied from interface: IMdsalApiManager

Install a flow.

Specified by:

syncInstallFlow in interface IMdsalApiManager

syncInstallFlow

public void syncInstallFlow(FlowEntity flowEntity)

Description copied from interface: IMdsalApiManager

Installs a flow.

Specified by:

syncInstallFlow in interface IMdsalApiManager

syncInstallGroup

public void syncInstallGroup(GroupEntity groupEntity)

Description copied from interface: IMdsalApiManager

Installs a group.

Specified by:

syncInstallGroup in interface IMdsalApiManager

syncRemoveGroup

public void syncRemoveGroup(GroupEntity groupEntity)

Description copied from interface: IMdsalApiManager

API to remove the Group on Data Plane Node synchronously. It internally waits for Group Change Notification to confirm group delete request is being sent.

Specified by:

syncRemoveGroup in interface IMdsalApiManager

addFlow

public void addFlow(TypedWriteTransaction<Datastore.Configuration> tx,
                    FlowEntity flowEntity)

Description copied from interface: IMdsalApiManager

Adds the given flow.

Specified by:

addFlow in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

flowEntity - The flow entity.

addFlow

public void addFlow(TypedWriteTransaction<Datastore.Configuration> tx,
                    BigInteger dpId,
                    org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flow)

Description copied from interface: IMdsalApiManager

Adds the given flow.

Specified by:

addFlow in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

dpId - The DPN identifier.

flow - The flow.

addGroup

public void addGroup(TypedWriteTransaction<Datastore.Configuration> tx,
                     GroupEntity groupEntity)

Description copied from interface: IMdsalApiManager

Adds the given group using the given transaction.

Specified by:

addGroup in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

groupEntity - The group to add.

addGroup

public void addGroup(TypedWriteTransaction<Datastore.Configuration> tx,
                     BigInteger dpId,
                     org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group group)

Description copied from interface: IMdsalApiManager

Adds the given group using the given transaction.

Specified by:

addGroup in interface IMdsalApiManager

Parameters:

tx - The transaction to use.

dpId - The DPN identifier.

group - The group to add.

addBucket

public void addBucket(TypedReadWriteTransaction<Datastore.Configuration> tx,
                      BigInteger dpId,
                      long groupId,
                      org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket bucket)
               throws ExecutionException,
                      InterruptedException

Specified by:

addBucket in interface IMdsalApiManager

Throws:

ExecutionException

InterruptedException

removeBucket

public void removeBucket(TypedReadWriteTransaction<Datastore.Configuration> tx,
                         BigInteger dpId,
                         long groupId,
                         long bucketId)
                  throws ExecutionException,
                         InterruptedException

Specified by:

removeBucket in interface IMdsalApiManager

Throws:

ExecutionException

InterruptedException

groupExists

public boolean groupExists(BigInteger dpId,
                           long groupId)

Description copied from interface: IMdsalApiManager

Check if OF group exist on DPN.

Specified by:

groupExists in interface IMdsalApiManager

Parameters:

dpId - dpn id

groupId - OF group id

Returns:

true if group exists and false otherwise