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

Class VTNIcmpMatch

java.lang.Object

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

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

public final class VTNIcmpMatch
extends VTNLayer4Match

VTNIcmpMatch describes the condition for ICMP header to match against packets.

Note that this class is not synchronized.

Constructor Summary

Constructors

Constructor and Description
VTNIcmpMatch() Construct a new instance that matches every ICMP packet.
VTNIcmpMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Icmpv4MatchFields imatch) Create a new instance from the given Icmpv4MatchFields instance.
VTNIcmpMatch(Short type, Short code) Construct a new instance.
VTNIcmpMatch(VtnIcmpMatchFields vimatch) Create a new instance from the given VtnIcmpMatchFields instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Determine whether the given object is identical to this object.
Short	getIcmpCode() Return the ICMP code to match against packets.
Short	getIcmpType() Return the ICMP type to match against packets.
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.
int	hashCode() Return the hash code of this object.
boolean	isEmpty() Determine whether this instance does not specify any header field or not.
boolean	match(FlowMatchContext ctx) Determine whether the given layer 4 protocol 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, 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.
VtnIcmpMatch	toVtnLayer4Match() Return a VtnIcmpMatch instance which contains the condition represented by this instance.
void	verify() Verify the contents of this instance.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.flow.match.VTNLayer4Match

create, create

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNIcmpMatch

public VTNIcmpMatch()

Construct a new instance that matches every ICMP packet.

VTNIcmpMatch

public VTNIcmpMatch(Short type,
                    Short code)
             throws RpcException

Construct a new instance.

Parameters:

type - The ICMP type to match. null matches every ICMP type.

code - The ICMP code to match. null matches every ICMP code.

Throws:

RpcException - The specified condition is invalid.

VTNIcmpMatch

public VTNIcmpMatch(VtnIcmpMatchFields vimatch)
             throws RpcException

Create a new instance from the given VtnIcmpMatchFields instance.

Parameters:

vimatch - An VtnIcmpMatchFields instance.

Throws:

NullPointerException - vimatch is null.

RpcException - vimatch contains invalid value.

VTNIcmpMatch

public VTNIcmpMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Icmpv4MatchFields imatch)
             throws RpcException

Create a new instance from the given Icmpv4MatchFields instance.

Parameters:

imatch - An Icmpv4MatchFields instance.

Throws:

NullPointerException - imatch is null.

RpcException - imatch contains invalid value.

Method Detail

getIcmpType

public Short getIcmpType()

Return the ICMP type to match against packets.

Returns:

A Short instance which indicates the ICMP type to match. null if the ICMP type is not specified.

getIcmpCode

public Short getIcmpCode()

Return the ICMP code to match against packets.

Returns:

A Short instance which indicates the ICMP code to match. null if the ICMP code is not specified.

verify

public void verify()
            throws RpcException

Verify the contents of this instance.

Specified by:

verify in class VTNLayer4Match

Throws:

RpcException - Verification failed.

getInetProtocol

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

Specified by:

getInetProtocol in class VTNLayer4Match

Parameters:

ver - An IpVersion instance which describes the IP version.

Returns:

An IP protocol number.

Throws:

IllegalStateException - ver is not IpVersion.Ipv4.

toVtnLayer4Match

public VtnIcmpMatch toVtnLayer4Match()

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

Specified by:

toVtnLayer4Match in class VTNLayer4Match

Returns:

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

setMatch

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

Specified by:

setMatch in class VTNLayer4Match

Parameters:

builder - A MatchBuilder instance.

ver - An IpVersion instance which describes the IP version.

Throws:

IllegalStateException - ver is not IpVersion.Ipv4.

match

public boolean match(FlowMatchContext ctx)

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

Specified by:

match in class VTNLayer4Match

Parameters:

ctx - A FlowMatchContext instance.

Returns:

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

setConditionKey

public void setConditionKey(StringBuilder builder)

Store strings used to construct flow condition key.

Specified by:

setConditionKey in class VTNLayer4Match

Parameters:

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

isEmpty

public boolean isEmpty()

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

Specified by:

isEmpty in class VTNLayer4Match

Returns:

true only if this instance is empty.

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.