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

Class VTNMacMapStatus

java.lang.Object

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

public final class VTNMacMapStatus
extends Object

VTNMacMapStatus describes the runtime information about a MAC mapping configured in a vBridge.

Constructor Summary

Constructors

Constructor and Description
VTNMacMapStatus() Construct an empty instance.
VTNMacMapStatus(MacMapStatus mms) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
org.apache.commons.lang3.tuple.Triple<Boolean,SalPort,PortVlan>	activate(MacMapIdentifier mapId, MacVlan mvlan, SalPort sport) Activate MAC mapping for the specified MAC address.
MacVlan	getDuplicate(MacVlan mvlan) Determine whether the MAC address same as the specified host is already mapped by the MAC mapping or not.
Set<PortVlan>	getNetworks() Return an unmodifiable set of PortVlan instances corresponding to VLAN where MAC mapping is activated.
SalPort	getPort(MacVlan mvlan) Determine the switch port where the specified host was detected.
PortVlan	getPortVlan(long mac) Determine the VLAN associated with the specified MAC address in the MAC mapping.
boolean	hasMapping() Determine whether at least one host is actually mapped by this MAC mapping or not.
boolean	hasMapping(PortVlan pvlan) Determine whether at least one host is mapped on the specified VLAN network or not.
Map<MacVlan,SalPort>	inactivate(MacMapIdentifier mapId, Set<MacVlan> allowed, Set<Integer> unmapped, Set<PortVlan> rels) Inactivate all MAC mappings which are no longer mapped.
SalPort	inactivate(MacVlan mvlan, Set<PortVlan> rels) Inactivate the MAC mapping for the specified MAC address.
Map<MacVlan,SalPort>	inactivate(PortFilter filter, Set<PortVlan> rels) Inactivate all MAC mappings detected on switch port accepted by the specified port filter.
Set<MacVlan>	inactivate(PortVlan pvlan) Inactivate all the MAC mappings detected on the specified VLAN.
boolean	isDirty() Determine whether this instance is modified or not.
void	submit(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, MacMapIdentifier ident) Put the MAC mapping status only if this instance is modified.
MacMapStatus	toMacMapStatus() Convert this instance into a MacMapStatus instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNMacMapStatus

public VTNMacMapStatus()

Construct an empty instance.

VTNMacMapStatus

public VTNMacMapStatus(MacMapStatus mms)

Construct a new instance.

Parameters:

mms - A MacMapStatus instance. Specifying null results in undefined behavior.

Method Detail

toMacMapStatus

public MacMapStatus toMacMapStatus()

Convert this instance into a MacMapStatus instance.

Returns:

A MacMapStatus instance.

isDirty

public boolean isDirty()

Determine whether this instance is modified or not.

Note that this method always clears the dirty flag in this instance.

Returns:

true if this instance is modified. false if not modified.

submit

public void submit(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                   MacMapIdentifier ident)

Put the MAC mapping status only if this instance is modified.

Parameters:

tx - A transaction for the MD-SAL datastore.

ident - A MacMapIdentifier instance that specifies the target MAC mapping.

activate

public org.apache.commons.lang3.tuple.Triple<Boolean,SalPort,PortVlan> activate(MacMapIdentifier mapId,
                                                                                MacVlan mvlan,
                                                                                SalPort sport)
                                                                         throws MacMapDuplicateException

Activate MAC mapping for the specified MAC address.

Parameters:

mapId - The identifier for the target MAC mapping.

mvlan - A MacVlan instance corresponding to a host to be activated.

sport - A SalPort instance corresponding to a switch port where the MAC address is detected.

Returns:

A Triple instance is returned if the MAC mapping was successfully activated.

• A boolean value that indicates the result is set to the left. true means that the target MAC mapping has been activated. false means that the target MAC mapping is already activated.
• A SalPort instance that specifies the physical switch port previously associated with the L2 host in the MAC mapping is set to the middle.
• A PortVlan instance that specifies the VLAN to be released is set to the right.

