org.opendaylight.vtn.manager.internal.vnode

Class UpdateVterminalTask

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<Vterminal,VterminalConfig,VTerminalIdentifier>

org.opendaylight.vtn.manager.internal.vnode.UpdateVterminalTask

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,UpdateVterminalOutput>

public final class UpdateVterminalTask
extends UpdateVirtualNodeTask<Vterminal,VterminalConfig,VTerminalIdentifier>
implements RpcOutputGenerator<VtnUpdateType,UpdateVterminalOutput>

UpdateVterminalTask describes the MD-SAL datastore transaction task that creates or updates the specified vTerminal. a * @see #create(UpdateVterminalInput)

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, VTerminalIdentifier ident, VterminalConfig cfg) Create a new vTerminal.
static UpdateVterminalTask	create(UpdateVterminalInput input) Construct a new task that creates or updates the specified vTerminal.
protected VterminalConfig	createConfig() Create a new vTerminal configuration as specified by the RPC.
UpdateVterminalOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected boolean	equalsConfig(VterminalConfig cur, VterminalConfig cfg) Determine whether the given two vTerminal configurations are identical or not.
protected VterminalConfig	getConfig(Vterminal vnode) Return the vTerminal configuration in the given vTerminal.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VterminalConfig>	getConfigPath(VTerminalIdentifier ident) Return the instance identifier for the configuration container in the target vTerminal.
Class<UpdateVterminalOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected VterminalConfig	mergeConfig(VterminalConfig cur) Merge the vTerminal 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 UpdateVterminalTask create(UpdateVterminalInput input)
                                  throws RpcException

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

Parameters:

input - A UpdateVterminalInput instance.

Returns:

A UpdateVterminalTask instance associated with the task that creates or updates the specified vTerminal.

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<Vterminal,VterminalConfig,VTerminalIdentifier>

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

createConfig

protected VterminalConfig createConfig()
                                throws RpcException

Create a new vTerminal configuration as specified by the RPC.

Specified by:

createConfig in class UpdateVirtualNodeTask<Vterminal,VterminalConfig,VTerminalIdentifier>

Returns:

A VterminalConfig instance.

Throws:

RpcException - The configuration specified by the RPC is invalid.

mergeConfig

protected VterminalConfig mergeConfig(VterminalConfig cur)

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

Specified by:

mergeConfig in class UpdateVirtualNodeTask<Vterminal,VterminalConfig,VTerminalIdentifier>

Parameters:

cur - The current configuration of the target vTerminal.

Returns:

A VterminalConfig instance.

getConfig

protected VterminalConfig getConfig(Vterminal vnode)

Return the vTerminal configuration in the given vTerminal.

Specified by:

getConfig in class UpdateVirtualNodeTask<Vterminal,VterminalConfig,VTerminalIdentifier>

Parameters:

vnode - The vTerminal container.

Returns:

The configuration for the given vTerminal.

getConfigPath

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VterminalConfig> getConfigPath(VTerminalIdentifier ident)

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

Specified by:

getConfigPath in class UpdateVirtualNodeTask<Vterminal,VterminalConfig,VTerminalIdentifier>

Parameters:

ident - The identifier for the target vTerminal.

Returns:

The instance identifier for the vterminal-config.

equalsConfig

protected boolean equalsConfig(VterminalConfig cur,
                               VterminalConfig cfg)

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

Specified by:

equalsConfig in class UpdateVirtualNodeTask<Vterminal,VterminalConfig,VTerminalIdentifier>

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,
                      VTerminalIdentifier ident,
                      VterminalConfig cfg)
               throws VTNException

Create a new vTerminal.

Specified by:

create in class UpdateVirtualNodeTask<Vterminal,VterminalConfig,VTerminalIdentifier>

Parameters:

ctx - A runtime context for transaction task.

ident - The identifier for the new vTerminal.

cfg - The configuration for the new vTerminal.

Throws:

VTNException - An error occurred.

getOutputType

public Class<UpdateVterminalOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,UpdateVterminalOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public UpdateVterminalOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,UpdateVterminalOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.