org.lockss.laaws.crawler.api

Interface CrawlsApi

All Known Implementing Classes:

CrawlsApiController

@Validated
 @RequestMapping(value="")
public interface CrawlsApi

Method Summary

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

Method Detail

getDelegate

CrawlsApiDelegate getDelegate()

deleteCrawlById

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

getCrawlById

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

getCrawlByMimeType

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

getCrawlErrors

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

getCrawlExcluded

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

getCrawlFetched

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

getCrawlNotModified

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

getCrawlParsed

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

getCrawlPending

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

getCrawls

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