org.opendaylight.vtn.manager.internal.util.vnode.mac

Class MacEntry

java.lang.Object

org.opendaylight.vtn.manager.internal.util.vnode.mac.MacEntry

Direct Known Subclasses:

CurrentMacEntry, NewMacEntry

public abstract class MacEntry
extends Object

MacEntry describes a MAC address learned in the MAC address table associated with vBridge.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_IP_PROBE The maximum number of IP address probe request.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MacEntry(EtherAddress eaddr, SalPort sport, int vid) Construct a new instance.
protected	MacEntry(EtherAddress eaddr, SalPort sport, int vid, int probe) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
abstract void	addIpAddress(IpNetwork ip) Associate the given IP address with this MAC address table entry.
EtherAddress	getEtherAddress() Return the MAC address.
abstract List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress>	getIpAddresses() Return a list of IpAddress instances associated with this MAC address table entry.
abstract Set<IpNetwork>	getIpNetworkSet() Return a set of IpNetwork instances associated with this MAC address table entry.
abstract String	getMapPath() Return a string representation of VNodeIdentifier instance that specifies the virtual mapping corresponding to this entry.
abstract MacTableEntry	getNewEntry() Return the MAC address table entry to be put into the MD-SAL datastore.
SalPort	getPort() Return the physical switch port where the MAC address was detected.
int	getVlanId() Return the VLAN ID configured in the MAC address table entry.
boolean	hasMoved(SalPort sport, int vid, VNodeIdentifier<?> mpath) Determine whether the host corresponding to this MAC address table entry has moved or not.
boolean	needIpProbe() Determine whether a probe request for IP address should be sent or not.
protected MacTableEntryBuilder	set(MacTableEntryBuilder builder) Set values in this instance into the given builder instance.
abstract void	setDirty() Turn the dirty flag on so that this entry is put into the MD-SAL datastore.
String	toString() Return a string representation of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_IP_PROBE

public static final int MAX_IP_PROBE

The maximum number of IP address probe request.

See Also:

Constant Field Values

Constructor Detail

MacEntry

protected MacEntry(EtherAddress eaddr,
                   SalPort sport,
                   int vid)

Construct a new instance.

Parameters:

eaddr - An EtherAddress instance that indicates the MAC address.

sport - A SalPort instance that specifies the switch port where the MAC address was detected.

vid - The VLAN ID.

MacEntry

protected MacEntry(EtherAddress eaddr,
                   SalPort sport,
                   int vid,
                   int probe)

Construct a new instance.

Parameters:

eaddr - An EtherAddress instance that indicates the MAC address.

sport - A SalPort instance that specifies the switch port where the MAC address was detected.

vid - The VLAN ID.

probe - The number of IP address probe request.

Method Detail

getEtherAddress

public final EtherAddress getEtherAddress()

Return the MAC address.

Returns:

An EtherAddress instance.

getPort

public final SalPort getPort()

Return the physical switch port where the MAC address was detected.

Returns:

A SalPort instance that specifies the physical switch port.

getVlanId

public final int getVlanId()

Return the VLAN ID configured in the MAC address table entry.

Returns:

The VLAN ID. Zero implies that the MAC address was detected in an untagged Ethernet frame.

hasMoved

public final boolean hasMoved(SalPort sport,
                              int vid,
                              VNodeIdentifier<?> mpath)

Determine whether the host corresponding to this MAC address table entry has moved or not.

Parameters:

sport - A SalPort instance expected to be configured in this entry.

vid - A VLAN ID expected to be configured in this entry.

mpath - A VNodeIdentifier instance expected to be configured in this entry.

Returns:

true if the host corresponding to this instance has moved. false otherwise.

needIpProbe

public final boolean needIpProbe()

Determine whether a probe request for IP address should be sent or not.

Returns:

true if a probe request for IP address should be sent. false otherwise.

set

protected final MacTableEntryBuilder set(MacTableEntryBuilder builder)

Set values in this instance into the given builder instance.

Parameters:

builder - A MacTableEntryBuilder instance.

Returns:

builder is always returned.

addIpAddress

public abstract void addIpAddress(IpNetwork ip)

Associate the given IP address with this MAC address table entry.

Parameters:

ip - An IpNetwork instance.

getIpAddresses

public abstract List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getIpAddresses()

Return a list of IpAddress instances associated with this MAC address table entry.

Returns:

A list of IpAddress instances or null.

getIpNetworkSet

public abstract Set<IpNetwork> getIpNetworkSet()

Return a set of IpNetwork instances associated with this MAC address table entry.

Returns:

A set of IpNetwork instances. Note that this method must not return null.

getMapPath

public abstract String getMapPath()

Return a string representation of VNodeIdentifier instance that specifies the virtual mapping corresponding to this entry.

Returns:

A string that represents the identifier for the virtual mapping.

setDirty

public abstract void setDirty()

Turn the dirty flag on so that this entry is put into the MD-SAL datastore.

getNewEntry

public abstract MacTableEntry getNewEntry()

Return the MAC address table entry to be put into the MD-SAL datastore.

Returns:

A MacTableEntry instance if this entry needs to be put into the MD-SAL datastore. null otherwise.

toString

public final String toString()

Return a string representation of this instance.

Overrides:

toString in class Object

Returns:

A string representation of this instance.