org.opendaylight.vtn.manager.internal.vnode

Class RemoveVlanMapTask

java.lang.Object

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

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

org.opendaylight.vtn.manager.internal.vnode.RemoveVlanMapTask

All Implemented Interfaces:

TxTask<List<VtnUpdateType>>, RpcOutputGenerator<List<VtnUpdateType>,RemoveVlanMapOutput>

public final class RemoveVlanMapTask
extends CompositeTxTask<VtnUpdateType,DeleteVlanMapTask>
implements RpcOutputGenerator<List<VtnUpdateType>,RemoveVlanMapOutput>

RemoveVlanMapTask describes the MD-SAL datastore transaction task that removes all the specified VLAN mappings from the specified vBridge.

See Also:

create(VBridgeIdentifier, List)

Method Summary

Modifier and Type	Method and Description
static RemoveVlanMapTask	create(VBridgeIdentifier ident, List<String> ids) Construct a new task that removes all the specified VLAN mappings from the specified vBridge.
RemoveVlanMapOutput	createOutput(List<VtnUpdateType> result) Generate the output of the RPC request.
Class<RemoveVlanMapOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected void	onCompleted(TxContext ctx, List<VtnUpdateType> results) Invoked when all the sub tasks have completed.
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, 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 RemoveVlanMapTask create(VBridgeIdentifier ident,
                                       List<String> ids)
                                throws RpcException

Construct a new task that removes all the specified VLAN mappings from the specified vBridge.

Parameters:

ident - A VBridgeIdentifier instance that specifies the target vBridge.

ids - A list of VLAN mappings IDs to be removed. The caller must ensure that the list is not empty.

Returns:

A RemoveVlanMapTask instance associated with the task that removes all the given VLAN mappings from the specified vBridge.

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,DeleteVlanMapTask>

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

onCompleted

protected void onCompleted(TxContext ctx,
                           List<VtnUpdateType> results)
                    throws VTNException

Invoked when all the sub tasks have completed.

Overrides:

onCompleted in class CompositeTxTask<VtnUpdateType,DeleteVlanMapTask>

Parameters:

ctx - A runtime context for transaction task.

results - A list of sub task results.

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<VtnUpdateType>,RemoveVlanMapOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public RemoveVlanMapOutput createOutput(List<VtnUpdateType> result)

Generate the output of the RPC request.

Specified by:

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

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.