AbstractLispRouter (onos-protocols-lisp-api)

java.lang.Object
- org.onosproject.lisp.ctl.AbstractLispRouter

All Implemented Interfaces:

LispRouter

Direct Known Subclasses:

DefaultLispRouter
```
public abstract class AbstractLispRouter
extends Object
implements LispRouter
```
An abstract representation of a LISP router. This class can be extended by others to serve as a base for their vendor specific representation of a router.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`channelId()` Identifies the channel used to communicate with the router.
`boolean`	`connectRouter()` Announces to the LISP agent that this router has connected.
`org.onosproject.net.Device.Type`	`deviceType()` Returns the router device type.
`void`	`disconnectRouter()` Disconnects the router by closing UDP connection.
`boolean`	`equals(Object o)`
`List<LispEidRecord>`	`getEidRecords()` Obtains a collection of EID records that associated with this router.
`void`	`handleMessage(LispMessage message)` Handles the LISP control message from the channel.
`int`	`hashCode()`
`boolean`	`isConnected()` Checks if the router is connected.
`boolean`	`isSubscribed()` Checks if the router is subscribed.
`org.onlab.packet.IpAddress`	`routerId()` Obtains an IpAddress version of the ID for this router.
`void`	`sendMessage(LispMessage message)` Writes the LISP control message to the channel.
`void`	`setAgent(LispRouterAgent agent)` Sets the LISP agent to be used.
`void`	`setChannel(io.netty.channel.Channel channel)` Sets the associated Netty channel for this router.
`void`	`setConnected(boolean connected)` Sets whether the router is connected.
`void`	`setEidRecords(List<LispEidRecord> records)` Associates the EID records to this router.
`void`	`setSubscribed(boolean subscribed)` Sets whether the router is subscribed.
`String`	`stringId()` Obtains a string version of the ID for this router.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - channelId
```
public final String channelId()
```
    Description copied from interface: LispRouter
    
    Identifies the channel used to communicate with the router.
    
    Specified by:
    
    channelId in interface LispRouter
    
    Returns:
    
    string representation of the connection to the device
  - routerId
```
public final org.onlab.packet.IpAddress routerId()
```
    Description copied from interface: LispRouter
    
    Obtains an IpAddress version of the ID for this router.
    
    Specified by:
    
    routerId in interface LispRouter
    
    Returns:
    
    raw IP address of the device identifier
  - stringId
```
public final String stringId()
```
    Description copied from interface: LispRouter
    
    Obtains a string version of the ID for this router.
    
    Specified by:
    
    stringId in interface LispRouter
    
    Returns:
    
    string representation of the device identifier
  - setChannel
```
public final void setChannel(io.netty.channel.Channel channel)
```
    Description copied from interface: LispRouter
    
    Sets the associated Netty channel for this router.
    
    Specified by:
    
    setChannel in interface LispRouter
    
    Parameters:
    
    channel - the Netty channel
  - setConnected
```
public final void setConnected(boolean connected)
```
    Description copied from interface: LispRouter
    
    Sets whether the router is connected.
    
    Specified by:
    
    setConnected in interface LispRouter
    
    Parameters:
    
    connected - whether the router is connected
  - isConnected
```
public final boolean isConnected()
```
    Description copied from interface: LispRouter
    
    Checks if the router is connected.
    
    Specified by:
    
    isConnected in interface LispRouter
    
    Returns:
    
    whether the router is connected
  - isSubscribed
```
public final boolean isSubscribed()
```
    Description copied from interface: LispRouter
    
    Checks if the router is subscribed. As long as a router sends Map-Request message, we treat the router is subscribed.
    
    Specified by:
    
    isSubscribed in interface LispRouter
    
    Returns:
    
    whether the router is subscribed
  - setSubscribed
```
public final void setSubscribed(boolean subscribed)
```
    Description copied from interface: LispRouter
    
    Sets whether the router is subscribed.
    
    Specified by:
    
    setSubscribed in interface LispRouter
    
    Parameters:
    
    subscribed - whether the router is subscribed
  - setAgent
```
public final void setAgent(LispRouterAgent agent)
```
    Description copied from interface: LispRouter
    
    Sets the LISP agent to be used. This method can only be invoked once.
    
    Specified by:
    
    setAgent in interface LispRouter
    
    Parameters:
    
    agent - the agent to set
  - deviceType
```
public final org.onosproject.net.Device.Type deviceType()
```
    Description copied from interface: LispRouter
    
    Returns the router device type.
    
    Specified by:
    
    deviceType in interface LispRouter
    
    Returns:
    
    device type
  - sendMessage
```
public void sendMessage(LispMessage message)
```
    Description copied from interface: LispRouter
    
    Writes the LISP control message to the channel.
    
    Specified by:
    
    sendMessage in interface LispRouter
    
    Parameters:
    
    message - the message to be written
  - handleMessage
```
public void handleMessage(LispMessage message)
```
    Description copied from interface: LispRouter
    
    Handles the LISP control message from the channel.
    
    Specified by:
    
    handleMessage in interface LispRouter
    
    Parameters:
    
    message - the message to be handled
  - connectRouter
```
public final boolean connectRouter()
```
    Description copied from interface: LispRouter
    
    Announces to the LISP agent that this router has connected.
    
    Specified by:
    
    connectRouter in interface LispRouter
    
    Returns:
    
    true if successful, false if duplicate router
  - disconnectRouter
```
public final void disconnectRouter()
```
    Description copied from interface: LispRouter
    
    Disconnects the router by closing UDP connection. Results in a call to the channel handler's close method for cleanup.
    
    Specified by:
    
    disconnectRouter in interface LispRouter
  - getEidRecords
```
public List<LispEidRecord> getEidRecords()
```
    Description copied from interface: LispRouter
    
    Obtains a collection of EID records that associated with this router.
    
    Specified by:
    
    getEidRecords in interface LispRouter
    
    Returns:
    
    a collection EID records that associated with this router
  - setEidRecords
```
public void setEidRecords(List<LispEidRecord> records)
```
    Description copied from interface: LispRouter
    
    Associates the EID records to this router.
    
    Specified by:
    
    setEidRecords in interface LispRouter
    
    Parameters:
    
    records - a collection of EID records
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AbstractLispRouter

Method Summary

Methods inherited from class java.lang.Object

Method Detail

channelId

routerId

stringId

setChannel

setConnected

isConnected

isSubscribed

setSubscribed

setAgent

deviceType

sendMessage

handleMessage

connectRouter

disconnectRouter

getEidRecords

setEidRecords

toString

equals

hashCode