org.opendaylight.vtn.manager.internal.vnode

Class MappingRegistry

java.lang.Object

org.opendaylight.vtn.manager.internal.vnode.MappingRegistry

public final class MappingRegistry
extends Object

A collection of utility class methods for virtual mapping management.

Method Summary

Modifier and Type	Method and Description
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacMapAllowed>	getAllowedPath(MacVlan mv) Return path to the MAC mapping that maps the specified L2 host.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacMapDenied>	getDeniedPath(MacVlan mv) Return path to the set of MAC mappings that denies the specified L2 host.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MapReferenceList>	getDeniedPath(MacVlan mv, String id) Return path to the MAC mapping that denies the specified L2 host.
static org.apache.commons.lang3.tuple.Pair<MacVlan,String>	getMacMapAllowed(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, MacVlan mv) Return an entry of the mac-map-allowed list that maps the specified host by MAC mapping.
static TenantNodeIdentifier<?,?>	getMapping(TxContext ctx, EtherAddress eaddr, SalPort sport, int vid) Return the identifier for the virtual network mapping which maps the specified host.
static MacMapIdentifier	getMapping(TxContext ctx, MacVlan mv) Return the identifier for the MAC mapping which maps the specified host.
static VNodeIdentifier<?>	getMapping(TxContext ctx, PortVlan pv) Return the identifier for the virtual network mapping which reserves the specified VLAN on a swtich port.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VlanMapping>	getPath(NodeVlan nv) Return path to the VLAN mapping associated with the given pair of switch and VLAN ID.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortMapping>	getPath(PortVlan pv) Return path to the port mapping associated with the given pair of switch port and VLAN ID.
static VlanMapIdentifier	getVlanMapping(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, SalPort sport, int vid) Return the identifier for the VLAN mapping which maps the specified VLAN on a switch port.
static boolean	inactivateMacMap(TxContext ctx, MacMapIdentifier mapId, PortFilter filter) Inactivate all the MAC mappings detected on switch ports specified by the port filter.
static boolean	isPortMapped(TxContext ctx, PortVlan pv) Determine whether the given pair of switch port and VLAN ID is mapped to the virtual interface or not.
static boolean	isVlanMapped(TxContext ctx, NodeVlan nv) Determine whether the given VLAN on a switch is mapped by VLAN mapping or not.
static void	logMacMapInactivated(MacMapIdentifier ident, MacVlan mv, SalPort sport) Record a trace log that notifies the specified MAC mapping has been inactivated.
static com.google.common.base.Optional<VlanMapping>	read(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, NodeVlan nv) Read the vlan-mapping container associated with the given pair of switch and VLAN ID.
static com.google.common.base.Optional<PortMapping>	read(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, PortVlan pv) Read the port-mapping container associated with the given pair of switch port and VLAN ID.
static com.google.common.base.Optional<MacMapAllowed>	readAllowed(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, MacVlan mv) Read the mac-map-allowed container associated with the given L2 host.
static Set<MacVlan>	readAllowedSet(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx) Read a set of L2 hosts present in the the mac-map-allowed container.
static com.google.common.base.Optional<MapReferenceList>	readDenied(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, MacVlan mv, String id) Read the map-reference-list container that indicates the denied host in the MAC mapping configuration.
static void	registerMacMap(TxContext ctx, MacMapIdentifier mapId, MacMapChange change) Register MAC mapping configuration.
static boolean	registerPortMap(TxContext ctx, VInterfaceIdentifier<?> ifId, PortVlan newPv, PortVlan oldPv, boolean purge) Register mapping between physical switch port and virtual interface.
static void	registerVlanMap(TxContext ctx, VlanMapIdentifier mapId, NodeVlan nvlan, boolean purge) Register mapping between vBridge and VLAN.
static void	releasePort(TxContext ctx, PortVlan pv, MacMapIdentifier ident) Release the specified VLAN on a switch port reserved by the MAC mapping.
static void	releasePort(TxContext ctx, Set<PortVlan> rels, MacMapIdentifier ident) Release the specified VLAN on a switch port reserved by the MAC mapping.
static void	unregisterVlanMap(TxContext ctx, VlanMapIdentifier mapId, NodeVlan nvlan, boolean purge) Unregister the VLAN mapping.

