org.opendaylight.vtn.manager.internal.util.flow.action

Class FlowActionConverter

java.lang.Object

org.opendaylight.vtn.manager.internal.util.flow.action.FlowActionConverter

public final class FlowActionConverter
extends Object

FlowActionConverter is an utility for conversion of flow action variants.

Method Summary

Modifier and Type	Method and Description
String	getDescription(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act) Return a brief description about the given MD-SAL action.
String	getDescription(VtnAction vact) Return a brief description about the given VTN action.
static FlowActionConverter	getInstance() Return the single global instance.
FlowFilterAction	toFlowFilterAction(VtnOrderedFlowAction vaction) Convert the given VTN action into a FlowFilterAction instance.
VtnAction	toVtnAction(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act, Short ipproto) Convert the given MD-SAL action instance into a VtnAction instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static FlowActionConverter getInstance()

Return the single global instance.

Returns:

A FlowActionConverter instance.

toFlowFilterAction

public FlowFilterAction toFlowFilterAction(VtnOrderedFlowAction vaction)
                                    throws RpcException

Convert the given VTN action into a FlowFilterAction instance.

Parameters:

vaction - A VTN flow action to be converted.

Returns:

A converted FlowFilterAction instance.

Throws:

RpcException - Failed to convert the given instance.

toVtnAction

public VtnAction toVtnAction(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act,
                             Short ipproto)
                      throws RpcException

Convert the given MD-SAL action instance into a VtnAction instance.

Parameters:

act - A MD-SAL action to be converted.

ipproto - An IP protocol number configured in the flow match.

Returns:

A VtnAction instance. null if the given MD-SAL action is not bound to VtnAction class.

Throws:

RpcException - Failed to convert the given instance.

getDescription

public String getDescription(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act)

Return a brief description about the given MD-SAL action.

Parameters:

act - A MD-SAL action.

Returns:

A string which describes the given MD-SAL action.

getDescription

public String getDescription(VtnAction vact)

Return a brief description about the given VTN action.

Parameters:

vact - A VTN action. Note that a VTN action supported by flow filter needs to be specified.

Returns:

A string which describes the given VTN action.