org.opendaylight.vtn.manager.internal.vnode

Class UpdateVbridgeTask

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.UpdateVirtualNodeTask<Vbridge,VbridgeConfig,VBridgeIdentifier>

org.opendaylight.vtn.manager.internal.vnode.UpdateVbridgeTask

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,UpdateVbridgeOutput>

public final class UpdateVbridgeTask
extends UpdateVirtualNodeTask<Vbridge,VbridgeConfig,VBridgeIdentifier>
implements RpcOutputGenerator<VtnUpdateType,UpdateVbridgeOutput>

UpdateVbridgeTask describes the MD-SAL datastore transaction task that creates or updates the specified vBridge.

See Also:

create(UpdateVbridgeInput)

Method Summary

Modifier and Type	Method and Description
protected void	checkParent(TxContext ctx) Ensure that the parent VTN is present.
protected void	create(TxContext ctx, VBridgeIdentifier ident, VbridgeConfig cfg) Create a new vBridge.
static UpdateVbridgeTask	create(UpdateVbridgeInput input) Construct a new task that creates or updates the specified vBridge.
protected VbridgeConfig	createConfig() Create a new vBridge configuration as specified by the RPC.
UpdateVbridgeOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected boolean	equalsConfig(VbridgeConfig cur, VbridgeConfig cfg) Determine whether the given two vBridge configurations are identical or not.
protected VbridgeConfig	getConfig(Vbridge vnode) Return the vBridge configuration in the given vBridge.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VbridgeConfig>	getConfigPath(VBridgeIdentifier ident) Return the instance identifier for the configuration container in the target vBridge.
Class<UpdateVbridgeOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected VbridgeConfig	mergeConfig(VbridgeConfig cur) Merge the vBridge configuration specified by the RPC with the current configuration.

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

execute, getIdentifier, onUpdated

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 UpdateVbridgeTask create(UpdateVbridgeInput input)
                                throws RpcException

Construct a new task that creates or updates the specified vBridge.

Parameters:

input - A UpdateVbridgeInput instance.

Returns:

A UpdateVbridgeTask instance associated with the task that creates or updates the specified vBridge.

Throws:

RpcException - The given input contains invalid value.

checkParent

protected void checkParent(TxContext ctx)
                    throws VTNException

Ensure that the parent VTN is present.

Specified by:

checkParent in class UpdateVirtualNodeTask<Vbridge,VbridgeConfig,VBridgeIdentifier>

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

createConfig

protected VbridgeConfig createConfig()
                              throws RpcException

Create a new vBridge configuration as specified by the RPC.

Specified by:

createConfig in class UpdateVirtualNodeTask<Vbridge,VbridgeConfig,VBridgeIdentifier>

Returns:

A VbridgeConfig instance.

Throws:

RpcException - The configuration specified by the RPC is invalid.

mergeConfig

protected VbridgeConfig mergeConfig(VbridgeConfig cur)
                             throws RpcException

Merge the vBridge configuration specified by the RPC with the current configuration.

Specified by:

mergeConfig in class UpdateVirtualNodeTask<Vbridge,VbridgeConfig,VBridgeIdentifier>

Parameters:

cur - The current configuration of the target vBridge.

Returns:

A VbridgeConfig instance.

Throws:

RpcException - The configuration specified by the RPC is invalid.

getConfig

protected VbridgeConfig getConfig(Vbridge vnode)

Return the vBridge configuration in the given vBridge.

Specified by:

getConfig in class UpdateVirtualNodeTask<Vbridge,VbridgeConfig,VBridgeIdentifier>

Parameters:

vnode - The vBridge container.

Returns:

The configuration for the given vBridge.

getConfigPath

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VbridgeConfig> getConfigPath(VBridgeIdentifier ident)

Return the instance identifier for the configuration container in the target vBridge.

Specified by:

getConfigPath in class UpdateVirtualNodeTask<Vbridge,VbridgeConfig,VBridgeIdentifier>

Parameters:

ident - The identifier for the target vBridge.

Returns:

The instance identifier for the vbridge-config.

equalsConfig

protected boolean equalsConfig(VbridgeConfig cur,
                               VbridgeConfig cfg)

Determine whether the given two vBridge configurations are identical or not.

Specified by:

equalsConfig in class UpdateVirtualNodeTask<Vbridge,VbridgeConfig,VBridgeIdentifier>

Parameters:

cur - The current configuration.

cfg - The configuration that is going to be applied.

Returns:

true only if the given two configurations are identical.

create

protected void create(TxContext ctx,
                      VBridgeIdentifier ident,
                      VbridgeConfig cfg)
               throws VTNException

Create a new vBridge.

Specified by:

create in class UpdateVirtualNodeTask<Vbridge,VbridgeConfig,VBridgeIdentifier>

Parameters:

ctx - A runtime context for transaction task.

ident - The identifier for the new vBridge.

cfg - The configuration for the new vBridge.

Throws:

VTNException - An error occurred.

getOutputType

public Class<UpdateVbridgeOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,UpdateVbridgeOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public UpdateVbridgeOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,UpdateVbridgeOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.