Methods inherited from class java.lang.Object

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

Method Detail

registerVlanMap

public static void registerVlanMap(TxContext ctx,
                                   VlanMapIdentifier mapId,
                                   NodeVlan nvlan,
                                   boolean purge)
                            throws VTNException

Register mapping between vBridge and VLAN.

• If nvlan specifies a VLAN network on a specific node and true is specified to purge, this method purges network caches corresponding to the network superseded by a new VLAN mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

mapId - The identifier for the VLAN mapping.

nvlan - A NodeVlan instance that specifies the VLAN to be mapped.

purge - If true, this method purges obsolete network caches as appropriate.

Throws:

VTNException - An error occurred.

unregisterVlanMap

public static void unregisterVlanMap(TxContext ctx,
                                     VlanMapIdentifier mapId,
                                     NodeVlan nvlan,
                                     boolean purge)
                              throws VTNException

Unregister the VLAN mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

mapId - The identifier for the VLAN mapping to be unregistered.

nvlan - A NodeVlan object which specifies the VLAN to be unmapped.

purge - If true is specified, this method purges caches corresponding to the unmapped VLAN.

Throws:

VTNException - A fatal error occurred.

registerPortMap

public static boolean registerPortMap(TxContext ctx,
                                      VInterfaceIdentifier<?> ifId,
                                      PortVlan newPv,
                                      PortVlan oldPv,
                                      boolean purge)
                               throws VTNException

Register mapping between physical switch port and virtual interface.

• If a non-null value is specified to oldPv, the port mapping that maps the VLAN specified by oldPv is removed in the same transaction. In this case the VLAN specified by oldPv must be currently mapped to the virtual interface specified by ifId.
• If true is specified to purge, this method purges network caches corresponding to obsolete mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

ifId - The identifier for the virtual interface which maps the specified VLAN.

newPv - A pair of physical switch port and VLAN ID to be mapped. No port mapping is registered if null is specified.

oldPv - A pair of physical switch port and VLAN ID to be unmapped. No port mapping is removed if null is specified.

purge - If true, this method purges obsolete network caches as appropriate.

Returns:

true if the port mapping was changed. false if not changed.

Throws:

VTNException - An error occurred.

registerMacMap

public static void registerMacMap(TxContext ctx,
                                  MacMapIdentifier mapId,
                                  MacMapChange change)
                           throws VTNException

Register MAC mapping configuration.

Parameters:

ctx - MD-SAL datastore transaction context.

mapId - The identifier for the MAC mapping.

change - A MacMapChange instance which keeps differences to be applied.

Throws:

MacMapConflictException - At least one host configured in the allowed host set is already mapped to vBridge by MAC mapping.

VTNException - An error occurred.

isPortMapped

public static boolean isPortMapped(TxContext ctx,
                                   PortVlan pv)
                            throws VTNException

Determine whether the given pair of switch port and VLAN ID is mapped to the virtual interface or not.

Parameters:

ctx - MD-SAL datastore transaction context.

pv - A pair of the switch port and VLAN ID.

Returns:

true if the given port is mapped to the virtual interface. false otherwise.

Throws:

VTNException - An error occurred.

isVlanMapped

public static boolean isVlanMapped(TxContext ctx,
                                   NodeVlan nv)
                            throws VTNException

Determine whether the given VLAN on a switch is mapped by VLAN mapping or not.

Parameters:

ctx - MD-SAL datastore transaction context.

nv - A pair of the switch and VLAN ID.

Returns:

true if the given port is mapped to the virtual interface. false otherwise.

Throws:

VTNException - An error occurred.

getMapping

public static TenantNodeIdentifier<?,?> getMapping(TxContext ctx,
                                                   EtherAddress eaddr,
                                                   SalPort sport,
                                                   int vid)
                                            throws VTNException

Return the identifier for the virtual network mapping which maps the specified host.

This method checks port mapping, MAC mapping, and VLAN mapping configurations in order, and returns the identifier for the virtual mapping found first.

