org.onosproject.ospf.controller.area

Class OspfAreaImpl

java.lang.Object

org.onosproject.ospf.controller.area.OspfAreaImpl

All Implemented Interfaces:

org.onosproject.ospf.controller.OspfArea

public class OspfAreaImpl
extends Object
implements org.onosproject.ospf.controller.OspfArea

Representation an OSPF area and related information.

Constructor Summary

Constructors

Constructor and Description
OspfAreaImpl() Creates an instance of area implementation.

Method Summary

Modifier and Type	Method and Description
void	addLsa(org.onosproject.ospf.controller.OspfLsa ospfLsa, boolean isSelfOriginated, org.onosproject.ospf.controller.OspfInterface ospfInterface) Methods gets called from ChannelHandler to add the received LSA to LSDB.
void	addLsa(org.onosproject.ospf.controller.OspfLsa ospfLsa, org.onosproject.ospf.controller.OspfInterface ospfInterface) Methods gets called from ChannelHandler to add the received LSA to LSDB.
void	addLsaToMaxAgeBin(String key, org.onosproject.ospf.controller.LsaWrapper wrapper) Adds the LSA to maxAge bin.
List<org.onosproject.ospf.controller.OspfAreaAddressRange>	addressRanges() Gets address range.
void	addToOtherNeighborLsaTxList(org.onosproject.ospf.protocol.lsa.LsaHeader recLsa) Adds the received LSA in other neighbors tx list.
org.onlab.packet.Ip4Address	areaId() Gets the area id.
org.onosproject.ospf.protocol.lsa.types.NetworkLsa	buildNetworkLsa(org.onlab.packet.Ip4Address interfaceIp, org.onlab.packet.Ip4Address mask) Builds a network LSA.
org.onosproject.ospf.protocol.lsa.types.RouterLsa	buildRouterLsa(org.onosproject.ospf.controller.OspfInterface ospfInterface) Builds Router LSA.
org.onosproject.ospf.controller.OspfLsdb	database() Gets the lsdb instance for this area.
void	deleteLsa(org.onosproject.ospf.protocol.lsa.LsaHeader ospfLsa) Methods gets called from ChannelHandler to delete the LSA.
boolean	equals(Object o)
List<org.onosproject.ospf.controller.OspfInterface>	getInterfacesLst() Gets the list of interfaces in this area.
org.onosproject.ospf.controller.LsaWrapper	getLsa(int lsType, String linkStateID, String advertisingRouter) Gets the LSA from LSDB based on the input.
List	getLsaHeaders(boolean excludeMaxAgeLsa, boolean isOpaquecapable) Gets header of all types of LSAs.
String	getLsaKey(org.onosproject.ospf.protocol.lsa.LsaHeader lsaHeader) Gets the LSDB LSA key from LSA header.
List<org.onosproject.ospf.controller.OspfNbr>	getNeighborsInFullState(org.onosproject.ospf.controller.OspfInterface ospfInterface) Checks all Neighbors belonging to this Area whether they are in state lesser than the EXCHANGE.
int	hashCode()
void	initializeDb() Initializes link state database.
boolean	isExternalRoutingCapability() Gets external routing capability.
String	isNewerOrSameLsa(org.onosproject.ospf.controller.OspfLsa lsa1, org.onosproject.ospf.controller.OspfLsa lsa2) Checks whether an instance of the given LSA exists in the database belonging to this area.
boolean	isOpaqueEnabled() Gets is opaque enabled or not.
boolean	isTransitCapability() Gets is transit capable or not.
org.onosproject.ospf.controller.LsaWrapper	lsaLookup(org.onosproject.ospf.controller.OspfLsa lookupLsa) Checks whether an instance of the given LSA exists in the database belonging to this area.
boolean	noNeighborInLsaExchangeProcess() Checks all neighbors belonging to this area whether they are in state EXCHANGE or LOADING.
int	opaqueEnabledOptions() Gets the opaque enabled options value.
int	options() Gets the options value.
void	refreshArea(org.onosproject.ospf.controller.OspfInterface ospfInterface) Refreshes the OSPF area information .
void	removeLsaFromBin(org.onosproject.ospf.controller.LsaWrapper lsaWrapper) Removes LSA from bin.
org.onlab.packet.Ip4Address	routerId() Gets the router id.
void	setAddressRanges(List<org.onosproject.ospf.controller.OspfAreaAddressRange> addressRanges) Sets the area address ranges.
void	setAreaId(org.onlab.packet.Ip4Address areaId) Sets the area id.
void	setDbRouterSequenceNumber(long newSequenceNumber) Sets router sequence number for router LSA.
void	setExternalRoutingCapability(boolean externalRoutingCapability) Sets external routing capability.
void	setInterfacesLst(List<org.onosproject.ospf.controller.OspfInterface> interfacesLst) Sets the list of interfaces attached to the area.
void	setIsOpaqueEnabled(boolean isOpaqueEnable) Sets opaque enabled to true or false.
void	setOptions(int options) Sets the options value.
void	setRouterId(org.onlab.packet.Ip4Address routerId) Sets the router id.
void	setStubCost(int stubCost) Sets the stub cost.
void	setTransitCapability(boolean transitCapability) Sets transit capability.
int	stubCost() Gets the stub cost.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OspfAreaImpl

