org.opendaylight.vtn.manager.internal.vnode

Class UpdateVtnTask

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<Vtn,VtenantConfig,VTenantIdentifier>

org.opendaylight.vtn.manager.internal.vnode.UpdateVtnTask

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,UpdateVtnOutput>

public final class UpdateVtnTask
extends UpdateVirtualNodeTask<Vtn,VtenantConfig,VTenantIdentifier>
implements RpcOutputGenerator<VtnUpdateType,UpdateVtnOutput>

UpdateVtnTask describes the MD-SAL datastore transaction task that creates or updates the specified VTN.

See Also:

create(UpdateVtnInput)

Method Summary

Modifier and Type	Method and Description
protected void	checkParent(TxContext ctx) This method does nothing because the VTN has no parent node.
protected void	create(TxContext ctx, VTenantIdentifier ident, VtenantConfig cfg) Create a new VTN.
static UpdateVtnTask	create(UpdateVtnInput input) Construct a new task that creates or updates the specified VTN.
protected VtenantConfig	createConfig() Create a new VTN configuration as specified by the RPC.
UpdateVtnOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected boolean	equalsConfig(VtenantConfig cur, VtenantConfig cfg) Determine whether the given two VTN configurations are identical or not.
protected VtenantConfig	getConfig(Vtn vnode) Return the VTN configuration in the given VTN.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtenantConfig>	getConfigPath(VTenantIdentifier ident) Return the instance identifier for the configuration container in the target VTN.
Class<UpdateVtnOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected VtenantConfig	mergeConfig(VtenantConfig cur) Merge the VTN 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 UpdateVtnTask create(UpdateVtnInput input)
                            throws RpcException

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

Parameters:

input - A UpdateVtnInput instance.

Returns:

A UpdateVtnTask instance associated with the task that creates or updates the specified VTN.

Throws:

RpcException - The given input contains invalid value.

checkParent

protected void checkParent(TxContext ctx)

This method does nothing because the VTN has no parent node.

Specified by:

checkParent in class UpdateVirtualNodeTask<Vtn,VtenantConfig,VTenantIdentifier>

Parameters:

ctx - A runtime context for transaction task.

createConfig

protected VtenantConfig createConfig()
                              throws RpcException

Create a new VTN configuration as specified by the RPC.

Specified by:

createConfig in class UpdateVirtualNodeTask<Vtn,VtenantConfig,VTenantIdentifier>

Returns:

A VtenantConfig instance.

Throws:

RpcException - The configuration specified by the RPC is invalid.

mergeConfig

protected VtenantConfig mergeConfig(VtenantConfig cur)
                             throws RpcException

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

Specified by:

mergeConfig in class UpdateVirtualNodeTask<Vtn,VtenantConfig,VTenantIdentifier>

Parameters:

cur - The current configuration of the target VTN.

Returns:

A VtenantConfig instance.

Throws:

RpcException - The configuration specified by the RPC is invalid.

getConfig

protected VtenantConfig getConfig(Vtn vnode)

Return the VTN configuration in the given VTN.

Specified by:

getConfig in class UpdateVirtualNodeTask<Vtn,VtenantConfig,VTenantIdentifier>

Parameters:

vnode - The VTN container.

Returns:

The configuration for the given VTN.

getConfigPath

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtenantConfig> getConfigPath(VTenantIdentifier ident)

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

Specified by:

getConfigPath in class UpdateVirtualNodeTask<Vtn,VtenantConfig,VTenantIdentifier>

Parameters:

ident - The identifier for the target VTN.

Returns:

The instance identifier for the vtenant-config.

equalsConfig

protected boolean equalsConfig(VtenantConfig cur,
                               VtenantConfig cfg)

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

Specified by:

equalsConfig in class UpdateVirtualNodeTask<Vtn,VtenantConfig,VTenantIdentifier>

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,
                      VTenantIdentifier ident,
                      VtenantConfig cfg)
               throws VTNException

Create a new VTN.

Specified by:

create in class UpdateVirtualNodeTask<Vtn,VtenantConfig,VTenantIdentifier>

Parameters:

ctx - A runtime context for transaction task.

ident - The identifier for the new VTN.

cfg - The configuration for the new VTN.

Throws:

VTNException - An error occurred.

getOutputType

public Class<UpdateVtnOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,UpdateVtnOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public UpdateVtnOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,UpdateVtnOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.