Parameters:

ctx - MD-SAL datastore transaction context.

eaddr - An EtherAddress instance that specifies the host. Specifying null results in undefined behavior.

sport - A SalPort instance corresponding to the switch port where the specified host was detected. Specifying null results in undefined behavior.

vid - A VLAN ID.

Returns:

A TenantNodeIdentifier instance that specifies the virtual mapping if found. null is returned if not found.

Throws:

VTNException - An error occurred.

getMapping

public static VNodeIdentifier<?> getMapping(TxContext ctx,
                                            PortVlan pv)
                                     throws VTNException

Return the identifier for the virtual network mapping which reserves the specified VLAN on a swtich port.

This method searches for a port or MAC mapping which reserves the specified VLAN.

Parameters:

ctx - MD-SAL datastore transaction context.

pv - A PortVlan instance which represents a VLAN on a specific switch port.

Returns:

A VNodeIdentifier instance that specifies the virtual mapping if found. null is returned if not found.

Throws:

VTNException - An error occurred.

getMapping

public static MacMapIdentifier getMapping(TxContext ctx,
                                          MacVlan mv)
                                   throws VTNException

Return the identifier for the MAC mapping which maps the specified host.

Note that this method only sees the MAC mapping configuration. It never checks whether the MAC mapping is actually activated or not.

Parameters:

ctx - MD-SAL datastore transaction context.

mv - A MacVlan instance which specifies the L2 host.

Returns:

A MacMapIdentifier instance that maps the the specified host if found. null if not found.

Throws:

VTNException - An error occurred.

getMacMapAllowed

public static org.apache.commons.lang3.tuple.Pair<MacVlan,String> getMacMapAllowed(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                                                                   MacVlan mv)
                                                                            throws VTNException

Return an entry of the mac-map-allowed list that maps the specified host by MAC mapping.

This method only sees the MAC mapping configuration. It never checks whether the MAC mapping is actually activated or not.

Parameters:

rtx - A read-only transaction for the MD-SAL datastore.

mv - A MacVlan instance which specifies the L2 host.

Returns:

A pair of MacVlan instance and a string representation of MacMapIdentifier instance if found. null if not found.

Throws:

VTNException - An error occurred.

getVlanMapping

public static VlanMapIdentifier getVlanMapping(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                               SalPort sport,
                                               int vid)
                                        throws VTNException

Return the identifier for the VLAN mapping which maps the specified VLAN on a switch port.

Parameters:

rtx - A read-only transaction for the MD-SAL datastore.

sport - A SalPort instance corresponding to a switch port.

vid - A VLAN ID.

Returns:

A VlanMapIdentifier instance if found. null if not found.

Throws:

VTNException - An error occurred.

inactivateMacMap

public static boolean inactivateMacMap(TxContext ctx,
                                       MacMapIdentifier mapId,
                                       PortFilter filter)
                                throws VTNException

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

Note that this method never purges network caches corresponding to invalidated mappings, such as flow entry.

Parameters:

ctx - MD-SAL datastore transaction context.

mapId - The identifier for the target MAC mapping.

filter - A PortFilter instance which selects switch ports.

Returns:

true is returned if at least one host is still mapped by the MAC mapping. false is returned the specified MAC mapping is no longer active.

Throws:

VTNException - A fatal error occurred.

getPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortMapping> getPath(PortVlan pv)

Return path to the port mapping associated with the given pair of switch port and VLAN ID.

Parameters:

pv - A pair of the switch port and VLAN ID.

Returns:

Path to the port mapping associated with the given pair of switch port and VLAN ID.

getPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VlanMapping> getPath(NodeVlan nv)

Return path to the VLAN mapping associated with the given pair of switch and VLAN ID.

Parameters:

nv - A pair of the switch and VLAN ID.

Returns:

Path to the VLAN mapping associated with the given pair of switch and VLAN ID.

getAllowedPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacMapAllowed> getAllowedPath(MacVlan mv)

Return path to the MAC mapping that maps the specified L2 host.

Parameters:

