LsaWrapper (onos-protocols-ospf-api)

```
public interface LsaWrapper
```
Representation of a wrapper object to store LSA and associated metadata. Metadata consists about the origination of LSA, age of LSA when received etc.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`ageCounterWhenReceived()` Gets the age counter when received.
`int`	`binNumber()` Gets bin number into which the LSA wrapper is put for aging process.
`int`	`currentAge()` Gets the current LSA Age, using this we calculate current age.
`boolean`	`isSelfOriginated()` Determines the origination of LSA , this is called during ls refresh interval.
`int`	`lsaAgeReceived()` Age of LSA when received during the adjacency formation.
`java.lang.String`	`lsaProcessing()` Gets the LSA process command, like max age, ls refresh, based on the command set.
`OspfLsaType`	`lsaType()` Gets the type of LSA, it can be a router,network,summary,external.
`OspfInterface`	`ospfInterface()` Gets the interface on which the LSA was received.
`OspfLsa`	`ospfLsa()` Gets the LSA present in the wrapper instance.
`void`	`setAgeCounterWhenReceived(int ageCounterWhenReceived)` Sets the age counter when received.
`void`	`setBinNumber(int binNumber)` Sets bin number into which the LSA wrapper is put for aging process.
`void`	`setIsSelfOriginated(boolean isSelfOriginated)` Sets is self originated or not.
`void`	`setLsaAgeReceived(int lsaAgeReceived)` Sets the Age of LSA when received during the adjacency formation.
`void`	`setLsaProcessing(java.lang.String lsaProcessing)` Sets the LSA process command, like max age , ls refresh , based on the command set.
`void`	`setLsaType(OspfLsaType lsaType)` Sets the LSA type during the initialization of wrapper.
`void`	`setLsdbAge(LsdbAge lsdbAge)` Sets the LSDB age.
`void`	`setOspfInterface(OspfInterface ospfInterface)` Sets the interface on which the LSA was received, this is used later to flood the information.
`void`	`setOspfLsa(OspfLsa ospfLsa)` Sets the LSA instance to the wrapper.

- Method Detail
  - lsaType
```
OspfLsaType lsaType()
```
    Gets the type of LSA, it can be a router,network,summary,external.
    
    Returns:
    
    lsa type
  - setLsaType
```
void setLsaType(OspfLsaType lsaType)
```
    Sets the LSA type during the initialization of wrapper.
    
    Parameters:
    
    lsaType - lsa type
  - isSelfOriginated
```
boolean isSelfOriginated()
```
    Determines the origination of LSA , this is called during ls refresh interval.
    
    Returns:
    
    true if self originated else false
  - setIsSelfOriginated
```
void setIsSelfOriginated(boolean isSelfOriginated)
```
    Sets is self originated or not.
    
    Parameters:
    
    isSelfOriginated - true if self originated else false
  - lsaAgeReceived
```
int lsaAgeReceived()
```
    Age of LSA when received during the adjacency formation.
    
    Returns:
    
    Age of LSA when received
  - setLsaAgeReceived
```
void setLsaAgeReceived(int lsaAgeReceived)
```
    Sets the Age of LSA when received during the adjacency formation.
    
    Parameters:
    
    lsaAgeReceived - Age of LSA when received
  - ospfLsa
```
OspfLsa ospfLsa()
```
    Gets the LSA present in the wrapper instance.
    
    Returns:
    
    LSA instance
  - setOspfLsa
```
void setOspfLsa(OspfLsa ospfLsa)
```
    Sets the LSA instance to the wrapper.
    
    Parameters:
    
    ospfLsa - LSA instance
  - currentAge
```
int currentAge()
```
    Gets the current LSA Age, using this we calculate current age. It is done against the age counter which is incremented every second.
    
    Returns:
    
    lsa age
  - ageCounterWhenReceived
```
int ageCounterWhenReceived()
```
    Gets the age counter when received.
    
    Returns:
    
    the age counter when received
  - setAgeCounterWhenReceived
```
void setAgeCounterWhenReceived(int ageCounterWhenReceived)
```
    Sets the age counter when received.
    
    Parameters:
    
    ageCounterWhenReceived - the age counter when received
  - lsaProcessing
```
java.lang.String lsaProcessing()
```
    Gets the LSA process command, like max age, ls refresh, based on the command set. The queue consumer will pick the LSA and start performing the actions, like flooding out of the domain or generating a new LSA and flooding.
    
    Returns:
    
    lsa process command
  - setLsaProcessing
```
void setLsaProcessing(java.lang.String lsaProcessing)
```
    Sets the LSA process command, like max age , ls refresh , based on the command set. The queue consumer will pick the LSA and start performing the actions, like flooding out of the domain or generating a new LSA and flooding.
    
    Parameters:
    
    lsaProcessing - lsa process command
  - binNumber
```
int binNumber()
```
    Gets bin number into which the LSA wrapper is put for aging process.
    
    Returns:
    
    bin number
  - setBinNumber
```
void setBinNumber(int binNumber)
```
    Sets bin number into which the LSA wrapper is put for aging process.
    
    Parameters:
    
    binNumber - bin number
  - ospfInterface
```
OspfInterface ospfInterface()
```
    Gets the interface on which the LSA was received.
    
    Returns:
    
    the interface instance
  - setOspfInterface
```
void setOspfInterface(OspfInterface ospfInterface)
```
    Sets the interface on which the LSA was received, this is used later to flood the information.
    
    Parameters:
    
    ospfInterface - interface instance
  - setLsdbAge
```
void setLsdbAge(LsdbAge lsdbAge)
```
    Sets the LSDB age. Using LSDB age we are calculating age of a particular LSA.
    
    Parameters:
    
    lsdbAge - lsdbAge instance

Interface LsaWrapper

Method Summary

Method Detail

lsaType

setLsaType

isSelfOriginated

setIsSelfOriginated

lsaAgeReceived

setLsaAgeReceived

ospfLsa

setOspfLsa

currentAge

ageCounterWhenReceived

setAgeCounterWhenReceived

lsaProcessing

setLsaProcessing

binNumber

setBinNumber

ospfInterface

setOspfInterface

setLsdbAge