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

Class VTNLayer4Match

java.lang.Object

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

Direct Known Subclasses:

VTNIcmpMatch, VTNLayer4PortMatch

public abstract class VTNLayer4Match
extends Object

VTNLayer4Match describes the condition for layer 4 protocol header to match against packets.

Note that this class is not synchronized.

Method Summary

Modifier and Type	Method and Description
static VTNLayer4Match	create(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Match match) Create a new instance from the given MD-SAL flow match.
static VTNLayer4Match	create(VtnLayer4Match vl4) Create a new instance from the given VtnLayer4Match instance.
abstract short	getInetProtocol(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion ver) Return an IP protocol number assigned to this protocol.
abstract boolean	isEmpty() Determine whether this instance does not specify any header field or not.
abstract boolean	match(FlowMatchContext ctx) Determine whether the given layer 4 protocol header matches the condition configured in this instance.
abstract void	setConditionKey(StringBuilder builder) Store strings used to construct flow condition key.
abstract void	setMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder builder, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion ver) Configure the condition represented by this instance into the given MD-SAL flow match builder.
abstract VtnLayer4Match	toVtnLayer4Match() Return a VtnLayer4Match instance which contains the condition represented by this instance.
abstract void	verify() Verify the contents of this instance.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static final VTNLayer4Match create(VtnLayer4Match vl4)
                                   throws RpcException

Create a new instance from the given VtnLayer4Match instance.

Parameters:

vl4 - A VtnLayer4Match instance.

Returns:

A VTNLayer4Match instance created from the given VtnLayer4Match instance. Note that null is returned if vl4 is null.

Throws:

RpcException - The given VtnLayer4Match instance is invalid.

create

public static final VTNLayer4Match create(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Match match)
                                   throws RpcException

Create a new instance from the given MD-SAL flow match.

Parameters:

match - A MD-SAL flow match.

Returns:

A VTNLayer4Match instance or null.

Throws:

NullPointerException - match is null.

RpcException - match contains invalid condition against layer 4 protocol header.

verify

public abstract void verify()
                     throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

getInetProtocol

public abstract short getInetProtocol(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion ver)

Return an IP protocol number assigned to this protocol.

Parameters:

ver - An IpVersion instance which describes the IP version.

Returns:

An IP protocol number.

Throws:

IllegalStateException - This layer 4 protocol is unavailable on the given IP version.

toVtnLayer4Match

public abstract VtnLayer4Match toVtnLayer4Match()

Return a VtnLayer4Match instance which contains the condition represented by this instance.

Returns:

A VtnLayer4Match instance if this instance contains the condition. null if this instance does not contain any condition.

setMatch

public abstract void setMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder builder,
                              org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion ver)

Configure the condition represented by this instance into the given MD-SAL flow match builder.

Parameters:

builder - A MatchBuilder instance.

ver - An IpVersion instance which describes the IP version.

match

public abstract boolean match(FlowMatchContext ctx)

Determine whether the given layer 4 protocol header matches the condition configured in this instance.

Parameters:

ctx - A FlowMatchContext instance.

Returns:

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

setConditionKey

public abstract void setConditionKey(StringBuilder builder)

Store strings used to construct flow condition key.

Parameters:

builder - A StringBuilder instance which contains strings used to construct flow condition key.

isEmpty

public abstract boolean isEmpty()

Determine whether this instance does not specify any header field or not.

Returns:

true only if this instance is empty.