etri.sdn.controller.module.linkdiscovery

Class Links

java.lang.Object

etri.sdn.controller.OFModel

etri.sdn.controller.module.linkdiscovery.Links

public class Links
extends OFModel

Model of the module OFMLinkDiscovery

Author:

bjlee

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	Links.RESTLink class to convert Link information into JSON format.

Nested classes/interfaces inherited from class etri.sdn.controller.OFModel

OFModel.RESTApi, OFModel.RESTWebUI

Field Summary

Fields

Modifier and Type	Field and Description
private OFModel.RESTApi[]	apis All RESTApi objects associated with this model.
protected int	LINK_TIMEOUT Timeout as part of LLDP process
private java.util.Map<Link,LinkInfo>	links Association between a link and the link information
private java.util.concurrent.locks.ReentrantReadWriteLock	lock Lock for guaranteeing synchronized access to links;
private OFMLinkDiscovery	manager reference to the module of this model.
private java.util.Map<NodePortTuple,java.util.Set<Link>>	portBroadcastDomainLinks Set of link tuples over which multicast LLDPs are received and unicast LLDPs are not received.
private java.util.Map<NodePortTuple,java.util.Set<Link>>	portLinks Map from a id:port to the set of links containing it as an endpoint
private java.util.Map<java.lang.Long,java.util.Set<Link>>	switchLinks Map from switch id to a set of all links with it as an endpoint

Constructor Summary

Constructors

Constructor and Description
Links(OFMLinkDiscovery manager) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addLinkToBroadcastDomain(Link lt) Put a link into the map of portBroadcastDomainLinks.
private boolean	addOrUpdateLink(Link lt, LinkInfo newInfo) Add or Update a link information.
Link	addOrUpdateLink(long remoteSwitchId, int remotePort, org.openflow.protocol.interfaces.OFPortDesc remotePhyPort, long localSwitchId, int localInPort, org.openflow.protocol.interfaces.OFPortDesc localInPhyPort, boolean isStandard, boolean isReverse) Add or update link information. used by OFMLinkDiscovery.handleLldp method.
private void	deleteLinks(java.util.List<Link> links) Delete links from the switchLinks and portLinks structures.
void	deleteLinksOnPort(NodePortTuple npt) Delete all links associated with a NodePortTuple object.
OFModel.RESTApi[]	getAllRestApi() return the list of all RESTApi objects.
java.lang.String	getStringRepresentation() Get the string representation of portLinks.
void	removeLinkFromBroadcastDomain(Link lt) Remove a link from the map of portBroadcastDomainLinks.
void	timeoutLinks() Iterates through the list of links and deletes if the last discovery message reception time exceeds timeout values.
java.lang.String	toString() return the name of this Model.
boolean	updatePortStatus(java.lang.Long switchId, int portnum, org.openflow.protocol.interfaces.OFPortStatus ps) Update port status.

Methods inherited from class java.lang.Object

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

Field Detail

LINK_TIMEOUT

protected final int LINK_TIMEOUT

Timeout as part of LLDP process

See Also:

Constant Field Values

lock

private java.util.concurrent.locks.ReentrantReadWriteLock lock

Lock for guaranteeing synchronized access to links;

links

private java.util.Map<Link,LinkInfo> links

Association between a link and the link information

switchLinks

private java.util.Map<java.lang.Long,java.util.Set<Link>> switchLinks

Map from switch id to a set of all links with it as an endpoint

portLinks

private java.util.Map<NodePortTuple,java.util.Set<Link>> portLinks

Map from a id:port to the set of links containing it as an endpoint

portBroadcastDomainLinks

private java.util.Map<NodePortTuple,java.util.Set<Link>> portBroadcastDomainLinks

Set of link tuples over which multicast LLDPs are received and unicast LLDPs are not received.

manager

private OFMLinkDiscovery manager

reference to the module of this model.

apis

private OFModel.RESTApi[] apis

All RESTApi objects associated with this model.

Constructor Detail

Links

public Links(OFMLinkDiscovery manager)

Constructor

Parameters:

manager - reference to the module of this model

Method Detail

timeoutLinks

public void timeoutLinks()

Iterates through the list of links and deletes if the last discovery message reception time exceeds timeout values.

addLinkToBroadcastDomain

public void addLinkToBroadcastDomain(Link lt)

Put a link into the map of portBroadcastDomainLinks. Broadcast domain links are the links found via BDDP packets.

Parameters:

lt - link to put into the list.

removeLinkFromBroadcastDomain

public void removeLinkFromBroadcastDomain(Link lt)

Remove a link from the map of portBroadcastDomainLinks. Broadcast domain links are the links found via BDDP packets.

Parameters:

lt - link to remove

deleteLinksOnPort

public void deleteLinksOnPort(NodePortTuple npt)

Delete all links associated with a NodePortTuple object.

Parameters:

npt - a node-port tuple

addOrUpdateLink

public Link addOrUpdateLink(long remoteSwitchId,
                   int remotePort,
                   org.openflow.protocol.interfaces.OFPortDesc remotePhyPort,
                   long localSwitchId,
                   int localInPort,
                   org.openflow.protocol.interfaces.OFPortDesc localInPhyPort,
                   boolean isStandard,
                   boolean isReverse)

Add or update link information. used by OFMLinkDiscovery.handleLldp method. After creating the Link and LinkInfo object, (remote is set to source, and local is set to destination) this method first calls addOrUpdateLink(Link, LinkInfo) method. Then, if the LinkInfo is correctly set, search the LinkInfo object for the reverse link. If none, this method sends out a LLDP discovery for the reverse link by calling OFMLinkDiscovery.sendDiscoveryMessage(long, short, boolean, boolean). For a BDDP packet, this method just tries to enrolls the reverse link information by calling addOrUpdateLink(Link, LinkInfo).

updatePortStatus

public boolean updatePortStatus(java.lang.Long switchId,
                       int portnum,
                       org.openflow.protocol.interfaces.OFPortStatus ps)

Update port status. In result, listeners are notified on the link update. Used by OFMLinkDiscovery.handlePortStatus method.

Parameters:

switchId - switch identifier

portnum - port number

ps - OFPortStatus message

Returns:

true if link info changed, false otherwise

toString

public java.lang.String toString()

return the name of this Model.

Overrides:

toString in class java.lang.Object

getStringRepresentation

public java.lang.String getStringRepresentation()

Get the string representation of portLinks.

Returns:

String

deleteLinks

private void deleteLinks(java.util.List<Link> links)

Delete links from the switchLinks and portLinks structures. Called by deleteLinksOnPort(NodePortTuple).

Parameters:

links -

addOrUpdateLink

private boolean addOrUpdateLink(Link lt,
                      LinkInfo newInfo)

Add or Update a link information.

1. If link was first found, the link goes into links structure. If the link was discovered via BDDP packets, the links goes to the portBroadcastDomainLinks by calling addLinkToBroadcastDomain(Link).
2. If the found link exists, the information is updated. If the discovery method changes between LLDP and BDDP, the link is added to or removed from the portBroadcastDomainLinks structure.

Parameters:

lt - target link to update or add

newInfo - information of the link

Returns:

true if a link info is successfully updated or added. false otherwise.

getAllRestApi

public OFModel.RESTApi[] getAllRestApi()

return the list of all RESTApi objects.

Specified by:

getAllRestApi in class OFModel

Returns:

an array of RESTApi objects