org.opendaylight.vtn.manager.internal.packet.cache

Class EtherPacket

java.lang.Object

org.opendaylight.vtn.manager.internal.packet.cache.EtherPacket

All Implemented Interfaces:

Cloneable, CachedPacket, EtherHeader, ProtocolHeader

public final class EtherPacket
extends Object
implements CachedPacket, EtherHeader

EtherPacket class implements a cache for a Ethernet instance including VLAN tag.

Field Summary

Fields inherited from interface org.opendaylight.vtn.manager.internal.util.packet.EtherHeader

VLAN_NONE

Constructor Summary

Constructors

Constructor and Description
EtherPacket(Ethernet ether) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
EtherPacket	clone() Return a deep copy of this instance.
boolean	commit(CachedPacketContext pctx) Finalize modification to the packet.
VTNEtherMatch	createMatch(Set<FlowMatchType> fields) Construct match fields to test Ethernet header in this packet.
EtherAddress	getDestinationAddress() Return the destination MAC address.
int	getEtherType() Return the ethernet type.
int	getOriginalVlan() Return the VLAN ID in the original Ethernet frame.
Ethernet	getPacket() Return an Ethernet instance configured in this instance.
Packet	getPayload() Return the payload in the Ethernet frame.
byte[]	getRawPayload() Return the unparsed payload in the Ethernet frame.
EtherAddress	getSourceAddress() Return the source MAC address.
int	getVlanId() Return the VLAN ID in the IEEE 802.1Q VLAN tag.
short	getVlanPriority() Return the VLAN priority value in the IEEE 802.1Q VLAN tag.
IEEE8021Q	getVlanTag() Return the VLAN tag in the Ethernet frame.
void	setDescription(StringBuilder builder) Set a brief description into the given string builder.
void	setDestinationAddress(EtherAddress mac) Set the destination MAC address.
void	setPayload(Packet packet) Set the payload of the Ethernet frame.
void	setSourceAddress(EtherAddress mac) Set the source MAC address.
void	setVlanId(int vid) Set the VLAN ID to the IEEE 802.1Q VLAN tag.
void	setVlanPriority(short pcp) Set the VLAN priority value to the IEEE 802.1Q VLAN tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

EtherPacket

public EtherPacket(Ethernet ether)

Construct a new instance.

Parameters:

ether - An Ethernet instance.

Method Detail

getOriginalVlan

public int getOriginalVlan()

Return the VLAN ID in the original Ethernet frame.

Returns:

A short value which represents the VLAN ID. Zero is returned if no VLAN tag was found in the original Ethernet frame.

getVlanTag

public IEEE8021Q getVlanTag()

Return the VLAN tag in the Ethernet frame.

Note that this method returns the VLAN tag in the original Ethernet frame. Any modification to VLAN tag is never applied to the returned value even if commit(CachedPacketContext) is called.

Returns:

An IEEE8021Q instance which represents the VLAN tag. null is returned if no VLAN tag was found in the Ethernet frame.

getPayload

public Packet getPayload()

Return the payload in the Ethernet frame.

Returns:

A Packet instance which represents the payload.

setPayload

public void setPayload(Packet packet)

Set the payload of the Ethernet frame.

Parameters:

packet - The payload of the Ethernet frame.

getRawPayload

public byte[] getRawPayload()

Return the unparsed payload in the Ethernet frame.

Returns:

A byte array which represents the payload in the Ethernet frame.

createMatch

public VTNEtherMatch createMatch(Set<FlowMatchType> fields)
                          throws RpcException

Construct match fields to test Ethernet header in this packet.

Note that this method creates match fields that matches the original packet. Any modification to the packet is ignored.

Parameters:

fields - A set of FlowMatchType instances corresponding to match fields to be tested.

Returns:

A VTNEtherMatch instance.

Throws:

RpcException - This packet is broken.

getPacket

public Ethernet getPacket()

Return an Ethernet instance configured in this instance.

Note that this method returns the original ethernet frame. Any modification to Ethernet header field is never applied to the returned value even if commit(CachedPacketContext) is called.

Specified by:

getPacket in interface CachedPacket

Returns:

An Ethernet instance.

commit

public boolean commit(CachedPacketContext pctx)

Finalize modification to the packet.

Specified by:

commit in interface CachedPacket

Parameters:

pctx - The runtime context for modifying packet.

Returns:

true only if this packet is modified.

clone

public EtherPacket clone()

Return a deep copy of this instance.

Note that this method does not copy the original Ethernet header and VLAN tag because this class never modifies them.

Specified by:

clone in interface CachedPacket

Overrides:

clone in class Object

Returns:

A deep copy of this instance.

getSourceAddress

public EtherAddress getSourceAddress()

Return the source MAC address.

Specified by:

getSourceAddress in interface EtherHeader

Returns:

An EtherAddress instance which represents the source MAC address.

setSourceAddress

public void setSourceAddress(EtherAddress mac)

Set the source MAC address.

Specified by:

setSourceAddress in interface EtherHeader

Parameters:

mac - An EtherAddress instance which represents the source MAC address.

getDestinationAddress

public EtherAddress getDestinationAddress()

Return the destination MAC address.

Specified by:

getDestinationAddress in interface EtherHeader

Returns:

An EtherAddress instance which represents the destination MAC address.

setDestinationAddress

public void setDestinationAddress(EtherAddress mac)

Set the destination MAC address.

Specified by:

setDestinationAddress in interface EtherHeader

Parameters:

mac - An EtherAddress instance which represents the destination MAC address.

getEtherType

public int getEtherType()

Return the ethernet type.

Specified by:

getEtherType in interface EtherHeader

Returns:

An integer value which represents the ethernet type.

getVlanId

public int getVlanId()

Return the VLAN ID in the IEEE 802.1Q VLAN tag.

Specified by:

getVlanId in interface EtherHeader

Returns:

A VLAN ID in the VLAN tag. EtherHeader.VLAN_NONE is returned if this frame does not contain a VLAN tag.

setVlanId

public void setVlanId(int vid)

Set the VLAN ID to the IEEE 802.1Q VLAN tag.

Specified by:

setVlanId in interface EtherHeader

Parameters:

vid - A VLAN ID in the VLAN tag. If EtherHeader.VLAN_NONE is specified, the VLAN tag will be removed.

getVlanPriority

public short getVlanPriority()

Return the VLAN priority value in the IEEE 802.1Q VLAN tag.

Specified by:

getVlanPriority in interface EtherHeader

Returns:

A byte value which represents the VLAN priority. A negative value is returned if the VLAN priority is not configured in this instance.

setVlanPriority

public void setVlanPriority(short pcp)

Set the VLAN priority value to the IEEE 802.1Q VLAN tag.

Specified by:

setVlanPriority in interface EtherHeader

Parameters:

pcp - A byte value which represents the VLAN priority.

setDescription

public void setDescription(StringBuilder builder)

Set a brief description into the given string builder.

Specified by:

setDescription in interface ProtocolHeader

Parameters:

builder - A StringBuilder instance.