public OspfAreaImpl()

Creates an instance of area implementation.

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

routerId

public org.onlab.packet.Ip4Address routerId()

Gets the router id.

Specified by:

routerId in interface org.onosproject.ospf.controller.OspfArea

Returns:

router id

setRouterId

public void setRouterId(org.onlab.packet.Ip4Address routerId)

Sets the router id.

Specified by:

setRouterId in interface org.onosproject.ospf.controller.OspfArea

Parameters:

routerId - router id

setIsOpaqueEnabled

public void setIsOpaqueEnabled(boolean isOpaqueEnable)

Sets opaque enabled to true or false.

Specified by:

setIsOpaqueEnabled in interface org.onosproject.ospf.controller.OspfArea

Parameters:

isOpaqueEnable - true if opaque enabled else false

isOpaqueEnabled

public boolean isOpaqueEnabled()

Gets is opaque enabled or not.

Specified by:

isOpaqueEnabled in interface org.onosproject.ospf.controller.OspfArea

Returns:

true if opaque enabled else false

initializeDb

public void initializeDb()

Initializes link state database.

Specified by:

initializeDb in interface org.onosproject.ospf.controller.OspfArea

refreshArea

public void refreshArea(org.onosproject.ospf.controller.OspfInterface ospfInterface)

Refreshes the OSPF area information . Gets called as soon as the interface is down or neighbor full Router LSA is updated.

Specified by:

refreshArea in interface org.onosproject.ospf.controller.OspfArea

Parameters:

ospfInterface - OSPF interface instance

buildNetworkLsa

public org.onosproject.ospf.protocol.lsa.types.NetworkLsa buildNetworkLsa(org.onlab.packet.Ip4Address interfaceIp,
                                                                          org.onlab.packet.Ip4Address mask)
                                                                   throws Exception

Builds a network LSA.

Parameters:

interfaceIp - interface IP address

mask - interface network mask

Returns:

NetworkLsa instance

Throws:

Exception - might throws exception

buildRouterLsa

public org.onosproject.ospf.protocol.lsa.types.RouterLsa buildRouterLsa(org.onosproject.ospf.controller.OspfInterface ospfInterface)
                                                                 throws Exception

Builds Router LSA.

Parameters:

ospfInterface - Interface instance

Returns:

routerLsa Router LSA instance

Throws:

Exception - might throws exception

areaId

public org.onlab.packet.Ip4Address areaId()

Gets the area id.

Specified by:

areaId in interface org.onosproject.ospf.controller.OspfArea

Returns:

area id

setAreaId

public void setAreaId(org.onlab.packet.Ip4Address areaId)

Sets the area id.

Specified by:

setAreaId in interface org.onosproject.ospf.controller.OspfArea

Parameters:

areaId - area id

addressRanges

public List<org.onosproject.ospf.controller.OspfAreaAddressRange> addressRanges()

Gets address range.

Specified by:

addressRanges in interface org.onosproject.ospf.controller.OspfArea

Returns:

list of area address ranges

setAddressRanges

public void setAddressRanges(List<org.onosproject.ospf.controller.OspfAreaAddressRange> addressRanges)

Sets the area address ranges.

Specified by:

setAddressRanges in interface org.onosproject.ospf.controller.OspfArea

Parameters:

addressRanges - list of area address range

