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

Class VTNMatch

java.lang.Object

org.opendaylight.vtn.manager.internal.util.flow.match.VTNMatch

Direct Known Subclasses:

VTNFlowMatch

public class VTNMatch
extends Object

VTNMatch describes the condition to match against packtes.

Note that this class is not synchronized.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COND_KEY_SEPARATOR A separator used to construct flow condition key.

Constructor Summary

Constructors

Constructor and Description
VTNMatch() Create a new flow match that matches every packet.
VTNMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Match match) Construct a new flow match from the given Match instance.
VTNMatch(VTNEtherMatch ematch, VTNInetMatch imatch, VTNLayer4Match l4match) Construct a new flow match.

Method Summary

Modifier and Type	Method and Description
void	complete() Complete the flow conditions.
boolean	equals(Object o) Determine whether the given object is identical to this object.
String	getConditionKey() Create a condition key that identifies this flow match.
VTNEtherMatch	getEtherMatch() Return the condition against Ethernet header.
String	getFlowKey(SalNode snode, int pri, SalPort ingress) Create a flow condition key that identifies the flow entry.
VTNInetMatch	getInetMatch() Return the condition against IP header.
Short	getInetProtocol() Return the IP protocol specified by this match.
VTNLayer4Match	getLayer4Match() Return the condition against layer 4 protocol header.
int	hashCode() Return the hash code of this object.
boolean	match(FlowMatchContext ctx) Determine whether the given packet header matches the condition specified by this instance.
void	set(VtnMatchFields vmatch) Set flow conditions configured in the given VtnMatchFields instance.
DataFlowMatchBuilder	toDataFlowMatchBuilder() Return a DataFlowMatchBuilder instance which contains the flow conditions configured in this instance.
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder	toMatchBuilder() Return a MatchBuilder instance which contains the flow conditions configured in this instance.
void	verify() Verify the contents of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

COND_KEY_SEPARATOR

public static final String COND_KEY_SEPARATOR

A separator used to construct flow condition key.

See Also:

Constant Field Values

Constructor Detail

VTNMatch

public VTNMatch()

Create a new flow match that matches every packet.

VTNMatch

public VTNMatch(VTNEtherMatch ematch,
                VTNInetMatch imatch,
                VTNLayer4Match l4match)
         throws RpcException

Construct a new flow match.

Parameters:

ematch - A VTNEtherMatch instance which specifies the condition for Ethernet header.

imatch - A VTNInetMatch instance which specifies the condition for IP header.

l4match - A VTNLayer4Match instance which specifies the condition for layer 4 protocol header.

Throws:

RpcException - The specified condition is invalid.

VTNMatch

public VTNMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Match match)
         throws RpcException

Construct a new flow match from the given Match instance.

Note that this constructor does not complete the condition specified by the given Match instance.

Parameters:

match - A Match instance.

Throws:

RpcException - match contains invalid value.

Method Detail

set

public final void set(VtnMatchFields vmatch)
               throws RpcException

Set flow conditions configured in the given VtnMatchFields instance.

This method completes the condition specified by the given VtnMatchFields instance. For instance, ethernet type is added if IP condition is configured in the given VtnMatchFields instance.

Parameters:

vmatch - A VtnMatchFields instance.

Throws:

NullPointerException - vmatch is null.

RpcException - fmatch contains invalid value.

getEtherMatch

public final VTNEtherMatch getEtherMatch()

Return the condition against Ethernet header.

Returns:

A VTNEtherMatch instance. null if no condition is specified.

getInetMatch

public final VTNInetMatch getInetMatch()

Return the condition against IP header.

Returns:

A VTNInetMatch instance. null if no condition is specified.

getLayer4Match

public final VTNLayer4Match getLayer4Match()

Return the condition against layer 4 protocol header.

Returns:

A VTNLayer4Match instance. null if no condition is specified.

toDataFlowMatchBuilder

public DataFlowMatchBuilder toDataFlowMatchBuilder()

Return a DataFlowMatchBuilder instance which contains the flow conditions configured in this instance.

Returns:

A DataFlowMatchBuilder instance.

toMatchBuilder

public final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder toMatchBuilder()

Return a MatchBuilder instance which contains the flow conditions configured in this instance.

Returns:

A MatchBuilder instance.

getFlowKey

public final String getFlowKey(SalNode snode,
                               int pri,
                               SalPort ingress)

Create a flow condition key that identifies the flow entry.

Parameters:

snode - A SalNode corresponding to the target switch.

pri - Flow priority value.

ingress - A SalPort instance corresponding to the ingress switch port.

Returns:

A string which can be used to identify the flow entry.

getConditionKey

public final String getConditionKey()

Create a condition key that identifies this flow match.

Returns:

A string which can be used to identify this flow match.

verify

public void verify()
            throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

complete

public final void complete()
                    throws RpcException

Complete the flow conditions.

Throws:

RpcException - This flow match contains inconsistent conditions.

match

public final boolean match(FlowMatchContext ctx)

Determine whether the given packet header matches the condition specified by this instance.

Parameters:

ctx - A FlowMatchContext instance.

Returns:

true only if the given packet header matches all the conditions configured in this instance.

getInetProtocol

public final Short getInetProtocol()

Return the IP protocol specified by this match.

Returns:

A Short instance which represents the IP protocol number if this match specifies the IP protocol. null if this match does not specify the IP protocol.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class Object

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 Object

Returns:

The hash code.