Package org.lockss.laaws.crawler.api

Interface CrawlsApi

All Known Implementing Classes:

CrawlsApiController

@Validated
public interface CrawlsApi

Method Summary

Modifier and Type	Method	Description
default org.springframework.http.ResponseEntity<CrawlStatus>	getCrawlById(String jobId)
default org.springframework.http.ResponseEntity<UrlPager>	getCrawlByMimeType(String jobId, String type, @Valid Integer limit, @Valid String continuationToken)
default org.springframework.http.ResponseEntity<UrlPager>	getCrawlErrors(String jobId, @Valid Integer limit, @Valid String continuationToken)
default org.springframework.http.ResponseEntity<UrlPager>	getCrawlExcluded(String jobId, @Valid Integer limit, @Valid String continuationToken)
default org.springframework.http.ResponseEntity<UrlPager>	getCrawlFetched(String jobId, @Valid Integer limit, @Valid String continuationToken)
default org.springframework.http.ResponseEntity<UrlPager>	getCrawlNotModified(String jobId, @Valid Integer limit, @Valid String continuationToken)
default org.springframework.http.ResponseEntity<UrlPager>	getCrawlParsed(String jobId, @Valid Integer limit, @Valid String continuationToken)
default org.springframework.http.ResponseEntity<UrlPager>	getCrawlPending(String jobId, @Valid Integer limit, @Valid String continuationToken)
default org.springframework.http.ResponseEntity<CrawlPager>	getCrawls(@Valid Integer limit, @Valid String continuationToken)
CrawlsApiDelegate	getDelegate()

Method Details

getDelegate

CrawlsApiDelegate getDelegate()

getCrawlById

@RequestMapping(value="/crawls/{jobId}",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<CrawlStatus> getCrawlById(@PathVariable("jobId")
 String jobId)

getCrawlByMimeType

@RequestMapping(value="/crawls/{jobId}/mimeType/{type}",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<UrlPager> getCrawlByMimeType(@PathVariable("jobId")
 String jobId,
 @PathVariable("type")
 String type,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="continuationToken",required=false)
 @Valid String continuationToken)

getCrawlErrors

@RequestMapping(value="/crawls/{jobId}/errors",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<UrlPager> getCrawlErrors(@PathVariable("jobId")
 String jobId,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="continuationToken",required=false)
 @Valid String continuationToken)

getCrawlExcluded

@RequestMapping(value="/crawls/{jobId}/excluded",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<UrlPager> getCrawlExcluded(@PathVariable("jobId")
 String jobId,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="continuationToken",required=false)
 @Valid String continuationToken)

getCrawlFetched

@RequestMapping(value="/crawls/{jobId}/fetched",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<UrlPager> getCrawlFetched(@PathVariable("jobId")
 String jobId,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="continuationToken",required=false)
 @Valid String continuationToken)

getCrawlNotModified

@RequestMapping(value="/crawls/{jobId}/notModified",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<UrlPager> getCrawlNotModified(@PathVariable("jobId")
 String jobId,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="continuationToken",required=false)
 @Valid String continuationToken)

getCrawlParsed

@RequestMapping(value="/crawls/{jobId}/parsed",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<UrlPager> getCrawlParsed(@PathVariable("jobId")
 String jobId,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="continuationToken",required=false)
 @Valid String continuationToken)

getCrawlPending

@RequestMapping(value="/crawls/{jobId}/pending",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<UrlPager> getCrawlPending(@PathVariable("jobId")
 String jobId,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="continuationToken",required=false)
 @Valid String continuationToken)

getCrawls

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