org.onosproject.ospf.controller

Interface OspfArea

public interface OspfArea

Representation of an OSPF area. OSPF areas are collections of network segments. The configuration of OSPF area consists of assigning an area id to each network segment. Each area has its own link state database.

Method Summary

Modifier and Type	Method and Description
void	addLsa(OspfLsa ospfLsa, boolean isSelfOriginated, OspfInterface ospfInterface) Adds the received LSA to LSDB, this method creates an LSA wrapper for the LSA.
void	addLsa(OspfLsa ospfLsa, OspfInterface ospfInterface) Adds the received LSA to LSDB,this method creates an LSA wrapper for the LSA.
void	addLsaToMaxAgeBin(java.lang.String key, LsaWrapper wrapper) Whenever we receive an LSA with max age - we put it in the max age bin.
org.onlab.packet.Ip4Address	areaId() Gets the area id.
OspfLsdb	database() Gets the LSDB instance for this area.
LsaWrapper	getLsa(int lsType, java.lang.String linkStateID, java.lang.String advertisingRouter) Gets the LSA wrapper from link state database based on the parameters passed.
java.util.List	getLsaHeaders(boolean excludeMaxAgeLsa, boolean isOpaqueCapable) Gets LSA header of all types of LSAs present in the link state database.
void	initializeDb() Initializes link state database, this acts as a place holder for storing the received LSA.
boolean	isExternalRoutingCapability() Gets external routing capability.
java.lang.String	isNewerOrSameLsa(OspfLsa lsa1, OspfLsa lsa2) Checks whether an instance of the given LSA exists in the database belonging to this area.
boolean	isOpaqueEnabled() Gets if the router is opaque enabled or not.
LsaWrapper	lsaLookup(OspfLsa lookupLsa) Checks whether an instance of the given LSA exists in the database.
boolean	noNeighborInLsaExchangeProcess() Verifies no neighbor is in exchange process.
int	opaqueEnabledOptions() Gets the opaque enabled options value, which indicates support of opaque capabilities.
int	options() Gets the options value, which indicates the supported optional capabilities.
java.util.List<OspfInterface>	ospfInterfaceList() Gets the list of interfaces attached to this area.
void	refreshArea(OspfInterface ospfInterface) Refreshes areas, by sending a router LSA and network LSA (in case of DR).
void	removeLsaFromBin(LsaWrapper lsaWrapper) Whenever an LSA is being flushed out or reaches max age, it must be stopped from aging.
org.onlab.packet.Ip4Address	routerId() Gets the router id associated with the area.
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	setIsOpaqueEnabled(boolean isOpaqueEnable) Sets opaque enabled to true or false, which indicates whether the router accepts opaque LSA.
void	setOptions(int options) Sets the options value.
void	setOspfInterfaceList(java.util.List<OspfInterface> interfacesLst) Sets the list of interfaces attached to this area.
void	setRouterId(org.onlab.packet.Ip4Address routerId) Sets the router id for this area.

Method Detail

routerId

org.onlab.packet.Ip4Address routerId()

Gets the router id associated with the area.

Returns:

router id

setRouterId

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

Sets the router id for this area.

Parameters:

routerId - router's ip address

areaId

org.onlab.packet.Ip4Address areaId()

Gets the area id.

Returns:

area id

setAreaId

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

Sets the area id.

Parameters:

areaId - area id as an IPv4 address

database

OspfLsdb database()

Gets the LSDB instance for this area.

Returns:

LSDB instance for this area

lsaLookup

LsaWrapper lsaLookup(OspfLsa lookupLsa)

Checks whether an instance of the given LSA exists in the database.

Parameters:

lookupLsa - LSA instance to lookup

Returns:

LSA wrapper instance which contains the LSA

initializeDb

void initializeDb()

Initializes link state database, this acts as a place holder for storing the received LSA.

setOptions

void setOptions(int options)

Sets the options value.

Parameters:

options - integer value

isExternalRoutingCapability

boolean isExternalRoutingCapability()

Gets external routing capability. This indicates Whether AS-external-LSAs will be flooded into/throughout the area.

Returns:

true if external routing capable, else false

setExternalRoutingCapability

