org.opendaylight.vtn.manager.internal.vnode

Class UpdateVinterfaceTask<B extends VtnPortMappableBridge>

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<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B>>

org.opendaylight.vtn.manager.internal.vnode.UpdateVinterfaceTask<B>

Type Parameters:

B - The type of the virtual bridge that contains the target virtual interface.

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,UpdateVinterfaceOutput>

public abstract class UpdateVinterfaceTask<B extends VtnPortMappableBridge>
extends UpdateVirtualNodeTask<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B>>
implements RpcOutputGenerator<VtnUpdateType,UpdateVinterfaceOutput>

UpdateVinterfaceTask describes the MD-SAL datastore transaction task that creates or updates the specified virtual interface.

See Also:

create(UpdateVinterfaceInput)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addInterface(TxContext ctx, VInterfaceIdentifier<B> ident, Vinterface vintf) Add a new virtual interface.
protected void	checkParent(TxContext ctx) Ensure that the parent virtual bridge is present.
protected void	create(TxContext ctx, VInterfaceIdentifier<B> ident, VinterfaceConfig cfg) Create a new virtual interface.
static UpdateVinterfaceTask<?>	create(UpdateVinterfaceInput input) Construct a new task that creates or updates the specified virtual interface.
protected VinterfaceConfig	createConfig() Create a new virtual interface configuration as specified by the RPC.
UpdateVinterfaceOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected boolean	equalsConfig(VinterfaceConfig cur, VinterfaceConfig cfg) Determine whether the given two virtual interface configurations are identical or not.
protected VinterfaceConfig	getConfig(Vinterface vnode) Return the virtual interface configuration in the given virtual interface.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VinterfaceConfig>	getConfigPath(VInterfaceIdentifier<B> ident) Return the instance identifier for the configuration container in the target virtual interface.
Class<UpdateVinterfaceOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected B	getParentBridge() Return the parent virtual bridge fetched by the call of checkParent(TxContext).
protected BridgeIdentifier<B>	getParentIdentifier() Return the identifier for the parent bridge.
protected VinterfaceConfig	mergeConfig(VinterfaceConfig cur) Merge the virtual interface configuration specified by the RPC with the current configuration.
protected abstract VirtualBridge<B>	newBridge(BridgeIdentifier<B> ident, B parent) Construct a new cache object for the parent virtual bridge.
protected void	onUpdated(TxContext ctx) Invoked when the configuration for the target virtual interface has been changed.

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

execute, getIdentifier

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 UpdateVinterfaceTask<?> create(UpdateVinterfaceInput input)
                                      throws RpcException

Construct a new task that creates or updates the specified virtual interface.

Parameters:

input - A UpdateVinterfaceInput instance.

Returns:

A UpdateVinterfaceTask instance associated with the task that creates or updates the specified virtual interface.

Throws:

RpcException - The given input contains invalid value.

getParentIdentifier

protected final BridgeIdentifier<B> getParentIdentifier()

Return the identifier for the parent bridge.

Returns:

The identifier for the parent bridge.

getParentBridge

protected final B getParentBridge()

Return the parent virtual bridge fetched by the call of checkParent(TxContext).

Returns:

The parent virtual bridge.

addInterface

protected abstract void addInterface(TxContext ctx,
                                     VInterfaceIdentifier<B> ident,
                                     Vinterface vintf)
                              throws VTNException

Add a new virtual interface.

Parameters:

ctx - A runtime context for transaction task.

ident - The identifier for the new virtual interface.

vintf - A new virtual interface to be added.

Throws:

VTNException - An error occurred.

newBridge

protected abstract VirtualBridge<B> newBridge(BridgeIdentifier<B> ident,
                                              B parent)

Construct a new cache object for the parent virtual bridge.

Parameters:

ident - The identifier for the parent virtual bridge.

parent - The parent virtual bridge.

Returns:

A new cache object for the parent virtual bridge.

onUpdated

protected void onUpdated(TxContext ctx)
                  throws VTNException

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

Overrides:

onUpdated in class UpdateVirtualNodeTask<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B extends VtnPortMappableBridge>>

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

checkParent

protected final void checkParent(TxContext ctx)
                          throws VTNException

Ensure that the parent virtual bridge is present.

Specified by:

checkParent in class UpdateVirtualNodeTask<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B extends VtnPortMappableBridge>>

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.

createConfig

protected final VinterfaceConfig createConfig()

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

Specified by:

createConfig in class UpdateVirtualNodeTask<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B extends VtnPortMappableBridge>>

Returns:

A VinterfaceConfig instance.

mergeConfig

protected final VinterfaceConfig mergeConfig(VinterfaceConfig cur)
                                      throws RpcException

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

Specified by:

mergeConfig in class UpdateVirtualNodeTask<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B extends VtnPortMappableBridge>>

Parameters:

cur - The current configuration of the target virtual interface.

Returns:

A VinterfaceConfig instance.

Throws:

RpcException - The configuration specified by the RPC is invalid.

getConfig

protected final VinterfaceConfig getConfig(Vinterface vnode)

Return the virtual interface configuration in the given virtual interface.

Specified by:

getConfig in class UpdateVirtualNodeTask<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B extends VtnPortMappableBridge>>

Parameters:

vnode - The virtual interface container.

Returns:

The configuration for the given virtual interface.

getConfigPath

protected final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VinterfaceConfig> getConfigPath(VInterfaceIdentifier<B> ident)

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

Specified by:

getConfigPath in class UpdateVirtualNodeTask<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B extends VtnPortMappableBridge>>

Parameters:

ident - The identifier for the target virtual interface.

Returns:

The instance identifier for the vinterface-config.

equalsConfig

protected final boolean equalsConfig(VinterfaceConfig cur,
                                     VinterfaceConfig cfg)

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

Specified by:

equalsConfig in class UpdateVirtualNodeTask<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B extends VtnPortMappableBridge>>

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 final void create(TxContext ctx,
                            VInterfaceIdentifier<B> ident,
                            VinterfaceConfig cfg)
                     throws VTNException

Create a new virtual interface.

Specified by:

create in class UpdateVirtualNodeTask<Vinterface,VinterfaceConfig,VInterfaceIdentifier<B extends VtnPortMappableBridge>>

Parameters:

ctx - A runtime context for transaction task.

ident - The identifier for the new virtual interface.

cfg - The configuration for the new virtual interface.

Throws:

VTNException - An error occurred.

getOutputType

public final Class<UpdateVinterfaceOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,UpdateVinterfaceOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public final UpdateVinterfaceOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,UpdateVinterfaceOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.