org.opendaylight.vtn.manager.internal.vnode

Class ClearVlanMapTask

java.lang.Object

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

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

org.opendaylight.vtn.manager.internal.vnode.ClearVlanMapTask

All Implemented Interfaces:

TxTask<List<RemoveVlanMapResult>>, RpcOutputGenerator<List<RemoveVlanMapResult>,RemoveVlanMapOutput>

public final class ClearVlanMapTask
extends AbstractRpcTask<List<RemoveVlanMapResult>>
implements RpcOutputGenerator<List<RemoveVlanMapResult>,RemoveVlanMapOutput>

ClearVlanMapTask describes the MD-SAL datastore transaction task that removes all the VLAN mappings configured in the specified vBridge.

Method Summary

Modifier and Type	Method and Description
RemoveVlanMapOutput	createOutput(List<RemoveVlanMapResult> result) Generate the output of the RPC request.
protected List<RemoveVlanMapResult>	execute(TxContext ctx) Clear all the VLAN mappings configured in the specified vBridge.
Class<RemoveVlanMapOutput>	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<RemoveVlanMapResult> execute(TxContext ctx)
                                     throws VTNException

Clear all the VLAN mappings configured in the specified vBridge.

Specified by:

execute in class AbstractTxTask<List<RemoveVlanMapResult>>

Parameters:

ctx - A runtime context for transaction task.

Returns:

A list of RemoveVlanMapResult instances that indicates removed VLAN mappings. null if no VLAN mapping is configured in the specified vBridge.

Throws:

VTNException - An error occurred.

getOutputType

public Class<RemoveVlanMapOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<List<RemoveVlanMapResult>,RemoveVlanMapOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public RemoveVlanMapOutput createOutput(List<RemoveVlanMapResult> result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<List<RemoveVlanMapResult>,RemoveVlanMapOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.