void setExternalRoutingCapability(boolean externalRoutingCapability)

Sets external routing capability. This indicates Whether AS-external-LSAs will be flooded into/throughout the area.

Parameters:

externalRoutingCapability - true if external routing capable, else false

isOpaqueEnabled

boolean isOpaqueEnabled()

Gets if the router is opaque enabled or not. This indicates whether the router accepts opaque LSA.

Returns:

true if opaque enabled else false

ospfInterfaceList

java.util.List<OspfInterface> ospfInterfaceList()

Gets the list of interfaces attached to this area.

Returns:

list of interfaces

setOspfInterfaceList

void setOspfInterfaceList(java.util.List<OspfInterface> interfacesLst)

Sets the list of interfaces attached to this area.

Parameters:

interfacesLst - list of interface instances

options

int options()

Gets the options value, which indicates the supported optional capabilities.

Returns:

options value

opaqueEnabledOptions

int opaqueEnabledOptions()

Gets the opaque enabled options value, which indicates support of opaque capabilities.

Returns:

opaque enabled options value

setIsOpaqueEnabled

void setIsOpaqueEnabled(boolean isOpaqueEnable)

Sets opaque enabled to true or false, which indicates whether the router accepts opaque LSA.

Parameters:

isOpaqueEnable - true if opaque enabled else false

refreshArea

void refreshArea(OspfInterface ospfInterface)

Refreshes areas, by sending a router LSA and network LSA (in case of DR). with a new sequence number.

Parameters:

ospfInterface - interface instance

noNeighborInLsaExchangeProcess

boolean noNeighborInLsaExchangeProcess()

Verifies no neighbor is in exchange process.

Returns:

boolean indicating that there is no Neighbor in Database Exchange

isNewerOrSameLsa

java.lang.String isNewerOrSameLsa(OspfLsa lsa1,
                                  OspfLsa lsa2)

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

Parameters:

lsa1 - LSA instance to compare

lsa2 - LSA instance to compare

Returns:

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

addLsaToMaxAgeBin

void addLsaToMaxAgeBin(java.lang.String key,
                       LsaWrapper wrapper)

Whenever we receive an LSA with max age - we put it in the max age bin. This is later used to flush LSAs out of the routing domain.

Parameters:

key - key to add it to LSDB

wrapper - LSA wrapper instance

removeLsaFromBin

void removeLsaFromBin(LsaWrapper lsaWrapper)

Whenever an LSA is being flushed out or reaches max age, it must be stopped from aging. This achieved by removing it from bin.

Parameters:

lsaWrapper - the LSA wrapper instance to delete

addLsa

void addLsa(OspfLsa ospfLsa,
            boolean isSelfOriginated,
            OspfInterface ospfInterface)

Adds the received LSA to LSDB, this method creates an LSA wrapper for the LSA. Also adds it to the LSDB of the area. This method is specifically called for the self originated LSAs.

Parameters:

ospfLsa - LSA instance

isSelfOriginated - true if the LSA is self originated else false

ospfInterface - interface instance

addLsa

void addLsa(OspfLsa ospfLsa,
            OspfInterface ospfInterface)

Adds the received LSA to LSDB,this method creates an LSA wrapper for the LSA. Adds it to the LSDB of the area.

Parameters:

ospfLsa - LSA instance

ospfInterface - interface instance

setDbRouterSequenceNumber

void setDbRouterSequenceNumber(long newSequenceNumber)

Sets router sequence number for router LSA.

Parameters:

newSequenceNumber - sequence number

getLsaHeaders

java.util.List getLsaHeaders(boolean excludeMaxAgeLsa,
                             boolean isOpaqueCapable)

Gets LSA header of all types of LSAs present in the link state database.

Parameters:

excludeMaxAgeLsa - need to include(true) or exclude(false) max age LSA

isOpaqueCapable - need to include(true) or exclude(false) type 10 Opaque LSA

Returns:

list of LSA header in the LSDB

getLsa

LsaWrapper getLsa(int lsType,
                  java.lang.String linkStateID,
                  java.lang.String advertisingRouter)

Gets the LSA wrapper from link state database based on the parameters passed.

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