SiteWhereController (SiteWhere Web Components 1.5.0 API)

java.lang.Object
- com.sitewhere.web.mvc.MvcController
- - com.sitewhere.web.mvc.SiteWhereController

@Controller
public class SiteWhereController
extends MvcController

Spring MVC controller for SiteWhere web application.

Author:: dadams

Field Summary
- Fields inherited from class com.sitewhere.web.mvc.MvcController
  DATA_AUTHORITIES, DATA_CURRENT_USER, DATA_REDIRECT, DATA_TENANT, DATA_VERSION, SESSION_TENANT

Constructor Summary

Constructors
Constructor and Description

SiteWhereController()

Constructors
Constructor and Description
`SiteWhereController()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addTenantData(com.sitewhere.spi.user.ITenant tenant, Map<String,Object> data)` Add site and specification data if tenant is active.
`org.springframework.web.servlet.ModelAndView`	`assignmentDetail(String token, javax.servlet.http.HttpServletRequest request)` Display the "assignment detail" page.
`org.springframework.web.servlet.ModelAndView`	`assignmentEmulator(String token, javax.servlet.http.HttpServletRequest request)` Display the "assignment emulator" page.
`org.springframework.web.servlet.ModelAndView`	`batchCommandInvocationDetail(String batchToken, javax.servlet.http.HttpServletRequest request)` View details about a batch command invocation.
`org.springframework.web.servlet.ModelAndView`	`chooseTenant(String tenantId, String redirect, javax.servlet.http.HttpServletRequest servletRequest)`
`org.springframework.web.servlet.ModelAndView`	`deviceDetail(String hardwareId, javax.servlet.http.HttpServletRequest request)` Display the "device detail" page.
`org.springframework.web.servlet.ModelAndView`	`deviceGroupDetail(String groupToken, javax.servlet.http.HttpServletRequest request)` Display the "device group detail" page.
`org.springframework.web.servlet.ModelAndView`	`listAssetCategories(javax.servlet.http.HttpServletRequest request)` Display the "asset categories" page.
`org.springframework.web.servlet.ModelAndView`	`listBatchOperations(javax.servlet.http.HttpServletRequest request)` Display the "list batch operations" page.
`org.springframework.web.servlet.ModelAndView`	`listCategoryAssets(String categoryId, javax.servlet.http.HttpServletRequest request)` Display the "category person assets" page.
`org.springframework.web.servlet.ModelAndView`	`listDeviceGroups(javax.servlet.http.HttpServletRequest request)` Display the "list device groups" page.
`org.springframework.web.servlet.ModelAndView`	`listDevices(String specification, String group, String groupsWithRole, String site, String dateRange, String beforeDate, String afterDate, boolean excludeAssigned, javax.servlet.http.HttpServletRequest request)` Display the "list devices" page.
`org.springframework.web.servlet.ModelAndView`	`listScheduledjobs(javax.servlet.http.HttpServletRequest request)` Display the "list scheduled jobs" page.
`org.springframework.web.servlet.ModelAndView`	`listSchedules(javax.servlet.http.HttpServletRequest request)` Display the "list schedules" page.
`org.springframework.web.servlet.ModelAndView`	`listSites(javax.servlet.http.HttpServletRequest request)` Display the "list sites" page.
`org.springframework.web.servlet.ModelAndView`	`listSpecifications(javax.servlet.http.HttpServletRequest request)` Display the "list device specifications" page.
`org.springframework.web.servlet.ModelAndView`	`listTenants(javax.servlet.http.HttpServletRequest request)` Display the "list tenants" page.
`org.springframework.web.servlet.ModelAndView`	`listUsers(javax.servlet.http.HttpServletRequest request)` Display the "list users" page.
`org.springframework.web.servlet.ModelAndView`	`login()` Display the "login" page.
`org.springframework.web.servlet.ModelAndView`	`loginFailed()` Display the "login" page after failed login.
`org.springframework.web.servlet.ModelAndView`	`serverInfo(javax.servlet.http.HttpServletRequest request)` Show SiteWhere server information.
`org.springframework.web.servlet.ModelAndView`	`showTenantChoices(String redirect, javax.servlet.http.HttpServletRequest servletRequest)` Display page for choosing tenant.
`org.springframework.web.servlet.ModelAndView`	`siteDetail(String siteToken, javax.servlet.http.HttpServletRequest request)` Display the "site detail" page.
`org.springframework.web.servlet.ModelAndView`	`specificationDetail(String token, javax.servlet.http.HttpServletRequest request)` Display the "specification detail" page.
`org.springframework.web.servlet.ModelAndView`	`viewTenant(String tenantId, javax.servlet.http.HttpServletRequest request)` View tenant details.

