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

Class VTNEtherMatch

java.lang.Object

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

public final class VTNEtherMatch
extends Object

VTNEtherMatch describes the condition for ethernet header to match against packets.

Note that this class is not synchronized.

Constructor Summary

Constructors

Constructor and Description
VTNEtherMatch() Construct a new instance that matches every packet.
VTNEtherMatch(EtherAddress src, EtherAddress dst, Integer type, Integer vid, Short pcp) Construct a new instance.
VTNEtherMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.EthernetMatchFields ematch, org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.VlanMatchFields vmatch) Construct a new instance from the given EthernetMatchFields and VlanMatchFields instances.
VTNEtherMatch(Integer type) Construct a new instance that matches the given Ethernet type.
VTNEtherMatch(VtnEtherMatchFields vematch) Construct a new instance from the given VtnEtherMatchFields.

Method Summary

Modifier and Type	Method and Description
static VTNEtherMatch	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.
boolean	equals(Object o) Determine whether the given object is identical to this object.
EtherAddress	getDestinationAddress() Return the destination MAC address to match against packets.
Integer	getEtherType() Return the ethernet type to match against packets.
EtherAddress	getSourceAddress() Return the source MAC address to match against packets.
Integer	getVlanId() Return the VLAN ID to match against packets.
Short	getVlanPriority() Return the VLAN priority to match against packets.
int	hashCode() Return the hash code of this object.
boolean	isEmpty() Determine whether this instance does not specify any Ethernet header field or not.
boolean	match(FlowMatchContext ctx) Determine whether the given Ethernet header matches the condition configured in this instance.
void	setConditionKey(StringBuilder builder) Store strings used to construct flow condition key.
void	setEtherType(Integer type) Set the ethernet type to match against packets.
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.
VtnEtherMatchBuilder	toVtnEtherMatchBuilder() Return a VtnEtherMatchBuilder 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

Constructor Detail

VTNEtherMatch

public VTNEtherMatch()

Construct a new instance that matches every packet.

VTNEtherMatch

public VTNEtherMatch(Integer type)

Construct a new instance that matches the given Ethernet type.

Parameters:

type - An Integer instance whcih represents the ethernet type to match against packets. null matches every ethernet type.

VTNEtherMatch

public VTNEtherMatch(EtherAddress src,
                     EtherAddress dst,
                     Integer type,
                     Integer vid,
                     Short pcp)
              throws RpcException

Construct a new instance.

Parameters:

src - An EtherAddress instance which specifies the source MAC address. null matches every source MAC address.

dst - An EtherAddress instance which specifies the destination MAC address. null matches every destination MAC address.

type - An Integer instance whcih specifies the ethernet type. null matches every ethernet type.

vid - The VLAN ID to match. EtherHeader.VLAN_NONE matches untagged frame. null matches every VLAN frame, including untagged frame.

pcp - The VLAN priority to match. null matches every VLAN priority.

Throws:

RpcException - The specified condition is invalid.

VTNEtherMatch

public VTNEtherMatch(VtnEtherMatchFields vematch)
              throws RpcException

Construct a new instance from the given VtnEtherMatchFields.

Parameters:

vematch - A VtnEtherMatchFields instance.

Throws:

NullPointerException - vematch is null.

RpcException - vematch contains invalid value.

VTNEtherMatch

public VTNEtherMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.EthernetMatchFields ematch,
                     org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.VlanMatchFields vmatch)
              throws RpcException

Construct a new instance from the given EthernetMatchFields and VlanMatchFields instances.

Parameters:

ematch - A EthernetMatchFields instance.

vmatch - A VlanMatchFields instance.

Throws:

RpcException - ematch or vmatch contains invalid value.

Method Detail

create

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

Throws:

NullPointerException - match is null.

RpcException - match contains invalid condition against Ethernet header.

getSourceAddress

public EtherAddress getSourceAddress()

Return the source MAC address to match against packets.

Returns:

An EtherAddress instance if the source MAC address is specified. null if not specified.

getDestinationAddress

public EtherAddress getDestinationAddress()

Return the destination MAC address to match against packets.

Returns:

An EtherAddress instance if the destination MAC address is specified. null if not specified.

getEtherType

public Integer getEtherType()

Return the ethernet type to match against packets.

Returns:

An Integer instance if the ethernet type is specified. null if not specified.

setEtherType

public void setEtherType(Integer type)
                  throws RpcException

Set the ethernet type to match against packets.

Parameters:

type - An Integer instance whcih represents the ethernet type to match against packets. null matches every ethernet type.

Throws:

RpcException - The Ethernet type different from the given type is already configured in this instance.

getVlanId

public Integer getVlanId()

Return the VLAN ID to match against packets.

Returns:

A Integer instance if the VLAN ID is specified. Note that EtherHeader.VLAN_NONE matches packets that have no VLAN tag. null if the VLAN ID is not specified.

getVlanPriority

public Short getVlanPriority()

Return the VLAN priority to match against packets.

Returns:

A Short instance if the VLAN priority is specified. null if the VLAN priority is not specified.

toVtnEtherMatchBuilder

public VtnEtherMatchBuilder toVtnEtherMatchBuilder()

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

Returns:

A VtnEtherMatchBuilder 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 boolean match(FlowMatchContext ctx)

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

Parameters:

ctx - A FlowMatchContext instance.

Returns:

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

setConditionKey

public 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 void verify()
            throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

isEmpty

public boolean isEmpty()

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

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.