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

Class VTNInetMatch

java.lang.Object

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

Direct Known Subclasses:

VTNInet4Match

public abstract class VTNInetMatch
extends Object

VTNInetMatch describes the condition for IP header to match against packets.

Note that this class is not synchronized.

Method Summary

Modifier and Type	Method and Description
static VTNInetMatch	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 VTNInetMatch	create(VTNEtherMatch eth, VtnInetMatch ip) Construct a new instance from the given pair of VTNEtherMatch and VtnInetMatch instances.
boolean	equals(Object o) Determine whether the given object is identical to this object.
IpNetwork	getDestinationNetwork() Return the destination IP network to match against packets.
Short	getDscp() Return the IP DSCP field value to match against packets.
abstract int	getEtherType() Return an Ethernet type assigned to this IP protocol version.
abstract Class<? extends IpNetwork>	getIpNetworkType() Return a class to represent an IP address.
abstract org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion	getIpVersion() Return An IpVersion instance which describes the IP version.
Short	getProtocol() Return the IP protocol number to match against packets.
IpNetwork	getSourceNetwork() Return the source IP network to match against packets.
int	hashCode() Return the hash code of this object.
boolean	isEmpty() Determine whether this instance does not specify any IP header field or not.
boolean	match(FlowMatchContext ctx) Determine whether the given IP header matches the condition configured in this instance.
void	setConditionKey(StringBuilder builder) Store strings used to construct flow condition key.
void	setMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder builder) Configure the condition represented by this instance into the given MD-SAL flow match builder.
void	setProtocol(Short proto) Set the IP protocol number to match against packets.
VtnInetMatchBuilder	toVtnInetMatchBuilder() Return a VtnInetMatchBuilder instance which contains the flow condition 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

Method Detail

create

public static final VTNInetMatch create(VTNEtherMatch eth,
                                        VtnInetMatch ip)
                                 throws RpcException

Construct a new instance from the given pair of VTNEtherMatch and VtnInetMatch instances.

Parameters:

eth - A VTNEtherMatch instance.

ip - A VtnInetMatch instance.

Returns:

A VTNInetMatch instance or null.

Throws:

RpcException - The given condition is invalid.

create

public static VTNInetMatch 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 VTNInetMatch instance or null.

Throws:

NullPointerException - match is null.

RpcException - match contains invalid condition against IP header.

getSourceNetwork

public final IpNetwork getSourceNetwork()

Return the source IP network to match against packets.

Returns:

An IpNetwork instance if the source IP network is specified. null if not specified.

getDestinationNetwork

public final IpNetwork getDestinationNetwork()

Return the destination IP network to match against packets.

Returns:

An IpNetwork instance if the destination IP network is specified. null if not specified.

getProtocol

public final Short getProtocol()

Return the IP protocol number to match against packets.

Returns:

A Short instance if the IP protocol number is specified. null if not specified.

setProtocol

public final void setProtocol(Short proto)
                       throws RpcException

Set the IP protocol number to match against packets.

Parameters:

proto - A Short instance which represents the IP protocol number to match against packets. null matches every IP protocol.

Throws:

RpcException - The IP protocol number different from the given number is already configured in this instance.

getDscp

public final Short getDscp()

Return the IP DSCP field value to match against packets.

Returns:

A Short instance if the IP DSCP value is specified. null if not specified.

toVtnInetMatchBuilder

public final VtnInetMatchBuilder toVtnInetMatchBuilder()

Return a VtnInetMatchBuilder instance which contains the flow condition configured in this instance.

Returns:

A VtnInetMatchBuilder instance.

setMatch

public void setMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder builder)

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

Parameters:

builder - A MatchBuilder instance.

match

public final boolean match(FlowMatchContext ctx)

Determine whether the given IP header matches the condition configured in this instance.

The caller has to guarantee that the IP protocol version of the IP header matches this instance.

Parameters:

ctx - A FlowMatchContext instance.

Returns:

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

setConditionKey

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

verify

public final void verify()
                  throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

isEmpty

public final boolean isEmpty()

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

Returns:

true only if this instance is empty.

getEtherType

public abstract int getEtherType()

Return an Ethernet type assigned to this IP protocol version.

Returns:

An Ethernet type.

getIpNetworkType

public abstract Class<? extends IpNetwork> getIpNetworkType()

Return a class to represent an IP address.

Returns:

A class to represent an IP address.

getIpVersion

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

Return An IpVersion instance which describes the IP version.

Returns:

An IpVersion instance.

equals

public final 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 final int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class Object

Returns:

The hash code.