Methods inherited from class com.sitewhere.web.mvc.MvcController
assureTenant, createBaseData, getUrl, setChosenTenant, showError, showError

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SiteWhereController
```
public SiteWhereController()
```

Method Detail

login

@RequestMapping(value="/")
public org.springframework.web.servlet.ModelAndView login()

Display the "login" page.

Returns:

showTenantChoices

@RequestMapping(value="/tenant")
public org.springframework.web.servlet.ModelAndView showTenantChoices(@RequestParam(required=false)
                                                                            String redirect,
                                                                            javax.servlet.http.HttpServletRequest servletRequest)

Display page for choosing tenant.

Parameters:: redirect -; servletRequest -
Returns:

chooseTenant

@RequestMapping(value="/tenant/{tenantId}")
public org.springframework.web.servlet.ModelAndView chooseTenant(@PathVariable(value="tenantId")
                                                                       String tenantId,
                                                                       @RequestParam(required=false)
                                                                       String redirect,
                                                                       javax.servlet.http.HttpServletRequest servletRequest)

loginFailed

@RequestMapping(value="/loginFailed")
public org.springframework.web.servlet.ModelAndView loginFailed()

Display the "login" page after failed login.

Returns:

serverInfo

@RequestMapping(value="/server")
public org.springframework.web.servlet.ModelAndView serverInfo(javax.servlet.http.HttpServletRequest request)

Show SiteWhere server information.

Parameters:: request -
Returns:

listSites

@RequestMapping(value="/sites/list")
public org.springframework.web.servlet.ModelAndView listSites(javax.servlet.http.HttpServletRequest request)

Display the "list sites" page.

Parameters:: request -
Returns:

siteDetail

@RequestMapping(value="/sites/{siteToken}")
public org.springframework.web.servlet.ModelAndView siteDetail(@PathVariable(value="siteToken")
                                                                     String siteToken,
                                                                     javax.servlet.http.HttpServletRequest request)

Display the "site detail" page.

Parameters:: siteToken -; request -
Returns:

assignmentDetail

@RequestMapping(value="/assignments/{token}")
public org.springframework.web.servlet.ModelAndView assignmentDetail(@PathVariable(value="token")
                                                                           String token,
                                                                           javax.servlet.http.HttpServletRequest request)

Display the "assignment detail" page.

Parameters:: token -; request -
Returns:

assignmentEmulator

@RequestMapping(value="/assignments/{token}/emulator")
public org.springframework.web.servlet.ModelAndView assignmentEmulator(@PathVariable(value="token")
                                                                             String token,
                                                                             javax.servlet.http.HttpServletRequest request)

Display the "assignment emulator" page.

Parameters:: token -; request -
Returns:

listSpecifications

@RequestMapping(value="/specifications/list")
public org.springframework.web.servlet.ModelAndView listSpecifications(javax.servlet.http.HttpServletRequest request)

Display the "list device specifications" page.

Parameters:: request -
Returns:

specificationDetail

@RequestMapping(value="/specifications/{token}")
public org.springframework.web.servlet.ModelAndView specificationDetail(@PathVariable(value="token")
                                                                              String token,
                                                                              javax.servlet.http.HttpServletRequest request)

Display the "specification detail" page.

Parameters:: token -; request -
Returns:

listDevices

@RequestMapping(value="/devices/list")
public org.springframework.web.servlet.ModelAndView listDevices(@RequestParam(required=false)
                                                                      String specification,
                                                                      @RequestParam(required=false)
                                                                      String group,
                                                                      @RequestParam(required=false)
                                                                      String groupsWithRole,
                                                                      @RequestParam(required=false)
                                                                      String site,
                                                                      @RequestParam(required=false)
                                                                      String dateRange,
                                                                      @RequestParam(required=false)
                                                                      String beforeDate,
                                                                      @RequestParam(required=false)
                                                                      String afterDate,
                                                                      @RequestParam(required=false)
                                                                      boolean excludeAssigned,
                                                                      javax.servlet.http.HttpServletRequest request)

