org.opendaylight.vtn.manager.internal.vnode

Class ClearMacEntryTask

java.lang.Object

org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask<T>

org.opendaylight.vtn.manager.internal.util.tx.AbstractRpcTask<List<RemoveMacEntryResult>>

org.opendaylight.vtn.manager.internal.vnode.ClearMacEntryTask

All Implemented Interfaces:

TxTask<List<RemoveMacEntryResult>>, RpcOutputGenerator<List<RemoveMacEntryResult>,RemoveMacEntryOutput>

public final class ClearMacEntryTask
extends AbstractRpcTask<List<RemoveMacEntryResult>>
implements RpcOutputGenerator<List<RemoveMacEntryResult>,RemoveMacEntryOutput>

ClearMacEntryTask describes the MD-SAL datastore transaction task that removes all the MAC addresses learned by the specified vBridge.

Method Summary

Modifier and Type	Method and Description
RemoveMacEntryOutput	createOutput(List<RemoveMacEntryResult> result) Generate the output of the RPC request.
protected List<RemoveMacEntryResult>	execute(TxContext ctx) Clear the specified MAC address table.
Class<RemoveMacEntryOutput>	getOutputType() Return a class which indicates the type of the RPC output.

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

needErrorLog

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

addBackgroundTask, execute, getBackgroundTasks, getMaxRetry, onFailure, onSuccess

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

execute

protected List<RemoveMacEntryResult> execute(TxContext ctx)
                                      throws VTNException

Clear the specified MAC address table.

Specified by:

execute in class AbstractTxTask<List<RemoveMacEntryResult>>

Parameters:

ctx - A runtime context for transaction task.

Returns:

A list of RemoveMacEntryResult instances that contains all the removed MAC addresses. null if the specified MAC address table is empty.

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<RemoveMacEntryResult>,RemoveMacEntryOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public RemoveMacEntryOutput createOutput(List<RemoveMacEntryResult> result)

Generate the output of the RPC request.

Specified by:

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

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.