Package org.lockss.laaws.rs.api

Interface WaybackApi

All Known Implementing Classes:

WaybackApiController

@Validated
public interface WaybackApi

Method Summary

Modifier and Type	Method	Description
default org.springframework.http.ResponseEntity<String>	getCdxOwb(String namespace, @Valid String q, @Valid Integer count, @Valid Integer startPage, String accept, String acceptEncoding)
default org.springframework.http.ResponseEntity<String>	getCdxPywb(String namespace, @Valid String url, @Valid Integer limit, @Valid String matchType, @Valid String sort, @Valid String closest, @Valid String output, @Valid String fl, String accept, String acceptEncoding)
WaybackApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getWarcArchive(String fileName, String accept, String acceptEncoding, String range)

Method Details

getDelegate

WaybackApiDelegate getDelegate()

getCdxOwb

@RequestMapping(value="/wayback/cdx/owb/{namespace}",
                produces={"application/xml","application/json"},
                method=GET)
default org.springframework.http.ResponseEntity<String> getCdxOwb(@PathVariable("namespace")
 String namespace,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="count",required=false)
 @Valid Integer count,
 @Valid @RequestParam(value="start_page",required=false)
 @Valid Integer startPage,
 @RequestHeader(value="Accept",required=false)
 String accept,
 @RequestHeader(value="Accept-Encoding",required=false)
 String acceptEncoding)

getCdxPywb

@RequestMapping(value="/wayback/cdx/pywb/{namespace}",
                produces={"text/plain","application/json"},
                method=GET)
default org.springframework.http.ResponseEntity<String> getCdxPywb(@PathVariable("namespace")
 String namespace,
 @Valid @RequestParam(value="url",required=false)
 @Valid String url,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="matchType",required=false)
 @Valid String matchType,
 @Valid @RequestParam(value="sort",required=false)
 @Valid String sort,
 @Valid @RequestParam(value="closest",required=false)
 @Valid String closest,
 @Valid @RequestParam(value="output",required=false)
 @Valid String output,
 @Valid @RequestParam(value="fl",required=false)
 @Valid String fl,
 @RequestHeader(value="Accept",required=false)
 String accept,
 @RequestHeader(value="Accept-Encoding",required=false)
 String acceptEncoding)

getWarcArchive

@RequestMapping(value="/wayback/warcs/{fileName}",
                produces={"application/warc","application/json"},
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getWarcArchive(@PathVariable("fileName")
 String fileName,
 @RequestHeader(value="Accept",required=false)
 String accept,
 @RequestHeader(value="Accept-Encoding",required=false)
 String acceptEncoding,
 @RequestHeader(value="Range",required=false)
 String range)