Package com.twl.xg.service

Class AbstractAccessBorderRouterService

java.lang.Object

com.twl.xg.service.AbstractAccessBorderRouterService

Direct Known Subclasses:

AccessBorderRouterService, MockAccessBorderRouterService

public abstract class AbstractAccessBorderRouterService
extends java.lang.Object

This abstract class defines the basic operations to communicate with border routers. Also provide some common methods. To use this class, one need to extend this abstract class and implement abstract methods: getSensorIpByBorderRouterIp() and existBorderRouter().

Version:

1.0

Author:

Xiaozheng Guo

See Also:

AccessBorderRouterService, MockAccessBorderRouterService

Field Summary

Fields

Modifier and Type	Field	Description
protected BorderRouterRepository	borderRouterRepository
private static org.apache.log4j.Logger	logger
protected SensorRepository	sensorRepository

Constructor Summary

Constructors

Constructor	Description
AbstractAccessBorderRouterService()

Method Summary

Modifier and Type	Method	Description
abstract boolean	existBorderRouter(java.lang.String borderRouterIp)	Check if a border router IP is exist, notice that this method doesn't check if the IP is in database, it checks if the router IP exists in the real network.
abstract java.util.List<java.lang.String>	getSensorIpByBorderRouterIp(java.lang.String borderRouterIp)	Take as input a String of borderRouterIp, return a list of IPv6 address of sensors that are connected to the given border router.
BorderRouterEntity	saveBorderRouter(java.lang.String borderRouterIp, java.lang.String borderRouterName)	Save the input border router in database.
void	saveSensorsForBorderRouterIp(java.lang.String borderRouterIp)	Save the sensors connected to the input border router in database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

borderRouterRepository

@Autowired
protected BorderRouterRepository borderRouterRepository

sensorRepository

@Autowired
protected SensorRepository sensorRepository

logger

private static final org.apache.log4j.Logger logger

Constructor Detail

AbstractAccessBorderRouterService

public AbstractAccessBorderRouterService()

Method Detail

existBorderRouter

public abstract boolean existBorderRouter(java.lang.String borderRouterIp)

Check if a border router IP is exist, notice that this method doesn't check if the IP is in database, it checks if the router IP exists in the real network.

Parameters:

borderRouterIp - The IPv6 address of the border router you want to check.

Returns:

true for border router exists, false otherwise.

getSensorIpByBorderRouterIp

public abstract java.util.List<java.lang.String> getSensorIpByBorderRouterIp(java.lang.String borderRouterIp)

Take as input a String of borderRouterIp, return a list of IPv6 address of sensors that are connected to the given border router. If the input borderRouterIp is inValid, return null instead. If there is no sensor connected to the border router, return an empty list.

Parameters:

borderRouterIp - The IPv6 address of border router you want to query.

Returns:

A list of sensor IPv6 address.

saveBorderRouter

@Transactional
public BorderRouterEntity saveBorderRouter(java.lang.String borderRouterIp,
                                           java.lang.String borderRouterName)

Save the input border router in database. If the input borderRouterName is null, set its IP as name. If the input border router IP is already in database, just ignore it.

Parameters:

borderRouterIp - The IPv6 address of the border router you want to save.

borderRouterName - The name you want to set for the border router.

Returns:

An instance of BorderRouterEntity for the input border router.

saveSensorsForBorderRouterIp

@Transactional
public void saveSensorsForBorderRouterIp(java.lang.String borderRouterIp)

Save the sensors connected to the input border router in database. The default sensor name is the same to the sensor's IP.

Parameters:

borderRouterIp - The IPv6 address of the border router that the list of sensors are connnected.

Throws:

java.lang.NullPointerException - if the input border router IP doesn't not exist.