org.kuali.mobility.push.controllers

Class DeviceController

java.lang.Object

org.kuali.mobility.push.controllers.DeviceController

@Controller
@RequestMapping(value="/device")
public class DeviceController
extends Object

Controller for managing devices

Since:

2.0.0

Author:

Kuali Mobility Team (mobility.dev@kuali.org)

Constructor Summary

Constructors

Constructor and Description
DeviceController()

Method Summary

Methods

Modifier and Type	Method and Description
String	devices(javax.servlet.http.HttpServletRequest request, org.springframework.ui.Model uiModel, String key) A controller method for accessing all devices registered with push notifications.
String	devicesByKeyword(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model uiModel, String keyword) A controller method that provides an interface for search devices via keyword and returns a JSON list to the requesting JSP/HMLT page.
DeviceService	getDeviceService() A reference to the DeviceService.
String	getDevicesFromUsername(org.springframework.ui.Model uiModel, javax.servlet.http.HttpServletRequest request, String username) A controller method for accessing all devices registered the correspond to a specified user.
UserDao	getUserDao() Get the controllers UserDao object.
String	getUserDetails(org.springframework.ui.Model uiModel, javax.servlet.http.HttpServletRequest request, String deviceHash) A Controller method for accessing the details of a given device and displaying it in the association jsp file.
String	getUsernameFromDeviceID(org.springframework.ui.Model uiModel, javax.servlet.http.HttpServletRequest request, String deviceId) A controller method for checking the existance of a device, and accessing basic details of said device.
String	index(org.springframework.ui.Model uiModel, javax.servlet.http.HttpServletRequest request) A controller method for loading the main index.jsp for the Device tool.
org.springframework.http.ResponseEntity<String>	ping() Simple controller which responds with 200.
org.springframework.http.ResponseEntity<String>	register(javax.servlet.http.HttpServletRequest request, String data) A controller method for registering a device for push notifications as defined by a JSON formatted string.
String	removeDevice(org.springframework.ui.Model uiModel, javax.servlet.http.HttpServletRequest request, String deviceHash) A controller method for accessing a deleting a specified device.
String	search(org.springframework.ui.Model uiModel, javax.servlet.http.HttpServletRequest request) A controller method for loading the keyword device search page.
void	setDeviceService(DeviceService deviceService) Sets the reference to the DeviceService
void	setUserDao(UserDao userDao) A method for setting the UserDao of the controller.
org.springframework.http.ResponseEntity<String>	update(javax.servlet.http.HttpServletRequest request, String data) A controller method for updating a pre-existing registered device.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceController

public DeviceController()

Method Detail

index

@RequestMapping(method=GET)
public String index(org.springframework.ui.Model uiModel,
                          javax.servlet.http.HttpServletRequest request)

A controller method for loading the main index.jsp for the Device tool.

Parameters:

uiModel -

Returns:

search

@RequestMapping(value="search",
                method=GET)
public String search(org.springframework.ui.Model uiModel,
                           javax.servlet.http.HttpServletRequest request)

A controller method for loading the keyword device search page.

Parameters:

uiModel -

request -

Returns:

getUserDetails

@RequestMapping(value="/detail/{deviceHash}",
                method=GET)
public String getUserDetails(org.springframework.ui.Model uiModel,
                                   javax.servlet.http.HttpServletRequest request,
                                   @PathVariable(value="deviceHash")
                                   String deviceHash)

A Controller method for accessing the details of a given device and displaying it in the association jsp file.

Parameters:

uiModel -

request -

deviceHash - Id of the device to show.

Returns:

removeDevice

@RequestMapping(value="/remove/{deviceHash}",
                method=GET)
public String removeDevice(org.springframework.ui.Model uiModel,
                                 javax.servlet.http.HttpServletRequest request,
                                 @PathVariable(value="deviceHash")
                                 String deviceHash)

A controller method for accessing a deleting a specified device.

Parameters:

uiModel -

request -

deviceHash - Id of the device to delete.

Returns:

devices

@RequestMapping(value="/list",
                method=GET)
public String devices(javax.servlet.http.HttpServletRequest request,
                            org.springframework.ui.Model uiModel,
                            @RequestParam(value="key",required=false)
                            String key)

A controller method for accessing all devices registered with push notifications.

Parameters:

request -

uiModel -

key -

Returns:

register

@RequestMapping(value="/register",
                method=GET)
public org.springframework.http.ResponseEntity<String> register(javax.servlet.http.HttpServletRequest request,
                                                                      @RequestParam(value="data",required=true)
                                                                      String data)

A controller method for registering a device for push notifications as defined by a JSON formatted string.

Parameters:

request -

data - JSON formatted string describing a device to be register for push notifications.

Returns:

update

@RequestMapping(value="/update",
                method=GET)
public org.springframework.http.ResponseEntity<String> update(javax.servlet.http.HttpServletRequest request,
                                                                    @RequestParam(value="data",required=true)
                                                                    String data)

A controller method for updating a pre-existing registered device.

Parameters:

request -

data - A JSON formatted string describing details of a device to update.

Returns:

getUsernameFromDeviceID

@RequestMapping(value="/deviceid",
                method=POST)
@ResponseBody
public String getUsernameFromDeviceID(org.springframework.ui.Model uiModel,
                                                         javax.servlet.http.HttpServletRequest request,
                                                         @RequestParam(value="deviceid",required=false)
                                                         String deviceId)

A controller method for checking the existance of a device, and accessing basic details of said device.

Parameters:

uiModel -

request -

deviceId - Id of device to check.

Returns:

String - A JSON formatted string giving basic details of the specified device.

getDevicesFromUsername

@RequestMapping(value="/username",
                method=POST)
@ResponseBody
public String getDevicesFromUsername(org.springframework.ui.Model uiModel,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        @RequestParam(value="username",required=false)
                                                        String username)

A controller method for accessing all devices registered the correspond to a specified user.

Parameters:

uiModel -

request -

username - Username associated with devices to access.

Returns:

String - A JSON formatted string listing devices associated with a username.

devicesByKeyword

@RequestMapping(value="keyword/{keyword}",
                method=GET,
                headers="Accept=application/json")
@ResponseBody
public String devicesByKeyword(javax.servlet.http.HttpServletRequest request,
                                                  javax.servlet.http.HttpServletResponse response,
                                                  org.springframework.ui.Model uiModel,
                                                  @PathVariable(value="keyword")
                                                  String keyword)

A controller method that provides an interface for search devices via keyword and returns a JSON list to the requesting JSP/HMLT page.

Parameters:

request -

response -

uiModel -

keyword -

Returns:

ping

@RequestMapping(value="/ping",
                method=GET)
public org.springframework.http.ResponseEntity<String> ping()

Simple controller which responds with 200. This controller can be used by devices to check if the server is online

Returns:

setDeviceService

public void setDeviceService(DeviceService deviceService)

Sets the reference to the DeviceService

Parameters:

deviceService -

getDeviceService

public DeviceService getDeviceService()

A reference to the DeviceService.

getUserDao

public UserDao getUserDao()

Get the controllers UserDao object.

Returns:

setUserDao

public void setUserDao(UserDao userDao)

A method for setting the UserDao of the controller.

Parameters:

userDao -