isTransitCapability

public boolean isTransitCapability()

Gets is transit capable or not.

Specified by:

isTransitCapability in interface org.onosproject.ospf.controller.OspfArea

Returns:

true if transit capable, else false

setTransitCapability

public void setTransitCapability(boolean transitCapability)

Sets transit capability.

Specified by:

setTransitCapability in interface org.onosproject.ospf.controller.OspfArea

Parameters:

transitCapability - true if transit capable, else false

isExternalRoutingCapability

public boolean isExternalRoutingCapability()

Gets external routing capability.

Specified by:

isExternalRoutingCapability in interface org.onosproject.ospf.controller.OspfArea

Returns:

true if external routing capable, else false

setExternalRoutingCapability

public void setExternalRoutingCapability(boolean externalRoutingCapability)

Sets external routing capability.

Specified by:

setExternalRoutingCapability in interface org.onosproject.ospf.controller.OspfArea

Parameters:

externalRoutingCapability - true if external routing capable, else false

stubCost

public int stubCost()

Gets the stub cost.

Specified by:

stubCost in interface org.onosproject.ospf.controller.OspfArea

Returns:

stub cost

setStubCost

public void setStubCost(int stubCost)

Sets the stub cost.

Specified by:

setStubCost in interface org.onosproject.ospf.controller.OspfArea

Parameters:

stubCost - stub cost

getInterfacesLst

public List<org.onosproject.ospf.controller.OspfInterface> getInterfacesLst()

Gets the list of interfaces in this area.

Specified by:

getInterfacesLst in interface org.onosproject.ospf.controller.OspfArea

Returns:

list of interfaces

setInterfacesLst

public void setInterfacesLst(List<org.onosproject.ospf.controller.OspfInterface> interfacesLst)

Sets the list of interfaces attached to the area.

Specified by:

setInterfacesLst in interface org.onosproject.ospf.controller.OspfArea

Parameters:

interfacesLst - list of OspfInterface instances

noNeighborInLsaExchangeProcess

public boolean noNeighborInLsaExchangeProcess()

Checks all neighbors belonging to this area whether they are in state EXCHANGE or LOADING. Return false if there is at least one, else return true. This Method is used by "processReceivedLsa()" in the neighbor class.

Specified by:

noNeighborInLsaExchangeProcess in interface org.onosproject.ospf.controller.OspfArea

Returns:

boolean indicating that there is no Neighbor in Database Exchange

getLsaHeaders

public List getLsaHeaders(boolean excludeMaxAgeLsa,
                          boolean isOpaquecapable)

Gets header of all types of LSAs.

Specified by:

getLsaHeaders in interface org.onosproject.ospf.controller.OspfArea

Parameters:

excludeMaxAgeLsa - need to include(true) or exclude(false) maxage lsa's

isOpaquecapable - need to include(true) or exclude(false) Type 10 Opaque lsa's

Returns:

list of lsa header in the lsdb

getLsa

public org.onosproject.ospf.controller.LsaWrapper getLsa(int lsType,
                                                         String linkStateID,
                                                         String advertisingRouter)
                                                  throws Exception

Gets the LSA from LSDB based on the input.

Specified by:

getLsa in interface org.onosproject.ospf.controller.OspfArea

Parameters:

lsType - type of lsa to form the key

linkStateID - link state id to form the key

advertisingRouter - advertising router to form the key

Returns:

lsa wrapper instance which contains the Lsa

Throws:

Exception - might throws exception

lsaLookup

public org.onosproject.ospf.controller.LsaWrapper lsaLookup(org.onosproject.ospf.controller.OspfLsa lookupLsa)

Checks whether an instance of the given LSA exists in the database belonging to this area. If so return true else false.

Specified by:

lsaLookup in interface org.onosproject.ospf.controller.OspfArea

Parameters:

lookupLsa - ospf LSA instance to lookup

Returns:

LSA wrapper instance which contains the Lsa

isNewerOrSameLsa

public String isNewerOrSameLsa(org.onosproject.ospf.controller.OspfLsa lsa1,
                               org.onosproject.ospf.controller.OspfLsa lsa2)

Checks whether an instance of the given LSA exists in the database belonging to this area. If so return true else false.

Specified by:

isNewerOrSameLsa in interface org.onosproject.ospf.controller.OspfArea

