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

Class VTNSetInetDscpAction

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

All Implemented Interfaces:

VTNIdentifiable<Integer>

public final class VTNSetInetDscpAction
extends FlowFilterAction

VTNSetInetDscpAction describes the flow action that sets the DSCP value into IP header.

Constructor Summary

Constructors

Constructor and Description
VTNSetInetDscpAction(short d) Construct a new instance without specifying action order.
VTNSetInetDscpAction(short d, Integer ord) Construct a new instance with specifying action order.
VTNSetInetDscpAction(VtnSetInetDscpActionCase ac, Integer ord) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	appendContents(StringBuilder builder) Append strings which represents the contents of this instance into the given StringBuilder instance.
boolean	apply(FlowActionContext ctx) Apply this flow action to the given packet.
boolean	equals(Object o) Determine whether the given object is identical to this object.
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.
short	getDscp() Return the DSCP value to be set.
int	hashCode() Return the hash code of this object.
static VtnSetInetDscpActionCase	newVtnAction(Short d) Create a new VtnSetInetDscpActionCase 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.
VTNSetInetDscpAction	toFlowFilterAction(VtnAction vact, Integer ord) Convert the given VtnAction instance into a FlowFilterAction instance.
VtnSetInetDscpActionCase	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.
protected void	verifyImpl() Verify the contents of this instance.

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

VTNSetInetDscpAction

public VTNSetInetDscpAction(short d)

Construct a new instance without specifying action order.

Parameters:

d - A DSCP value to be set.

VTNSetInetDscpAction

public VTNSetInetDscpAction(short d,
                            Integer ord)

Construct a new instance with specifying action order.

Parameters:

d - A DSCP value to be set.

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

VTNSetInetDscpAction

public VTNSetInetDscpAction(VtnSetInetDscpActionCase ac,
                            Integer ord)
                     throws RpcException

Construct a new instance.

Parameters:

ac - A VtnSetInetDscpActionCase 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 VtnSetInetDscpActionCase newVtnAction(Short d)

Create a new VtnSetInetDscpActionCase instance.

Parameters:

d - A Short instance which specifies the DSCP value.

Returns:

A VtnSetInetDscpActionCase instance.

getDscp

public short getDscp()

Return the DSCP value to be set.

Returns:

The DSCP value to be set.

toVtnAction

public VtnSetInetDscpActionCase 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.

appendContents

protected void appendContents(StringBuilder builder)

Append strings which represents the contents of this instance into the given StringBuilder instance.

Overrides:

appendContents in class FlowFilterAction

Parameters:

builder - A StringBuilder instance.

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

verifyImpl

protected void verifyImpl()
                   throws RpcException

Verify the contents of this instance.

Specified by:

verifyImpl in class FlowFilterAction

Throws:

RpcException - Verification failed.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class FlowFilterAction

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class FlowFilterAction

Returns:

The hash code.