Package org.lockss.laaws.crawler.api

Interface JobsApi

All Known Implementing Classes:

JobsApiController

@Validated
public interface JobsApi

Method Summary

Modifier and Type	Method	Description
default org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob>	deleteCrawlJob(String jobId)
default org.springframework.http.ResponseEntity<Void>	deleteJobs()
default org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob>	getCrawlJob(String jobId)
JobsApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<JobPager>	getJobs(@Valid Integer limit, @Valid String continuationToken)
default org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob>	queueJob(@Valid org.lockss.util.rest.crawler.CrawlDesc body)

Method Details

getDelegate

JobsApiDelegate getDelegate()

deleteCrawlJob

@RequestMapping(value="/jobs/{jobId}",
                produces="application/json",
                method=DELETE)
default org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob> deleteCrawlJob(@PathVariable("jobId")
 String jobId)

deleteJobs

@RequestMapping(value="/jobs",
                produces="application/json",
                method=DELETE)
default org.springframework.http.ResponseEntity<Void> deleteJobs()

getCrawlJob

@RequestMapping(value="/jobs/{jobId}",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob> getCrawlJob(@PathVariable("jobId")
 String jobId)

getJobs

@RequestMapping(value="/jobs",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<JobPager> getJobs(@Valid @RequestParam(value="limit",required=false,defaultValue="50")
 @Valid Integer limit,
 @Valid @RequestParam(value="continuationToken",required=false)
 @Valid String continuationToken)

queueJob

@RequestMapping(value="/jobs",
                produces="application/json",
                consumes="*/*",
                method=POST)
default org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob> queueJob(@Valid @RequestBody
 @Valid org.lockss.util.rest.crawler.CrawlDesc body)