org.opendaylight.vtn.manager.internal.vnode

Class SetPortMapTask<B extends VtnPortMappableBridge>

java.lang.Object

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

org.opendaylight.vtn.manager.internal.util.tx.AbstractRpcTask<VtnUpdateType>

org.opendaylight.vtn.manager.internal.vnode.SetPortMapTask<B>

Type Parameters:

B - The type of the virtual bridge that contains the target virtual interface.

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,SetPortMapOutput>

public final class SetPortMapTask<B extends VtnPortMappableBridge>
extends AbstractRpcTask<VtnUpdateType>
implements RpcOutputGenerator<VtnUpdateType,SetPortMapOutput>

SetPortMapTask describes the MD-SAL datastore transaction task that configures the port mapping in the specified virtual interface.

See Also:

create(SetPortMapInput)

Method Summary

Modifier and Type	Method and Description
static SetPortMapTask<?>	create(SetPortMapInput input) Construct a new task that configures the port mapping in the specified virtual interface.
SetPortMapOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected VtnUpdateType	execute(TxContext ctx) Configure the port mapping in the specified virtual interface.
Class<SetPortMapOutput>	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

create

public static SetPortMapTask<?> create(SetPortMapInput input)
                                throws RpcException

Construct a new task that configures the port mapping in the specified virtual interface.

Parameters:

input - A SetPortMapInput instance.

Returns:

A SetPortMapTask instance associated with the task that configures the port mapping.

Throws:

RpcException - The given input contains invalid value.

execute

protected VtnUpdateType execute(TxContext ctx)
                         throws VTNException

Configure the port mapping in the specified virtual interface.

Specified by:

execute in class AbstractTxTask<VtnUpdateType>

Parameters:

ctx - MD-SAL datastore transaction context.

Returns:

Result of this task.

Throws:

VTNException - An error occurred.

getOutputType

public Class<SetPortMapOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,SetPortMapOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public SetPortMapOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,SetPortMapOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.