com.sitewhere.web.rest.controllers

Class ScheduledJobsController

java.lang.Object

com.sitewhere.web.rest.RestController

com.sitewhere.web.rest.controllers.ScheduledJobsController

@Controller
@RequestMapping(value="/jobs")
public class ScheduledJobsController
extends RestController

Controller for scheduled jobs.

Author:

Derek Adams

Constructor Summary

Constructors

Constructor and Description
ScheduledJobsController()

Method Summary

Methods

Modifier and Type	Method and Description
com.sitewhere.spi.scheduling.IScheduledJob	createScheduledJob(com.sitewhere.rest.model.scheduling.request.ScheduledJobCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Create a new scheduled job.
com.sitewhere.spi.scheduling.IScheduledJob	deleteScheduledJob(String token, boolean force, javax.servlet.http.HttpServletRequest servletRequest) Delete an existing scheduled job.
com.sitewhere.spi.scheduling.IScheduledJob	getScheduledJobByToken(String token, javax.servlet.http.HttpServletRequest servletRequest)
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.IScheduledJob>	listScheduledJobs(boolean includeContext, int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest) List scheduled jobs that match the criteria.
com.sitewhere.spi.scheduling.IScheduledJob	updateScheduledJob(com.sitewhere.rest.model.scheduling.request.ScheduledJobCreateRequest request, String token, javax.servlet.http.HttpServletRequest servletRequest) Update an existing scheduled job.

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

ScheduledJobsController

public ScheduledJobsController()

Method Detail

createScheduledJob

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

Create a new scheduled job.

Parameters:

request -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getScheduledJobByToken

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

Throws:

com.sitewhere.spi.SiteWhereException

updateScheduledJob

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

Update an existing scheduled job.

Parameters:

request -

token -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listScheduledJobs

@RequestMapping(method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.scheduling.IScheduledJob> listScheduledJobs(@RequestParam(defaultValue="false")
                                                                                                                                        boolean includeContext,
                                                                                                                                        @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 scheduled jobs that match the criteria.

Parameters:

includeContext -

page -

pageSize -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

deleteScheduledJob

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

Delete an existing scheduled job.

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