Display the "list devices" page.

Parameters:: specification -; group -; groupsWithRole -; dateRange -; beforeDate -; afterDate -; excludeAssigned -; request -
Returns:

deviceDetail

@RequestMapping(value="/devices/{hardwareId}")
public org.springframework.web.servlet.ModelAndView deviceDetail(@PathVariable(value="hardwareId")
                                                                       String hardwareId,
                                                                       javax.servlet.http.HttpServletRequest request)

Display the "device detail" page.

Parameters:: hardwareId -; request -
Returns:

listDeviceGroups

@RequestMapping(value="/groups/list")
public org.springframework.web.servlet.ModelAndView listDeviceGroups(javax.servlet.http.HttpServletRequest request)

Display the "list device groups" page.

Parameters:: request -
Returns:

deviceGroupDetail

@RequestMapping(value="/groups/{groupToken}")
public org.springframework.web.servlet.ModelAndView deviceGroupDetail(@PathVariable(value="groupToken")
                                                                            String groupToken,
                                                                            javax.servlet.http.HttpServletRequest request)

Display the "device group detail" page.

Parameters:: groupToken -; request -
Returns:

listAssetCategories

@RequestMapping(value="/assets/categories")
public org.springframework.web.servlet.ModelAndView listAssetCategories(javax.servlet.http.HttpServletRequest request)

Display the "asset categories" page.

Parameters:: request -
Returns:

listCategoryAssets

@RequestMapping(value="/assets/categories/{categoryId}")
public org.springframework.web.servlet.ModelAndView listCategoryAssets(@PathVariable(value="categoryId")
                                                                             String categoryId,
                                                                             javax.servlet.http.HttpServletRequest request)

Display the "category person assets" page.

Parameters:: categoryId -; request -
Returns:

listBatchOperations

@RequestMapping(value="/batch/list")
public org.springframework.web.servlet.ModelAndView listBatchOperations(javax.servlet.http.HttpServletRequest request)

Display the "list batch operations" page.

Parameters:: request -
Returns:

batchCommandInvocationDetail

@RequestMapping(value="/batch/command/{token}")
public org.springframework.web.servlet.ModelAndView batchCommandInvocationDetail(@PathVariable(value="token")
                                                                                       String batchToken,
                                                                                       javax.servlet.http.HttpServletRequest request)

View details about a batch command invocation.

Parameters:: batchToken -; request -
Returns:

listUsers

@RequestMapping(value="/users/list")
public org.springframework.web.servlet.ModelAndView listUsers(javax.servlet.http.HttpServletRequest request)

Display the "list users" page.

Parameters:: request -
Returns:

listTenants

@RequestMapping(value="/tenants/list")
public org.springframework.web.servlet.ModelAndView listTenants(javax.servlet.http.HttpServletRequest request)

Display the "list tenants" page.

Parameters:: request -
Returns:

viewTenant

@RequestMapping(value="/tenants/{tenantId}")
public org.springframework.web.servlet.ModelAndView viewTenant(@PathVariable(value="tenantId")
                                                                     String tenantId,
                                                                     javax.servlet.http.HttpServletRequest request)

View tenant details.

Parameters:: tenantId -; request -
Returns:

addTenantData

protected void addTenantData(com.sitewhere.spi.user.ITenant tenant,
                 Map<String,Object> data)
                      throws com.sitewhere.spi.SiteWhereException

Add site and specification data if tenant is active.

Parameters:: tenant -; data -
Throws:: com.sitewhere.spi.SiteWhereException

listSchedules

@RequestMapping(value="/schedules/list")
public org.springframework.web.servlet.ModelAndView listSchedules(javax.servlet.http.HttpServletRequest request)

Display the "list schedules" page.

Parameters:: request -
Returns:

listScheduledjobs

@RequestMapping(value="/jobs/list")
public org.springframework.web.servlet.ModelAndView listScheduledjobs(javax.servlet.http.HttpServletRequest request)

Display the "list scheduled jobs" page.

Parameters:: request -
Returns:

Class SiteWhereController

Field Summary

Fields inherited from class com.sitewhere.web.mvc.MvcController

Constructor Summary