org.opendaylight.vtn.manager.internal.vnode

Class UpdateVirtualNodeTask<T extends org.opendaylight.yangtools.yang.binding.DataObject,C extends org.opendaylight.yangtools.yang.binding.DataObject,I extends VNodeIdentifier<T>>

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<T,C,I>

Type Parameters:

T - The type of target virtual node.

C - The type of configuration container in the target virtual node.

I - The type of the identifier for the target virtual node.

All Implemented Interfaces:

TxTask<VtnUpdateType>

Direct Known Subclasses:

UpdateVbridgeTask, UpdateVinterfaceTask, UpdateVterminalTask, UpdateVtnTask

public abstract class UpdateVirtualNodeTask<T extends org.opendaylight.yangtools.yang.binding.DataObject,C extends org.opendaylight.yangtools.yang.binding.DataObject,I extends VNodeIdentifier<T>>
extends AbstractRpcTask<VtnUpdateType>

An abstract implementation of TxTask used to create or update a virtual node in the MD-SAL datastore.

This task returns a VtnUpdateType instance that indicates the result of the task.

VtnUpdateType.CREATED

Indicates that the target virtual node has been newly created.

VtnUpdateType.CHANGED

Indicates that the target virtual node is present and it has been successfully updated.

null

No change has been made to the target virtual node.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UpdateVirtualNodeTask(I ident, VnodeUpdateMode mode, VtnUpdateOperationType op) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract void	checkParent(TxContext ctx) Ensure that the parent node is present.
protected abstract void	create(TxContext ctx, I ident, C cfg) Create a new virtual node.
protected abstract C	createConfig() Create a new virtual node configuration as specified by the RPC.
protected abstract boolean	equalsConfig(C cur, C cfg) Determine whether the given two virtual node configurations are identical or not.
protected VtnUpdateType	execute(TxContext ctx) Create or update the specified virtual node in the MD-SAL datastore.
protected abstract C	getConfig(T vnode) Return the virtual node configuration in the given virtual node.
protected abstract org.opendaylight.yangtools.yang.binding.InstanceIdentifier<C>	getConfigPath(I ident) Return the instance identifier for the configuration container in the target virtual node.
I	getIdentifier() Return the identifier for the target data object.
protected abstract C	mergeConfig(C cur) Merge the virtual node configuration specified by the RPC with the current configuration.
protected void	onUpdated(TxContext ctx) Invoked when the configuration for the target virtual node has been changed.

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

Constructor Detail

UpdateVirtualNodeTask

protected UpdateVirtualNodeTask(I ident,
                                VnodeUpdateMode mode,
                                VtnUpdateOperationType op)
                         throws RpcException

Construct a new instance.

Parameters:

ident - The identifier for the target virtual node.

mode - A VnodeUpdateMode instance.

op - A VtnUpdateOperationType instance.

Throws:

RpcException - An error occurred.

Method Detail

execute

protected final VtnUpdateType execute(TxContext ctx)
                               throws VTNException

Create or update the specified virtual node in the MD-SAL datastore.

Specified by:

execute in class AbstractTxTask<VtnUpdateType>

Parameters:

ctx - A runtime context for transaction task.

Returns:

A VtnUpdateType instance which indicates the result. null is returned if the target virtual node was not changed.

Throws:

VTNException - An error occurred.

getIdentifier

public final I getIdentifier()

Return the identifier for the target data object.

Returns:

The identifier for the target data object.

onUpdated

protected void onUpdated(TxContext ctx)
                  throws VTNException

Invoked when the configuration for the target virtual node has been changed.

This method of this class does nothing. Subclass may override this method.

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

checkParent

protected abstract void checkParent(TxContext ctx)
                             throws VTNException

Ensure that the parent node is present.

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

createConfig

protected abstract C createConfig()
                           throws RpcException

Create a new virtual node configuration as specified by the RPC.

Returns:

A new configuration container.

Throws:

RpcException - The configuration specified by the RPC is invalid.

mergeConfig

protected abstract C mergeConfig(C cur)
                          throws RpcException

Merge the virtual node configuration specified by the RPC with the current configuration.

Parameters:

cur - The current configuration of the target virtual node.

Returns:

A new configuration container.

Throws:

RpcException - The configuration specified by the RPC is invalid.

getConfig

protected abstract C getConfig(T vnode)

Return the virtual node configuration in the given virtual node.

Parameters:

vnode - The virtual node.

Returns:

The configuration for the given virtual node.

getConfigPath

protected abstract org.opendaylight.yangtools.yang.binding.InstanceIdentifier<C> getConfigPath(I ident)

Return the instance identifier for the configuration container in the target virtual node.

Parameters:

ident - The identifier for the target virtual node.

Returns:

The instance identifier for the configuration container in the target virtual node.

equalsConfig

protected abstract boolean equalsConfig(C cur,
                                        C cfg)

Determine whether the given two virtual node configurations are identical or not.

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 abstract void create(TxContext ctx,
                               I ident,
                               C cfg)
                        throws VTNException

Create a new virtual node.

Parameters:

ctx - A runtime context for transaction task.

ident - The identifier for the new virtual node.

cfg - The configuration for the new virtual node.

Throws:

VTNException - An error occurred.