Open Kilda Java Documentation
org.openkilda.pce.cache.NetworkCache Class Reference
Inheritance diagram for org.openkilda.pce.cache.NetworkCache:
org.openkilda.pce.cache.Cache

Public Member Functions

void load (Set< SwitchInfoData > switches, Set< IslInfoData > isls)
 
Set< IslInfoDatagetIslsBySource (SwitchId switchId)
 
Set< IslInfoDatagetIslsByDestination (SwitchId switchId)
 
Set< IslInfoDatagetIslsBySwitch (SwitchId switchId) throws CacheException
 
Set< SwitchInfoDatagetStateSwitches (SwitchState state)
 
Set< SwitchInfoDatagetControllerSwitches (String controller)
 
Set< SwitchInfoDatagetDirectlyConnectedSwitches (SwitchId switchId) throws CacheException
 
void clear ()
 
SwitchInfoData getSwitch (SwitchId switchId) throws CacheException
 
SwitchInfoData createSwitch (SwitchInfoData newSwitch) throws CacheException
 
SwitchInfoData updateSwitch (SwitchInfoData newSwitch) throws CacheException
 
SwitchInfoData createOrUpdateSwitch (SwitchInfoData newSwitch)
 
SwitchInfoData deleteSwitch (SwitchId switchId) throws CacheException
 
Set< SwitchInfoDatadumpSwitches ()
 
boolean cacheContainsSwitch (SwitchId switchId)
 
boolean switchIsOperable (SwitchId switchId)
 
IslInfoData getIsl (String islId) throws CacheException
 
IslInfoData createIsl (IslInfoData isl) throws CacheException
 
IslInfoData updateIsl (IslInfoData isl) throws CacheException
 
IslInfoData createOrUpdateIsl (IslInfoData isl)
 
IslInfoData deleteIsl (String islId) throws CacheException
 
Set< IslInfoDatadumpIsls ()
 
boolean cacheContainsIsl (String islId)
 
String toString ()
 

Detailed Description

Definition at line 39 of file NetworkCache.java.

Member Function Documentation

◆ cacheContainsIsl()

boolean org.openkilda.pce.cache.NetworkCache.cacheContainsIsl ( String  islId)

Checks if isl pool contains IslInfoData instance.

Parameters
islIdIslInfoData instance id
Returns
true if isl pool contains IslInfoData instance

Definition at line 450 of file NetworkCache.java.

◆ cacheContainsSwitch()

boolean org.openkilda.pce.cache.NetworkCache.cacheContainsSwitch ( SwitchId  switchId)

Checks if switch pool contains SwitchInfoData instance.

Parameters
switchIdSwitchInfoData instance id
Returns
true if switch pool contains SwitchInfoData instance

Definition at line 308 of file NetworkCache.java.

◆ clear()

void org.openkilda.pce.cache.NetworkCache.clear ( )

Clears the inner network and pools.

Definition at line 169 of file NetworkCache.java.

◆ createIsl()

IslInfoData org.openkilda.pce.cache.NetworkCache.createIsl ( IslInfoData  isl) throws CacheException

Creates IslInfoData instance.

Parameters
islIslInfoData instance
Returns
IslInfoData instance previously associated with IslInfoData instance id or null otherwise
Exceptions
CacheExceptionif SwitchInfoData related to IslInfoData instance do not exist

Definition at line 356 of file NetworkCache.java.

◆ createOrUpdateIsl()

IslInfoData org.openkilda.pce.cache.NetworkCache.createOrUpdateIsl ( IslInfoData  isl)

Creates IslInfoData instance.

Parameters
islIslInfoData instance
Returns
IslInfoData instance previously associated with IslInfoData instance id or null otherwise
Exceptions
CacheExceptionif SwitchInfoData related to IslInfoData instance do not exist

Definition at line 398 of file NetworkCache.java.

◆ createOrUpdateSwitch()

SwitchInfoData org.openkilda.pce.cache.NetworkCache.createOrUpdateSwitch ( SwitchInfoData  newSwitch)

Creates or updates SwitchInfoData instance.

Parameters
newSwitchSwitchInfoData instance
Returns
created SwitchInfoData instance
Exceptions
CacheExceptionif SwitchInfoData instance with specified id already exists

Definition at line 256 of file NetworkCache.java.

◆ createSwitch()

SwitchInfoData org.openkilda.pce.cache.NetworkCache.createSwitch ( SwitchInfoData  newSwitch) throws CacheException

Creates SwitchInfoData instance.

Parameters
newSwitchSwitchInfoData instance
Returns
created SwitchInfoData instance
Exceptions
CacheExceptionif SwitchInfoData instance with specified id already exists

Definition at line 203 of file NetworkCache.java.

◆ deleteIsl()

IslInfoData org.openkilda.pce.cache.NetworkCache.deleteIsl ( String  islId) throws CacheException

Deletes IslInfoData instance.

Parameters
islIdIslInfoData instance id
Returns
removed IslInfoData instance
Exceptions
CacheExceptionif IslInfoData instance with specified id does not exist

Definition at line 419 of file NetworkCache.java.

◆ deleteSwitch()

SwitchInfoData org.openkilda.pce.cache.NetworkCache.deleteSwitch ( SwitchId  switchId) throws CacheException

Deletes SwitchInfoData instance.

Parameters
switchIdSwitchInfoData instance id
Returns
removed SwitchInfoData instance
Exceptions
CacheExceptionif SwitchInfoData instance with specified id does not exist

Definition at line 277 of file NetworkCache.java.

◆ dumpIsls()

