org.opendaylight.vtn.manager.internal.vnode

Class SetMacMapTask

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.UpdateMacMapTask

org.opendaylight.vtn.manager.internal.vnode.SetMacMapTask

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,SetMacMapOutput>

public final class SetMacMapTask
extends UpdateMacMapTask
implements RpcOutputGenerator<VtnUpdateType,SetMacMapOutput>

SetMacMapTask describes the MD-SAL datastore transaction task that configures a MAC mapping in the specified vBridge.

See Also:

create(SetMacMapInput)

Method Summary

Modifier and Type	Method and Description
static SetMacMapTask	create(SetMacMapInput input) Construct a new task that configures a MAC mapping in the specified vBridge.
SetMacMapOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
Class<SetMacMapOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected MacMapChange	updateConfig(VTNMacMapConfig cfg, VtnUpdateOperationType op) Update the MAC mapping configuration.

Methods inherited from class org.opendaylight.vtn.manager.internal.vnode.UpdateMacMapTask

execute

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 SetMacMapTask create(SetMacMapInput input)
                            throws RpcException

Construct a new task that configures a MAC mapping in the specified vBridge.

Parameters:

input - A SetMacMapTask instance.

Returns:

A SetMacMapTask instance associated with the task that configures a MAC mapping in the specified vBridge.

Throws:

RpcException - The given input contains invalid value.

updateConfig

protected MacMapChange updateConfig(VTNMacMapConfig cfg,
                                    VtnUpdateOperationType op)
                             throws RpcException

Update the MAC mapping configuration.

Specified by:

updateConfig in class UpdateMacMapTask

Parameters:

cfg - The current MAC mapping configuration.

op - A VtnUpdateOperationType instance that specifies how to update the configuration.

Returns:

A MacMapChange instance if the configuration was chaged. null if not changed.

Throws:

RpcException - Failed to update the configuration.

getOutputType

public Class<SetMacMapOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,SetMacMapOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public SetMacMapOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,SetMacMapOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.