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

Class VTNSetInetSrcAction

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.VTNInetAddrAction

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

All Implemented Interfaces:

VTNIdentifiable<Integer>

public final class VTNSetInetSrcAction
extends VTNInetAddrAction

VTNSetInetSrcAction describes the flow action that sets the source IP address into IP header.

Constructor Summary

Constructors

Constructor and Description
VTNSetInetSrcAction(IpNetwork addr) Construct a new instance without specifying action order.
VTNSetInetSrcAction(IpNetwork addr, Integer ord) Construct a new instance with specifying action order.
VTNSetInetSrcAction(VtnSetInetSrcActionCase 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 VtnSetInetSrcActionCase	newVtnAction(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address addr) Create a new VtnSetInetSrcActionCase 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.
VTNSetInetSrcAction	toFlowFilterAction(VtnAction vact, Integer ord) Convert the given VtnAction instance into a FlowFilterAction instance.
VtnSetInetSrcActionCase	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.VTNInetAddrAction

appendContents, equals, getAddress, getDescription, getDescription, getMdAddress, hashCode, noIpAddress, 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

VTNSetInetSrcAction

public VTNSetInetSrcAction(IpNetwork addr)

Construct a new instance without specifying action order.

Parameters:

addr - An IpNetwork instance which represents the IP address to be set.

VTNSetInetSrcAction

public VTNSetInetSrcAction(IpNetwork addr,
                           Integer ord)

Construct a new instance with specifying action order.

Parameters:

addr - An IpNetwork instance which represents the IP address to be set.

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

VTNSetInetSrcAction

public VTNSetInetSrcAction(VtnSetInetSrcActionCase ac,
                           Integer ord)
                    throws RpcException

Construct a new instance.

Parameters:

ac - A VtnSetInetSrcActionCase 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 VtnSetInetSrcActionCase newVtnAction(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address addr)

Create a new VtnSetInetSrcActionCase instance.

Parameters:

addr - An Address instance which specifies the IP address.

Returns:

A VtnSetInetSrcActionCase instance.

toVtnAction

public VtnSetInetSrcActionCase 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 VTNSetInetSrcAction 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.