com.sitewhere.web.rest.controllers

Class SitesController

java.lang.Object

com.sitewhere.web.rest.RestController

com.sitewhere.web.rest.controllers.SitesController

@Controller
@RequestMapping(value="/sites")
public class SitesController
extends RestController

Controller for site operations.

Author:

Derek Adams

Constructor Summary

Constructors

Constructor and Description
SitesController()

Method Summary

Methods

Modifier and Type	Method and Description
com.sitewhere.rest.model.device.Site	createSite(com.sitewhere.rest.model.device.request.SiteCreateRequest input, javax.servlet.http.HttpServletRequest servletRequest) Create a new site.
com.sitewhere.rest.model.device.Zone	createZone(String siteToken, com.sitewhere.rest.model.device.request.ZoneCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Create a new zone for a site.
com.sitewhere.rest.model.device.Site	deleteSiteByToken(String siteToken, boolean force, javax.servlet.http.HttpServletRequest servletRequest) Delete information for a given site based on site token.
com.sitewhere.rest.model.device.Site	getSiteByToken(String siteToken, javax.servlet.http.HttpServletRequest servletRequest) Get information for a given site based on site token.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.rest.model.device.DeviceAssignment>	listAssignmentsForSite(String siteToken, boolean includeDevice, boolean includeAsset, boolean includeSite, int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest) Find device assignments associated with a site.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceAlert>	listDeviceAlertsForSite(String siteToken, int page, int pageSize, Date startDate, Date endDate, javax.servlet.http.HttpServletRequest servletRequest) Get device alerts for a given site.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceCommandInvocation>	listDeviceCommandInvocationsForSite(String siteToken, int page, int pageSize, Date startDate, Date endDate, javax.servlet.http.HttpServletRequest servletRequest) Get device command invocations for a given site.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceCommandResponse>	listDeviceCommandResponsesForSite(String siteToken, int page, int pageSize, Date startDate, Date endDate, javax.servlet.http.HttpServletRequest servletRequest) Get device command responses for a given site.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceLocation>	listDeviceLocationsForSite(String siteToken, int page, int pageSize, Date startDate, Date endDate, javax.servlet.http.HttpServletRequest servletRequest) Get device locations for a given site.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceMeasurements>	listDeviceMeasurementsForSite(String siteToken, int page, int pageSize, Date startDate, Date endDate, javax.servlet.http.HttpServletRequest servletRequest) Get device measurements for a given site.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceStateChange>	listDeviceStateChangesForSite(String siteToken, int page, int pageSize, Date startDate, Date endDate, javax.servlet.http.HttpServletRequest servletRequest) Get device state changes for a given site.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.ISite>	listSites(int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest) List all sites and wrap as search results.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.IZone>	listZonesForSite(String siteToken, int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest) List all zones for a site.
com.sitewhere.rest.model.device.Site	updateSite(String siteToken, com.sitewhere.rest.model.device.request.SiteCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Update information for a site.

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

SitesController

public SitesController()

Method Detail

createSite

@RequestMapping(method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.rest.model.device.Site createSite(@RequestBody
                                                                                  com.sitewhere.rest.model.device.request.SiteCreateRequest input,
                                                                                  javax.servlet.http.HttpServletRequest servletRequest)
                                                throws com.sitewhere.spi.SiteWhereException

Create a new site.

Parameters:

input -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getSiteByToken

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

Get information for a given site based on site token.

Parameters:

siteToken -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

updateSite

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

Update information for a site.

Parameters:

input -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

deleteSiteByToken

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

Delete information for a given site based on site token.

Parameters:

siteToken -

force -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listSites

@RequestMapping(method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.ISite> listSites(@RequestParam(required=false,defaultValue="1")
                                                                                                                    int page,
                                                                                                                    @RequestParam(required=false,defaultValue="100")
                                                                                                                    int pageSize,
                                                                                                                    javax.servlet.http.HttpServletRequest servletRequest)
                                                                                  throws com.sitewhere.spi.SiteWhereException

List all sites and wrap as search results.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listDeviceMeasurementsForSite

@RequestMapping(value="/{siteToken}/measurements",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceMeasurements> listDeviceMeasurementsForSite(@PathVariable
                                                                                                                                                            String siteToken,
                                                                                                                                                            @RequestParam(required=false,defaultValue="1")
                                                                                                                                                            int page,
                                                                                                                                                            @RequestParam(required=false,defaultValue="100")
                                                                                                                                                            int pageSize,
                                                                                                                                                            @RequestParam(required=false)
                                                                                                                                                            Date startDate,
                                                                                                                                                            @RequestParam(required=false)
                                                                                                                                                            Date endDate,
                                                                                                                                                            javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                                          throws com.sitewhere.spi.SiteWhereException

Get device measurements for a given site.

Parameters:

siteToken -

count -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listDeviceLocationsForSite

@RequestMapping(value="/{siteToken}/locations",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceLocation> listDeviceLocationsForSite(@PathVariable
                                                                                                                                                     String siteToken,
                                                                                                                                                     @RequestParam(required=false,defaultValue="1")
                                                                                                                                                     int page,
                                                                                                                                                     @RequestParam(required=false,defaultValue="100")
                                                                                                                                                     int pageSize,
                                                                                                                                                     @RequestParam(required=false)
                                                                                                                                                     Date startDate,
                                                                                                                                                     @RequestParam(required=false)
                                                                                                                                                     Date endDate,
                                                                                                                                                     javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                                   throws com.sitewhere.spi.SiteWhereException

Get device locations for a given site.

Parameters:

siteToken -

count -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listDeviceAlertsForSite

@RequestMapping(value="/{siteToken}/alerts",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceAlert> listDeviceAlertsForSite(@PathVariable
                                                                                                                                               String siteToken,
                                                                                                                                               @RequestParam(required=false,defaultValue="1")
                                                                                                                                               int page,
                                                                                                                                               @RequestParam(required=false,defaultValue="100")
                                                                                                                                               int pageSize,
                                                                                                                                               @RequestParam(required=false)
                                                                                                                                               Date startDate,
                                                                                                                                               @RequestParam(required=false)
                                                                                                                                               Date endDate,
                                                                                                                                               javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                             throws com.sitewhere.spi.SiteWhereException

Get device alerts for a given site.

Parameters:

siteToken -

count -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listDeviceCommandInvocationsForSite

@RequestMapping(value="/{siteToken}/invocations",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceCommandInvocation> listDeviceCommandInvocationsForSite(@PathVariable
                                                                                                                                                                       String siteToken,
                                                                                                                                                                       @RequestParam(required=false,defaultValue="1")
                                                                                                                                                                       int page,
                                                                                                                                                                       @RequestParam(required=false,defaultValue="100")
                                                                                                                                                                       int pageSize,
                                                                                                                                                                       @RequestParam(required=false)
                                                                                                                                                                       Date startDate,
                                                                                                                                                                       @RequestParam(required=false)
                                                                                                                                                                       Date endDate,
                                                                                                                                                                       javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                                                     throws com.sitewhere.spi.SiteWhereException

Get device command invocations for a given site.

Parameters:

siteToken -

count -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listDeviceCommandResponsesForSite

@RequestMapping(value="/{siteToken}/responses",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceCommandResponse> listDeviceCommandResponsesForSite(@PathVariable
                                                                                                                                                                   String siteToken,
                                                                                                                                                                   @RequestParam(required=false,defaultValue="1")
                                                                                                                                                                   int page,
                                                                                                                                                                   @RequestParam(required=false,defaultValue="100")
                                                                                                                                                                   int pageSize,
                                                                                                                                                                   @RequestParam(required=false)
                                                                                                                                                                   Date startDate,
                                                                                                                                                                   @RequestParam(required=false)
                                                                                                                                                                   Date endDate,
                                                                                                                                                                   javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                                                 throws com.sitewhere.spi.SiteWhereException

Get device command responses for a given site.

Parameters:

siteToken -

count -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listDeviceStateChangesForSite

@RequestMapping(value="/{siteToken}/statechanges",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceStateChange> listDeviceStateChangesForSite(@PathVariable
                                                                                                                                                           String siteToken,
                                                                                                                                                           @RequestParam(required=false,defaultValue="1")
                                                                                                                                                           int page,
                                                                                                                                                           @RequestParam(required=false,defaultValue="100")
                                                                                                                                                           int pageSize,
                                                                                                                                                           @RequestParam(required=false)
                                                                                                                                                           Date startDate,
                                                                                                                                                           @RequestParam(required=false)
                                                                                                                                                           Date endDate,
                                                                                                                                                           javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                                         throws com.sitewhere.spi.SiteWhereException

Get device state changes for a given site.

Parameters:

siteToken -

count -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listAssignmentsForSite

@RequestMapping(value="/{siteToken}/assignments",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.rest.model.device.DeviceAssignment> listAssignmentsForSite(@PathVariable
                                                                                                                                                   String siteToken,
                                                                                                                                                   @RequestParam(defaultValue="false")
                                                                                                                                                   boolean includeDevice,
                                                                                                                                                   @RequestParam(defaultValue="false")
                                                                                                                                                   boolean includeAsset,
                                                                                                                                                   @RequestParam(defaultValue="false")
                                                                                                                                                   boolean includeSite,
                                                                                                                                                   @RequestParam(required=false,defaultValue="1")
                                                                                                                                                   int page,
                                                                                                                                                   @RequestParam(required=false,defaultValue="100")
                                                                                                                                                   int pageSize,
                                                                                                                                                   javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                                 throws com.sitewhere.spi.SiteWhereException

Find device assignments associated with a site.

Parameters:

siteToken -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

createZone

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

Create a new zone for a site.

Parameters:

input -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listZonesForSite

@RequestMapping(value="/{siteToken}/zones",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.IZone> listZonesForSite(@PathVariable
                                                                                                                           String siteToken,
                                                                                                                           @RequestParam(required=false,defaultValue="1")
                                                                                                                           int page,
                                                                                                                           @RequestParam(required=false,defaultValue="100")
                                                                                                                           int pageSize,
                                                                                                                           javax.servlet.http.HttpServletRequest servletRequest)
                                                                                         throws com.sitewhere.spi.SiteWhereException

List all zones for a site.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException