org.opendaylight.vtn.manager.internal.flow.cond

Class SetFlowConditionTask

java.lang.Object

org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask<T>

org.opendaylight.vtn.manager.internal.util.tx.AbstractRpcTask<V>

org.opendaylight.vtn.manager.internal.util.tx.AbstractDataTask<D,VtnUpdateType>

org.opendaylight.vtn.manager.internal.util.tx.PutDataTask<VtnFlowCondition>

org.opendaylight.vtn.manager.internal.flow.cond.SetFlowConditionTask

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,SetFlowConditionOutput>

public final class SetFlowConditionTask
extends PutDataTask<VtnFlowCondition>
implements RpcOutputGenerator<VtnUpdateType,SetFlowConditionOutput>

SetFlowConditionTask describes the MD-SAL datastore transaction task that creates or updates the specified flow condition configuration.

See Also:

create(SetFlowConditionInput)

Method Summary

Modifier and Type	Method and Description
static SetFlowConditionTask	create(SetFlowConditionInput input) Construct a new task that creates or updates the specified flow condition configuration.
SetFlowConditionOutput	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected boolean	fixMissingParents() Determine whether missing parent nodes should be created or not.
Class<SetFlowConditionOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected void	onStarted(TxContext ctx, VtnFlowCondition current) Invoked when the MD-SAL datastore transaction has started.
void	onSuccess(VTNManagerProvider provider, VtnUpdateType result) Invoked when the task has completed successfully.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.PutDataTask

execute, getDataObject, setDataObject

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.AbstractDataTask

getDatastoreType, getTargetPath

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

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 SetFlowConditionTask create(SetFlowConditionInput input)
                                   throws RpcException

Construct a new task that creates or updates the specified flow condition configuration.

Parameters:

input - A SetFlowConditionInput instance.

Returns:

A SetFlowConditionTask instance associated with the task that set the given flow condition configuration.

Throws:

RpcException - The given input contains invalid value.

fixMissingParents

protected boolean fixMissingParents()

Determine whether missing parent nodes should be created or not.

This method always return true in order to create the root container for the flow condition if missing.

Overrides:

fixMissingParents in class PutDataTask<VtnFlowCondition>

Returns:

true.

onStarted

protected void onStarted(TxContext ctx,
                         VtnFlowCondition current)
                  throws VTNException

Invoked when the MD-SAL datastore transaction has started.

Overrides:

onStarted in class PutDataTask<VtnFlowCondition>

Parameters:

ctx - A runtime context for transaction task.

current - The current value at the target path in the MD-SAL datastore. Note that null is passed if the target data is not present.

Throws:

VTNException - An error occurred.

onSuccess

public void onSuccess(VTNManagerProvider provider,
                      VtnUpdateType result)

Invoked when the task has completed successfully.

This method of this class does nothing.

Specified by:

onSuccess in interface TxTask<VtnUpdateType>

Overrides:

onSuccess in class AbstractTxTask<VtnUpdateType>

Parameters:

provider - VTN Manager provider service.

result - An object returned by AbstractTxTask.execute(TxContext, int).

getOutputType

public Class<SetFlowConditionOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,SetFlowConditionOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public SetFlowConditionOutput createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,SetFlowConditionOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.