null is returned if the MAC mapping for the specified host is already activated.

Throws:

MacMapDuplicateException - The specified MAC address is already mapped by this MAC mapping.

inactivate

public SalPort inactivate(MacVlan mvlan,
                          Set<PortVlan> rels)

Inactivate the MAC mapping for the specified MAC address.

Parameters:

mvlan - A MacVlan instance corresponding to a host to be inactivated.

rels - A set of PortVlan to store VLAN networks to be released.

Returns:

A SalPort instance which was associated with the specified MacVlan instance is returned. null is returned if no switch port was associated.

inactivate

public Set<MacVlan> inactivate(PortVlan pvlan)

Inactivate all the MAC mappings detected on the specified VLAN.

Parameters:

pvlan - A PortVlan instance which specifies a pair of physical switch port and VLAN ID.

Returns:

A set of MacVlan instances that indicates inactivated MAC mappings. null if no MAC mapping was inactivated.

inactivate

public Map<MacVlan,SalPort> inactivate(PortFilter filter,
                                       Set<PortVlan> rels)
                                throws VTNException

Inactivate all MAC mappings detected on switch port accepted by the specified port filter.

Parameters:

filter - A PortFilter instance which selects switch ports.

rels - A set of PortVlan to store VLAN networks to be released.

Returns:

A map which contains pairs of unmapped host and port is returned.

Throws:

VTNException - An error occurred.

inactivate

public Map<MacVlan,SalPort> inactivate(MacMapIdentifier mapId,
                                       Set<MacVlan> allowed,
                                       Set<Integer> unmapped,
                                       Set<PortVlan> rels)

Inactivate all MAC mappings which are no longer mapped.

This method is used to inactivate MAC mappings which was mapped by an allowed host entry with a wildcard MAC address.

Parameters:

mapId - The identifier for the target MAC mapping.

allowed - A set of hosts to be mapped by MAC mapping explicitly.

unmapped - A set of VLAN IDs which was unmmaped.

rels - A set of PortVlan to store VLAN networks to be released.

Returns:

A map which contains pairs of unmapped host and port is returned.

getPort

public SalPort getPort(MacVlan mvlan)

Determine the switch port where the specified host was detected.

Parameters:

mvlan - A MacVlan instance which represents the layer 2 host address.

Returns:

A SalPort instance corresponding to a switch port associated with the specified host in this MAC mapping. null if the MAC mapping for the specified host is not active.

getPortVlan

public PortVlan getPortVlan(long mac)

Determine the VLAN associated with the specified MAC address in the MAC mapping.

Parameters:

mac - A long integer which represents MAC address of the host.

Returns:

A PortVlan instance which represents VLAN associated with the specified MAC address. null if the specified MAC address is not mapped by the MAC mapping.

hasMapping

public boolean hasMapping(PortVlan pvlan)

Determine whether at least one host is mapped on the specified VLAN network or not.

Parameters:

pvlan - A PortVlan instance which specifies a pair of physical switch port and VLAN ID.

Returns:

true is returned only if at least one host is mapped to the specified VLAN.

hasMapping

public boolean hasMapping()

Determine whether at least one host is actually mapped by this MAC mapping or not.

Returns:

true if at least one host is actually mapped by this MAC mapping. Otherwise false.

getNetworks

public Set<PortVlan> getNetworks()

Return an unmodifiable set of PortVlan instances corresponding to VLAN where MAC mapping is activated.

Returns:

A set of PortVlan instances. null is returned if no MAC mapping is activated.

getDuplicate

public MacVlan getDuplicate(MacVlan mvlan)

Determine whether the MAC address same as the specified host is already mapped by the MAC mapping or not.

Parameters:

mvlan - A MacVlan instance to be tested.

Returns:

A MacVlan instance is returned if another host which has the same MAC address as mvlan is already mapped. Otherwise null is returned.