mv - A MacVlan instance that specifies the L2 host.

Returns:

Path to the MAC mapping that maps the specified L2 host.

getDeniedPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacMapDenied> getDeniedPath(MacVlan mv)

Return path to the set of MAC mappings that denies the specified L2 host.

Parameters:

mv - A MacVlan instance that specifies the L2 host.

Returns:

Path to the set of MAC mappings that denies the specified L2 host.

getDeniedPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MapReferenceList> getDeniedPath(MacVlan mv,
                                                                                                         String id)

Return path to the MAC mapping that denies the specified L2 host. L2 host.

Parameters:

mv - A MacVlan instance that specifies the L2 host.

id - A string representation of the MAC mapping identifier.

Returns:

Path to the MAC mapping that denies the specified L2 host.

read

public static com.google.common.base.Optional<PortMapping> read(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                                                PortVlan pv)
                                                         throws VTNException

Read the port-mapping container associated with the given pair of switch port and VLAN ID.

Parameters:

rtx - A read-only transaction for the MD-SAL datastore.

pv - A pair of the switch port and VLAN ID.

Returns:

An Optional instance that contains the result of the read operation.

Throws:

VTNException - An error occurred.

read

public static com.google.common.base.Optional<VlanMapping> read(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                                                NodeVlan nv)
                                                         throws VTNException

Read the vlan-mapping container associated with the given pair of switch and VLAN ID.

Parameters:

rtx - A read-only transaction for the MD-SAL datastore.

nv - A pair of the switch and VLAN ID.

Returns:

An Optional instance that contains the result of the read operation.

Throws:

VTNException - An error occurred.

readAllowed

public static com.google.common.base.Optional<MacMapAllowed> readAllowed(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                                                         MacVlan mv)
                                                                  throws VTNException

Read the mac-map-allowed container associated with the given L2 host.

Parameters:

rtx - A read-only transaction for the MD-SAL datastore.

mv - A MacVlan instance that specifies the L2 host.

Returns:

An Optional instance that contains the result of the read operation.

Throws:

VTNException - An error occurred.

readAllowedSet

public static Set<MacVlan> readAllowedSet(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx)
                                   throws VTNException

Read a set of L2 hosts present in the the mac-map-allowed container.

Parameters:

rtx - A read-only transaction for the MD-SAL datastore.

Returns:

A set of MacVlan instances that indicates a set of keys present in the mac-map-allowed container.

Throws:

VTNException - An error occurred.

readDenied

public static com.google.common.base.Optional<MapReferenceList> readDenied(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                                                           MacVlan mv,
                                                                           String id)
                                                                    throws VTNException

Read the map-reference-list container that indicates the denied host in the MAC mapping configuration.

Parameters:

rtx - A read-only transaction for the MD-SAL datastore.

mv - A MacVlan instance that specifies the L2 host.

id - A string representation of the MAC mapping identifier.

Returns:

An Optional instance that contains the result of the read operation.

Throws:

VTNException - An error occurred.

releasePort

public static void releasePort(TxContext ctx,
                               PortVlan pv,
                               MacMapIdentifier ident)
                        throws VTNException

Release the specified VLAN on a switch port reserved by the MAC mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

pv - A PortVlan instance which represents a VLAN on a specific switch port.

ident - The identifier for the MAC mapping.

Throws:

VTNException - An error occurred.

releasePort

public static void releasePort(TxContext ctx,
                               Set<PortVlan> rels,
                               MacMapIdentifier ident)
                        throws VTNException

Release the specified VLAN on a switch port reserved by the MAC mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

rels - A set of PortVlan instances corresponding to VLANs on switch port.

ident - The identifier for the MAC mapping.

Throws:

VTNException - An error occurred.

logMacMapInactivated

public static void logMacMapInactivated(MacMapIdentifier ident,
                                        MacVlan mv,
                                        SalPort sport)

Record a trace log that notifies the specified MAC mapping has been inactivated.

Parameters:

ident - The identifier for the MAC mapping.

mv - A MacVlan instance that specifies the unmapped L2 host.

sport - A SalPort instance that specifies a switch port.