Set<IslInfoData> org.openkilda.pce.cache.NetworkCache.dumpIsls ( )

Gets all IslInfoData instances.

Returns
Set of IslInfoData instances

Definition at line 438 of file NetworkCache.java.

◆ dumpSwitches()

Set<SwitchInfoData> org.openkilda.pce.cache.NetworkCache.dumpSwitches ( )

Gets all SwitchInfoData instances.

Returns
Set of SwitchInfoData instances

Definition at line 296 of file NetworkCache.java.

◆ getControllerSwitches()

Set<SwitchInfoData> org.openkilda.pce.cache.NetworkCache.getControllerSwitches ( String  controller)

Gets all SwitchInfoData instances with specified controller ip address.

Parameters
controllercontroller ip address
Returns
Set of SwitchInfoData instances

Definition at line 143 of file NetworkCache.java.

◆ getDirectlyConnectedSwitches()

Set<SwitchInfoData> org.openkilda.pce.cache.NetworkCache.getDirectlyConnectedSwitches ( SwitchId  switchId) throws CacheException

Gets all SwitchInfoData instances directly connected to specified.

Parameters
switchIdswitch id
Returns
Set of SwitchInfoData instances
Exceptions
CacheExceptionif SwitchInfoData instance with specified id does not exist

Definition at line 158 of file NetworkCache.java.

◆ getIsl()

IslInfoData org.openkilda.pce.cache.NetworkCache.getIsl ( String  islId) throws CacheException

Get IslInfoData instance.

Parameters
islIdIslInfoData instance id
Returns
IslInfoData instance with specified IslInfoData instance id
Exceptions
CacheExceptionif IslInfoData instance with specified id does not exist

Definition at line 337 of file NetworkCache.java.

◆ getIslsByDestination()

Set<IslInfoData> org.openkilda.pce.cache.NetworkCache.getIslsByDestination ( SwitchId  switchId)

Gets all IslInfoData instances which end node is specified SwitchInfoData instance.

Parameters
switchIdSwitchInfoData instance id
Returns
Set of IslInfoData instances
Exceptions
CacheExceptionif SwitchInfoData instance with specified id does not exists

Definition at line 100 of file NetworkCache.java.

◆ getIslsBySource()

Set<IslInfoData> org.openkilda.pce.cache.NetworkCache.getIslsBySource ( SwitchId  switchId)

Gets all IslInfoData instances which start node is specified SwitchInfoData instance.

Parameters
switchIdSwitchInfoData instance id
Returns
Set of IslInfoData instances
Exceptions
CacheExceptionif SwitchInfoData instance with specified id does not exists

Definition at line 85 of file NetworkCache.java.

◆ getIslsBySwitch()

Set<IslInfoData> org.openkilda.pce.cache.NetworkCache.getIslsBySwitch ( SwitchId  switchId) throws CacheException

Gets all IslInfoData instances which start or end node is specified SwitchInfoData instance.

Parameters
switchIdSwitchInfoData instance id
Returns
Set of IslInfoData instances
Exceptions
CacheExceptionif SwitchInfoData instance with specified id does not exists

Definition at line 115 of file NetworkCache.java.

◆ getStateSwitches()

Set<SwitchInfoData> org.openkilda.pce.cache.NetworkCache.getStateSwitches ( SwitchState  state)

Gets all SwitchInfoData instances in specified SwitchState state.

Parameters
stateSwitchState state
Returns
Set of SwitchInfoData instances

Definition at line 129 of file NetworkCache.java.

◆ getSwitch()

SwitchInfoData org.openkilda.pce.cache.NetworkCache.getSwitch ( SwitchId  switchId) throws CacheException

Gets SwitchInfoData instance.

Parameters
switchIdSwitchInfoData instance id
Returns
SwitchInfoData instance with specified SwitchInfoData instance id
Exceptions
CacheExceptionif SwitchInfoData instance with specified id does not exist

Definition at line 184 of file NetworkCache.java.

◆ load()

void org.openkilda.pce.cache.NetworkCache.load ( Set< SwitchInfoData switches,
Set< IslInfoData isls 
)

Fills cache.

Parameters
switchesSet of SwitchInfoData instances
islsSet of IslInfoData instances

Definition at line 70 of file NetworkCache.java.

◆ switchIsOperable()

boolean org.openkilda.pce.cache.NetworkCache.switchIsOperable ( SwitchId  switchId)

Checks if switch in operational state.

Parameters
switchIdswitch id
Returns
true if switch in operational state, otherwise false

Definition at line 320 of file NetworkCache.java.

◆ toString()

String org.openkilda.pce.cache.NetworkCache.toString ( )

Definition at line 494 of file NetworkCache.java.

◆ updateIsl()

IslInfoData org.openkilda.pce.cache.NetworkCache.updateIsl ( IslInfoData  isl) throws CacheException

Updates IslInfoData instance.

Parameters
islnew IslInfoData instance
Returns
IslInfoData instance previously associated with IslInfoData instance id or null otherwise
Exceptions
CacheExceptionif SwitchInfoData related to IslInfoData instance do not exist

Definition at line 375 of file NetworkCache.java.

◆ updateSwitch()

SwitchInfoData org.openkilda.pce.cache.NetworkCache.updateSwitch ( SwitchInfoData  newSwitch) throws CacheException

Updates SwitchInfoData instance.

Parameters
newSwitchSwitchInfoData instance
Returns
SwitchInfoData instance before update
Exceptions
CacheExceptionif SwitchInfoData instance with specified id does not exist

Definition at line 229 of file NetworkCache.java.


The documentation for this class was generated from the following file: