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

Class VTNLayer4PortMatch<H extends Layer4PortHeader>

java.lang.Object

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

org.opendaylight.vtn.manager.internal.util.flow.match.VTNLayer4PortMatch<H>

Type Parameters:

H - The type of packet header.

Direct Known Subclasses:

VTNTcpMatch, VTNUdpMatch

public abstract class VTNLayer4PortMatch<H extends Layer4PortHeader>
extends VTNLayer4Match

VTNLayer4PortMatch describes the condition for IP port numbers to match against packets.

Note that this class is not synchronized.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Determine whether the given object is identical to this object.
abstract FlowMatchType	getDestinationMatchType() Return a flow match type corresponding to the destination port.
VTNPortRange	getDestinationPort() Return the range of the destination port number to match against packet.
abstract Class<H>	getHeaderType() Return a class which represents the packet header type.
abstract FlowMatchType	getSourceMatchType() Return a flow match type corresponding to the source port.
VTNPortRange	getSourcePort() Return the range of the source port number to match against packet.
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	verify() Verify the contents of this instance.

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

create, create, getInetProtocol, setMatch, toVtnLayer4Match

Methods inherited from class java.lang.Object

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

Method Detail

getSourcePort

public final VTNPortRange getSourcePort()

Return the range of the source port number to match against packet.

Returns:

A VTNPortRange instance if the range of the source port number is specified. null if not specified.

getDestinationPort

public final VTNPortRange getDestinationPort()

Return the range of the destination port number to match against packet.

Returns:

A VTNPortRange instance if the range of the destination port number is specified. null if not specified.

getHeaderType

public abstract Class<H> getHeaderType()

Return a class which represents the packet header type.

Returns:

A class associated with the packet header type.

getSourceMatchType

public abstract FlowMatchType getSourceMatchType()

Return a flow match type corresponding to the source port.

Returns:

A FlowMatchType instance.

getDestinationMatchType

public abstract FlowMatchType getDestinationMatchType()

Return a flow match type corresponding to the destination port.

Returns:

A FlowMatchType instance.

verify

public final void verify()
                  throws RpcException

Verify the contents of this instance.

Specified by:

verify in class VTNLayer4Match

Throws:

RpcException - Verification failed.

match

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