org.opendaylight.vtn.manager.internal.vnode

Class RemoveMacEntryTask

java.lang.Object

org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask<List<V>>

org.opendaylight.vtn.manager.internal.util.tx.CompositeTxTask<VtnUpdateType,RemoveMacTask>

org.opendaylight.vtn.manager.internal.vnode.RemoveMacEntryTask

All Implemented Interfaces:

TxTask<List<VtnUpdateType>>, RpcOutputGenerator<List<VtnUpdateType>,RemoveMacEntryOutput>

public final class RemoveMacEntryTask
extends CompositeTxTask<VtnUpdateType,RemoveMacTask>
implements RpcOutputGenerator<List<VtnUpdateType>,RemoveMacEntryOutput>

RemoveMacEntryTask describes the MD-SAL datastore transaction task that removes the given MAC addresses from the MAC address table in the specified vBridge.

See Also:

create(VBridgeIdentifier, List)

Method Summary

Modifier and Type	Method and Description
static RemoveMacEntryTask	create(VBridgeIdentifier ident, List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress> addrs) Construct a new task that removes all the given MAC addresses from the MAC address table.
RemoveMacEntryOutput	createOutput(List<VtnUpdateType> result) Generate the output of the RPC request.
Class<RemoveMacEntryOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected void	onStarted(TxContext ctx) Invoked when the MD-SAL datastore transaction has started.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.CompositeTxTask

execute, getSubTasks, needErrorLog, onCompleted, onFailure, onSuccess

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask

addBackgroundTask, execute, getBackgroundTasks, getMaxRetry

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.vtn.manager.internal.TxTask

isAsync

Method Detail

create

public static RemoveMacEntryTask create(VBridgeIdentifier ident,
                                        List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress> addrs)
                                 throws RpcException

Construct a new task that removes all the given MAC addresses from the MAC address table.

Parameters:

ident - A VBridgeIdentifier instance that specifies the target vBridge.

addrs - A list of MAC addresses to be removed. The caller must ensure that the list is not empty.

Returns:

A RemoveMacEntryTask instance associated with the task that removes the given MAC addresses from the MAC address table.

Throws:

RpcException - An error occurred.

onStarted

protected void onStarted(TxContext ctx)
                  throws VTNException

Invoked when the MD-SAL datastore transaction has started.

Overrides:

onStarted in class CompositeTxTask<VtnUpdateType,RemoveMacTask>

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

getOutputType

public Class<RemoveMacEntryOutput> getOutputType()

Return a class which indicates the type of the RPC output.

Specified by:

getOutputType in interface RpcOutputGenerator<List<VtnUpdateType>,RemoveMacEntryOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public RemoveMacEntryOutput createOutput(List<VtnUpdateType> result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<List<VtnUpdateType>,RemoveMacEntryOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.