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

Class VTNSetPortSrcAction

java.lang.Object

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

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

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

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

All Implemented Interfaces:

VTNIdentifiable<Integer>

public final class VTNSetPortSrcAction
extends VTNPortAction

VTNSetPortSrcAction describes the flow action that sets the source port number for IP transport layer protocol into packet.

Constructor Summary

Constructors

Constructor and Description
VTNSetPortSrcAction(int p) Construct a new instance without specifying action order.
VTNSetPortSrcAction(int p, Integer ord) Construct a new instance with specifying action order.
VTNSetPortSrcAction(VtnSetPortSrcActionCase ac, Integer ord) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	apply(FlowActionContext ctx) Apply this flow action to the given packet.
String	getDescription(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act) Return a brief description about the specified MD-SAL action.
String	getDescription(VtnAction vact) Return a brief description about the specified VTN action.
static VtnSetPortSrcActionCase	newVtnAction(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber port) Create a new VtnSetPortSrcActionCase instance.
protected org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder	set(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder builder) Set a MD-SAL action into the given action builder.
protected VtnFlowActionBuilder	set(VtnFlowActionBuilder builder) Set a VTN action into the given VTN flow action builder.
VTNSetPortSrcAction	toFlowFilterAction(VtnAction vact, Integer ord) Convert the given VtnAction instance into a FlowFilterAction instance.
VtnSetPortSrcActionCase	toVtnAction(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act) Convert the given MD-SAL action instance into a VtnAction instance.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.flow.action.VTNPortAction

appendContents, equals, getDescription, getDescription, getPort, getPortNumber, getPortNumber, hashCode, noPortNumber, verifyImpl

Methods inherited from class org.opendaylight.vtn.manager.internal.util.flow.action.FlowFilterAction

getIdentifier, getOrder, toVtnFlowAction, verify

Methods inherited from class org.opendaylight.vtn.manager.internal.util.flow.action.VTNFlowAction

cast, getErrorMessage, toActionBuilder, toString, toVtnFlowActionBuilder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VTNSetPortSrcAction

public VTNSetPortSrcAction(int p)

Construct a new instance without specifying action order.

Parameters:

p - The port numbet to be set.

VTNSetPortSrcAction

public VTNSetPortSrcAction(int p,
                           Integer ord)

Construct a new instance with specifying action order.

Parameters:

p - The port numbet to be set.

ord - An integer which determines the order of flow actions in a flow entry.

VTNSetPortSrcAction

public VTNSetPortSrcAction(VtnSetPortSrcActionCase ac,
                           Integer ord)
                    throws RpcException

Construct a new instance.

Parameters:

ac - A VtnSetPortSrcActionCase instance.

ord - An integer which determines the order of flow actions in a flow entry.

Throws:

RpcException - An invalid argument is specified.

Method Detail

newVtnAction

public static VtnSetPortSrcActionCase newVtnAction(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber port)

Create a new VtnSetPortSrcActionCase instance.

Parameters:

port - A PortNumber instance which specifies the port number.

Returns:

A VtnSetPortSrcActionCase instance.

toVtnAction

public VtnSetPortSrcActionCase toVtnAction(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act)
                                    throws RpcException

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

Note that this method must not affect instance variables.

Specified by:

toVtnAction in class VTNFlowAction

Parameters:

act - An Action instance.

Returns:

A VtnAction instance.

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)
                      throws RpcException

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

Note that this method must not affect instance variables.

Specified by:

getDescription in class VTNFlowAction

Parameters:

act - An Action instance.

Returns:

A brief description about the given MD-SAL action.

Throws:

RpcException - An error occurred.

set

protected VtnFlowActionBuilder set(VtnFlowActionBuilder builder)

Set a VTN action into the given VTN flow action builder.

Specified by:

set in class VTNFlowAction

Parameters:

builder - A VtnFlowActionBuilder instance.

Returns:

builder.

set

protected org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder set(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder builder)

Set a MD-SAL action into the given action builder.

Specified by:

set in class VTNFlowAction

Parameters:

builder - An ActionBuilder instance.

Returns:

builder.

apply

public boolean apply(FlowActionContext ctx)

Apply this flow action to the given packet.

Specified by:

apply in class FlowFilterAction

Parameters:

ctx - A FlowActionContext instance.

Returns:

true if this flow action has been actually applied. false if this flow action has been ignored.

getDescription

public String getDescription(VtnAction vact)
                      throws RpcException

Return a brief description about the specified VTN action.

Note that this method must not affect instance variables.

Specified by:

getDescription in class FlowFilterAction

Parameters:

vact - A VtnAction instance.

Returns:

A brief description about the given VTN action.

Throws:

RpcException - An error occurred.

toFlowFilterAction

public VTNSetPortSrcAction toFlowFilterAction(VtnAction vact,
                                              Integer ord)
                                       throws RpcException

Convert the given VtnAction instance into a FlowFilterAction instance.

Specified by:

toFlowFilterAction in class FlowFilterAction

Parameters:

vact - A VtnAction instance.

ord - An integer which determines the order of flow actions in a flow filter.

Returns:

A FlowFilterAction instance.

Throws:

RpcException - Failed to convert the given instance.