Package com.twl.xg.controller

Class DataController

java.lang.Object

com.twl.xg.controller.DataController

@Controller
@RequestMapping("/data")
public class DataController
extends java.lang.Object

This Controller handles all requests that are fetching sensor data from back-end. This is a restful controller, consume JSON, produce JSON.

Version:

1.0

Author:

Xiaozheng Guo

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractAccessSensorService	accessSensorService
private DataFetchingAndMappingService	dataFetchingAndMappingService
private static org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
DataController()

Method Summary

Modifier and Type	Method	Description
int	clearAllData()	Delete all data in database.
java.util.List<java.lang.String[]>	getAllBorderRouterIpAndName()	get a list of "borderRouterIP, borderRouterName" pair for all border router in database.
DataPackage	getAllCurrentData()	Gets all current data from each sensor, not from database.
DataPackage	getAllDataFromDatabase()	Gets all data from database, map to a DataPackage object.
java.util.List<java.lang.String>	getAllSensorIp()	Gets all sensor ip.
BorderRouterWrapper	getCurrentDataForBorderRouter(java.lang.String borderRouterIp)	Fetching data from sensor for given border router.
BorderRouterWrapper	getDataForBorderRouterFromDB(java.lang.String borderRouterIp)	Fetching data from database for given border router.
SensorWrapper	getHistoryDataBySensorIp(java.lang.String sensorIp)	Get all history data entries for the input sensor IP.
java.util.List<java.lang.String>	getSensorIpListByBorderRouterIp(java.lang.String borderRouterIp)	Get all sensor IP for the input border router IP.

Methods inherited from class java.lang.Object

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

Field Detail

dataFetchingAndMappingService

@Autowired
private DataFetchingAndMappingService dataFetchingAndMappingService

accessSensorService

@Autowired
@Qualifier("mockAccessSensorService")
private AbstractAccessSensorService accessSensorService

logger

private static final org.apache.log4j.Logger logger

Constructor Detail

DataController

public DataController()

Method Detail

getHistoryDataBySensorIp

@RequestMapping(value="/getHistoryDataBySensorIp/{sensorIp}",
                method=GET,
                headers="ModelAttribute=getHistoryDataBySensorIp",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public SensorWrapper getHistoryDataBySensorIp(@PathVariable
                                              java.lang.String sensorIp)

Get all history data entries for the input sensor IP. Map them in a SensorWrapper object. If there is no data for the given sensor IP in database or the input sensor IP doesn't exist, return null.

Parameters:

sensorIp - path variable snesor IP

getSensorIpListByBorderRouterIp

@RequestMapping(value="/getSensorIpListByBorderRouterIp/{borderRouterIp}",
                method=GET,
                headers="ModelAttribute=getSensorIpListByBorderRouterIp",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public java.util.List<java.lang.String> getSensorIpListByBorderRouterIp(@PathVariable
                                                                        java.lang.String borderRouterIp)

Get all sensor IP for the input border router IP. If there is no sensor connected to the given border router or the border router doesn't exist, return an empty list "[]".

Parameters:

borderRouterIp - path variable, border router IP.

Returns:

A list of sensor IP.

getAllSensorIp

@RequestMapping(value="/getAllSensorIp",
                method=GET,
                headers="ModelAttribute=getAllSensorIp",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public java.util.List<java.lang.String> getAllSensorIp()

Gets all sensor ip. Restful API. If there is no sensor, return an empty list "[]".

Returns:

A list of String contains all sensor IP addresses.

getAllCurrentData

@RequestMapping(value="/get/all/current",
                method=GET,
                headers="ModelAttribute=getAllDataFromSensor",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public DataPackage getAllCurrentData()
                              throws com.fasterxml.jackson.core.JsonProcessingException

Gets all current data from each sensor, not from database. Also these data entries will not be stored in database.

Returns:

An instance of DataPackage that contains all current data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getAllDataFromDatabase

@RequestMapping(value="/get/all/database",
                method=GET,
                headers="ModelAttribute=getAllDataFromDatabase",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public DataPackage getAllDataFromDatabase()

Gets all data from database, map to a DataPackage object.

Returns:

An instance of DataPackage that contains all data in database.

getDataForBorderRouterFromDB

@RequestMapping(value="/get/{borderRouterIp}/database",
                method=GET,
                headers="ModelAttribute=getDataForBorderRouterFromDatabase",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public BorderRouterWrapper getDataForBorderRouterFromDB(@PathVariable
                                                        java.lang.String borderRouterIp)

Fetching data from database for given border router.

Returns:

border router wrapper

clearAllData

@RequestMapping(value="/delete/all",
                method=DELETE,
                headers="ModelAttribute=deleteAllData",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public int clearAllData()

Delete all data in database. Return the number of entries deleted.

Returns:

the number of deleted entries.

getCurrentDataForBorderRouter

@RequestMapping(value="/get/{borderRouterIp}/sensor",
                method=GET,
                headers="ModelAttribute=getDataForBorderRouterFromSensor",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public BorderRouterWrapper getCurrentDataForBorderRouter(@PathVariable
                                                         java.lang.String borderRouterIp)
                                                  throws com.fasterxml.jackson.core.JsonProcessingException

Fetching data from sensor for given border router. Return null if the input border router IP doesn't exist in database.

Parameters:

borderRouterIp - parameter from path string

Returns:

an instance of BorderRouterWrapper

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getAllBorderRouterIpAndName

@RequestMapping(value="/get/borderRouterIpAndName",
                method=GET,
                headers="ModelAttribute=getAllBorderRouterIpAndName",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public java.util.List<java.lang.String[]> getAllBorderRouterIpAndName()

get a list of "borderRouterIP, borderRouterName" pair for all border router in database. If there is no borderRouter in database, return an empty list.

Returns:

a list of "borderRouterIP, borderRouterName" pair