Parameters:

lsa1 - OSPF LSA instance to compare

lsa2 - OSPF LSA instance to compare

Returns:

"same" if both instances are same, "latest" if lsa1 is latest, or "old" if lsa1 is old

addLsa

public void addLsa(org.onosproject.ospf.controller.OspfLsa ospfLsa,
                   org.onosproject.ospf.controller.OspfInterface ospfInterface)
            throws Exception

Methods gets called from ChannelHandler to add the received LSA to LSDB.

Specified by:

addLsa in interface org.onosproject.ospf.controller.OspfArea

Parameters:

ospfLsa - OSPF LSA instance

ospfInterface - OSPF interface instance

Throws:

Exception

addLsa

public void addLsa(org.onosproject.ospf.controller.OspfLsa ospfLsa,
                   boolean isSelfOriginated,
                   org.onosproject.ospf.controller.OspfInterface ospfInterface)
            throws Exception

Methods gets called from ChannelHandler to add the received LSA to LSDB.

Specified by:

addLsa in interface org.onosproject.ospf.controller.OspfArea

Parameters:

ospfLsa - OSPF LSA instance

isSelfOriginated - true if the LSA is self originated. Else false

ospfInterface - OSPF interface instance

Throws:

Exception

addLsaToMaxAgeBin

public void addLsaToMaxAgeBin(String key,
                              org.onosproject.ospf.controller.LsaWrapper wrapper)

Adds the LSA to maxAge bin.

Specified by:

addLsaToMaxAgeBin in interface org.onosproject.ospf.controller.OspfArea

Parameters:

key - key to add it to LSDB

wrapper - LSA wrapper instance

setDbRouterSequenceNumber

public void setDbRouterSequenceNumber(long newSequenceNumber)

Sets router sequence number for router LSA.

Specified by:

setDbRouterSequenceNumber in interface org.onosproject.ospf.controller.OspfArea

Parameters:

newSequenceNumber - sequence number

deleteLsa

public void deleteLsa(org.onosproject.ospf.protocol.lsa.LsaHeader ospfLsa)

Methods gets called from ChannelHandler to delete the LSA.

Parameters:

ospfLsa - the LSA instance to delete

removeLsaFromBin

public void removeLsaFromBin(org.onosproject.ospf.controller.LsaWrapper lsaWrapper)

Removes LSA from bin.

Specified by:

removeLsaFromBin in interface org.onosproject.ospf.controller.OspfArea

Parameters:

lsaWrapper - the LSA wrapper instance to delete

toString

public String toString()

Overrides:

toString in class Object

getNeighborsInFullState

public List<org.onosproject.ospf.controller.OspfNbr> getNeighborsInFullState(org.onosproject.ospf.controller.OspfInterface ospfInterface)

Checks all Neighbors belonging to this Area whether they are in state lesser than the EXCHANGE.

Creates list of such neighbors

Returns list of neighbors who satisfy the conditions

Parameters:

ospfInterface - OSPF interface instance

Returns:

List of interfaces having state lesser than exchange

getLsaKey

public String getLsaKey(org.onosproject.ospf.protocol.lsa.LsaHeader lsaHeader)

Gets the LSDB LSA key from LSA header.

Parameters:

lsaHeader - LSA header instance

Returns:

key LSA key

addToOtherNeighborLsaTxList

public void addToOtherNeighborLsaTxList(org.onosproject.ospf.protocol.lsa.LsaHeader recLsa)

Adds the received LSA in other neighbors tx list.

Parameters:

recLsa - LSA Header instance

options

public int options()

Gets the options value.

Specified by:

options in interface org.onosproject.ospf.controller.OspfArea

Returns:

options value

setOptions

public void setOptions(int options)

Sets the options value.

Specified by:

setOptions in interface org.onosproject.ospf.controller.OspfArea

Parameters:

options - options value

opaqueEnabledOptions

public int opaqueEnabledOptions()

Gets the opaque enabled options value.

Specified by:

opaqueEnabledOptions in interface org.onosproject.ospf.controller.OspfArea

Returns:

opaque enabled options value

database

public org.onosproject.ospf.controller.OspfLsdb database()

Gets the lsdb instance for this area.

Specified by:

database in interface org.onosproject.ospf.controller.OspfArea

Returns:

lsdb instance