org.opendaylight.vtn.manager.internal.util.packet

Class ArpPacketBuilder

java.lang.Object

org.opendaylight.vtn.manager.internal.util.packet.ArpPacketBuilder

public final class ArpPacketBuilder
extends Object

ArpPacketBuilder is a utility to build an ARP packet.

Constructor Summary

Constructors

Constructor and Description
ArpPacketBuilder() Construct a new instance that builds an ARP request to be sent to the untagged network.
ArpPacketBuilder(int vid) Construct a new instance that builds an ARP request to be sent to the specified VLAN.
ArpPacketBuilder(int vid, short op) Construct a new instance that builds an ARP packet.

Method Summary

Modifier and Type	Method and Description
Ethernet	build(EtherAddress src, EtherAddress dst, InetAddress addr) Create an Ethernet frame which contains an ARP request message to probe the given IP address.
Ethernet	build(EtherAddress src, EtherAddress dst, Ip4Network target) Create an Ethernet frame which contains an ARP message.
Ethernet	build(EtherAddress src, InetAddress addr) Create a broadcast Ethernet frame which contains an ARP request message to probe the given IP address.
ArpPacketBuilder	setSenderProtocolAddress(Ip4Network ip4) Set the sender protocol address.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArpPacketBuilder

public ArpPacketBuilder()

Construct a new instance that builds an ARP request to be sent to the untagged network.

ArpPacketBuilder

public ArpPacketBuilder(int vid)

Construct a new instance that builds an ARP request to be sent to the specified VLAN.

Parameters:

vid - The VLAN ID that specifies the VLAN. EtherHeader.VLAN_NONE indicates the untagged network.

ArpPacketBuilder

public ArpPacketBuilder(int vid,
                        short op)

Construct a new instance that builds an ARP packet.

Parameters:

vid - The VLAN ID that specifies the VLAN. EtherHeader.VLAN_NONE indicates the untagged network.

op - ARP operation code.

Method Detail

setSenderProtocolAddress

public ArpPacketBuilder setSenderProtocolAddress(Ip4Network ip4)

Set the sender protocol address.

Parameters:

ip4 - An Ip4Network instance which indicates the sender protocol address. Note that the prefix length is always ignored.

Returns:

This instance.

build

public Ethernet build(EtherAddress src,
                      InetAddress addr)

Create a broadcast Ethernet frame which contains an ARP request message to probe the given IP address.

Parameters:

src - An EtherAddress instance to be used as the source MAC address.

addr - The target IP address.

Returns:

An Ethernet frame. null is returned if addr is invalid.

build

public Ethernet build(EtherAddress src,
                      EtherAddress dst,
                      InetAddress addr)

Create an Ethernet frame which contains an ARP request message to probe the given IP address.

Parameters:

src - An EtherAddress instance to be used as the source MAC address.

dst - The destination MAC address.

addr - The target IP address.

Returns:

An Ethernet frame. null is returned if addr is invalid.

build

public Ethernet build(EtherAddress src,
                      EtherAddress dst,
                      Ip4Network target)

Create an Ethernet frame which contains an ARP message.

Parameters:

src - Source MAC address.

dst - Destination MAC address.

target - Target IP address.

Returns:

An Ethernet frame.