Package com.twl.xg.controller

Class SettingController

java.lang.Object

com.twl.xg.controller.SettingController

@Controller
@RequestMapping("/setting")
public class SettingController
extends java.lang.Object

This controller accept URL pattern: /setting/**. All setting requests including customizing data types and turning on or turning off the periodically data fetching task are handled by this controller.

Version:

1.0

Author:

Xiaozheng Guo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	SettingController.RunnableTask	This is a nested inner class for creating scheduled task to fetching data periodically.

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractAccessBorderRouterService	accessBorderRouterService
private AbstractAccessSensorService	accessSensorService
private org.springframework.context.ApplicationContext	context
private DataFetchingAndMappingService	dataFetchingAndMappingService
private static org.apache.log4j.Logger	logger
private org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler	taskScheduler

Constructor Summary

Constructors

Constructor	Description
SettingController()

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getAllSensorIp()	Gets all sensor ip.
java.lang.String	saveBorderRouter(java.lang.String[][] routerIpAndName)	This handler sets up border router IP addresses for the server.
java.util.List<java.lang.String>	setDataTypes(java.lang.String[] dataTypes)	This handler accept request to set all data types the user want to query.
java.lang.String	setSensorName(java.lang.String[][] sensorIpAndName)	Set name for each sensor.
java.lang.String	startSavingData(int period)	Start the task that periodically saves data.
java.lang.String	stopSavingData()	Stop the task that periodically saves data if it exists.

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

accessBorderRouterService

@Autowired
@Qualifier("mockAccessBorderRouterService")
private AbstractAccessBorderRouterService accessBorderRouterService

context

@Autowired
private org.springframework.context.ApplicationContext context

taskScheduler

@Autowired
private org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler taskScheduler

logger

private static final org.apache.log4j.Logger logger

Constructor Detail

SettingController

public SettingController()

Method Detail

setDataTypes

@RequestMapping(value="/dataTypes",
                method=POST,
                headers="ModelAttribute=DataTypes",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public java.util.List<java.lang.String> setDataTypes(@RequestBody
                                                     java.lang.String[] dataTypes)

This handler accept request to set all data types the user want to query. Every time the dataTypeList gets updated, the sensor_data table in database will be cleared. Because the number of data fields have been changed. The response body contains JSON of the data type list. The input data type list has to contains at least one data type.

Parameters:

dataTypes - An array of data types string, this array is generated from JSON request body.

Returns:

Return a list of String which contains all data types name set by user.

saveBorderRouter

@RequestMapping(value="/setBorderRouter",
                method=POST,
                headers="ModelAttribute=borderRouterIpAndName",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public java.lang.String saveBorderRouter(@RequestBody
                                         java.lang.String[][] routerIpAndName)
                                  throws com.fasterxml.jackson.core.JsonProcessingException

This handler sets up border router IP addresses for the server. For setting up border router IP, we also need to add sensors that connected to each border router into database. If a border router IP address doesn't exist, we just ignore that border router IP. Before we add these border router into database, we need to clear the database first. Because we are initializing the server. For this API, one need to send a JSON string which is a 2D array, each row is a pair of router IP and name.

Parameters:

routerIpAndName - The input array of border router IP and name, key-value pair

Returns:

"HTTP_OK" indicates the operation is successful.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

setSensorName

@RequestMapping(value="/setSensorName",
                method=PUT,
                headers="ModelAttribute=sensorIpAndName",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public java.lang.String setSensorName(@RequestBody
                                      java.lang.String[][] sensorIpAndName)
                               throws com.fasterxml.jackson.core.JsonProcessingException

Set name for each sensor. Restful API.

Parameters:

sensorIpAndName - A 2D String array, each row is a sensorIP-sensorName pair.

Returns:

"HTTP_OK" indicates the operation is successful.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

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.

Returns:

A list of String contains all sensor IP addresses.

startSavingData

@RequestMapping(value="/startTask/savingData",
                method=POST,
                headers="ModelAttribute=startSavingData",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public java.lang.String startSavingData(@RequestParam
                                        int period)

Start the task that periodically saves data. The minimum period is 1000 milliseconds.

Parameters:

period - The time period between each execution.

Returns:

"HTTP_OK" on success.

stopSavingData

@RequestMapping(value="/stopTask/savingData",
                method=POST,
                headers="ModelAttribute=stopSavingData",
                produces="application/json",
                consumes="application/json")
@ResponseBody
public java.lang.String stopSavingData()

Stop the task that periodically saves data if it exists.

Returns:

"HTTP_OK" on success.