com.sitewhere.web.rest.controllers

Class SchedulesController

java.lang.Object

com.sitewhere.web.rest.RestController

com.sitewhere.web.rest.controllers.SchedulesController

@Controller
@RequestMapping(value="/schedules")
public class SchedulesController
extends RestController

Controller for schedule operations.

Author:

Derek Adams

Constructor Summary

Constructors

Constructor and Description
SchedulesController()

Method Summary

Methods

Modifier and Type	Method and Description
com.sitewhere.spi.scheduling.ISchedule	createSchedule(com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Create a schedule.
com.sitewhere.spi.scheduling.ISchedule	deleteSchedule(String token, boolean force, javax.servlet.http.HttpServletRequest servletRequest) Delete a schedule.
com.sitewhere.spi.scheduling.ISchedule	getScheduleByToken(String token, javax.servlet.http.HttpServletRequest servletRequest) Get a schedule by token.
protected com.sitewhere.spi.scheduling.IScheduleManagement	getScheduleManagement(javax.servlet.http.HttpServletRequest servletRequest) Get the schedule management implementation for the current tenant.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.scheduling.ISchedule>	listSchedules(int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest) List schedules that match criteria.
com.sitewhere.spi.scheduling.ISchedule	updateSchedule(com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest request, String token, javax.servlet.http.HttpServletRequest servletRequest) Update an existing schedule.

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

SchedulesController

public SchedulesController()

Method Detail

createSchedule

@RequestMapping(method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.scheduling.ISchedule createSchedule(@RequestBody
                                                                                        com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest request,
                                                                                        javax.servlet.http.HttpServletRequest servletRequest)
                                                      throws com.sitewhere.spi.SiteWhereException

Create a schedule.

Parameters:

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getScheduleByToken

@RequestMapping(value="/{token}",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.scheduling.ISchedule getScheduleByToken(@PathVariable
                                                                                            String token,
                                                                                            javax.servlet.http.HttpServletRequest servletRequest)
                                                          throws com.sitewhere.spi.SiteWhereException

Get a schedule by token.

Parameters:

token -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

updateSchedule

@RequestMapping(value="/{token}",
                method=PUT)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.scheduling.ISchedule updateSchedule(@RequestBody
                                                                                        com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest request,
                                                                                        @PathVariable
                                                                                        String token,
                                                                                        javax.servlet.http.HttpServletRequest servletRequest)
                                                      throws com.sitewhere.spi.SiteWhereException

Update an existing schedule.

Parameters:

request -

token -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listSchedules

@RequestMapping(method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.scheduling.ISchedule> listSchedules(@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 schedules that match criteria.

Parameters:

page -

pageSize -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

deleteSchedule

@RequestMapping(value="/{token}",
                method=DELETE)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.scheduling.ISchedule deleteSchedule(@PathVariable
                                                                                        String token,
                                                                                        @RequestParam(defaultValue="false")
                                                                                        boolean force,
                                                                                        javax.servlet.http.HttpServletRequest servletRequest)
                                                      throws com.sitewhere.spi.SiteWhereException

Delete a schedule.

Parameters:

token -

force -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getScheduleManagement

protected com.sitewhere.spi.scheduling.IScheduleManagement getScheduleManagement(javax.servlet.http.HttpServletRequest servletRequest)
                                                                          throws com.sitewhere.spi.SiteWhereException

Get the schedule management implementation for the current tenant.

Parameters:

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException