com.sitewhere.web.rest.controllers

Class ZonesController

java.lang.Object

com.sitewhere.web.rest.RestController

com.sitewhere.web.rest.controllers.ZonesController

@Controller
@RequestMapping(value="/zones")
public class ZonesController
extends RestController

Controller for site operations.

Author:

Derek Adams

Constructor Summary

Constructors

Constructor and Description
ZonesController()

Method Summary

Methods

Modifier and Type	Method and Description
com.sitewhere.rest.model.device.Zone	deleteZone(String zoneToken, boolean force, javax.servlet.http.HttpServletRequest servletRequest) Delete an existing zone.
com.sitewhere.rest.model.device.Zone	getZone(String zoneToken, javax.servlet.http.HttpServletRequest servletRequest)
com.sitewhere.rest.model.device.Zone	updateZone(String zoneToken, com.sitewhere.rest.model.device.request.ZoneCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Update information for a zone.

Methods inherited from class com.sitewhere.web.rest.RestController

getTenant, getTenantAuthToken, handleAccessDenied, handleMissingContent, handleRuntimeException, handleSuccessfulAdd, handleSystemException

Methods inherited from class java.lang.Object

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

Constructor Detail

ZonesController

public ZonesController()

Method Detail

getZone

@RequestMapping(value="/{zoneToken}",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.rest.model.device.Zone getZone(@PathVariable
                                                                               String zoneToken,
                                                                               javax.servlet.http.HttpServletRequest servletRequest)
                                             throws com.sitewhere.spi.SiteWhereException

Throws:

com.sitewhere.spi.SiteWhereException

updateZone

@RequestMapping(value="/{zoneToken}",
                method=PUT)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.rest.model.device.Zone updateZone(@PathVariable
                                                                                  String zoneToken,
                                                                                  @RequestBody
                                                                                  com.sitewhere.rest.model.device.request.ZoneCreateRequest request,
                                                                                  javax.servlet.http.HttpServletRequest servletRequest)
                                                throws com.sitewhere.spi.SiteWhereException

Update information for a zone.

Parameters:

input -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

deleteZone

@RequestMapping(value="/{zoneToken}",
                method=DELETE)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.rest.model.device.Zone deleteZone(@PathVariable
                                                                                  String zoneToken,
                                                                                  @RequestParam(defaultValue="false")
                                                                                  boolean force,
                                                                                  javax.servlet.http.HttpServletRequest servletRequest)
                                                throws com.sitewhere.spi.SiteWhereException

Delete an existing zone.

Parameters:

zoneToken -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException