Package org.lockss.laaws.rs.api

Interface ArtifactsApi

All Known Implementing Classes:

ArtifactsApiController

@Validated
public interface ArtifactsApi

Method Summary

Modifier and Type	Method	Description
default org.springframework.http.ResponseEntity<Artifact>	createArtifact(String artifactProps, @Valid org.springframework.web.multipart.MultipartFile payload, String httpResponseHeader)
default org.springframework.http.ResponseEntity<Void>	deleteArtifact(String uuid, @Valid String namespace)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getArtifactDataByMultipart(String uuid, @Valid String namespace, @Valid String includeContent)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getArtifactDataByPayload(String uuid, @Valid String namespace, @Valid String includeContent)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getArtifactDataByResponse(String uuid, @Valid String namespace, @Valid String includeContent)
default org.springframework.http.ResponseEntity<ArtifactPageInfo>	getArtifactsFromAllAus(@Valid String namespace, @Valid String url, @Valid String urlPrefix, @Valid String versions, @Valid Integer limit, @Valid String continuationToken)
ArtifactsApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<Artifact>	updateArtifact(@NotNull @Valid Boolean committed, String uuid, @Valid String namespace)

Method Details

getDelegate

ArtifactsApiDelegate getDelegate()

createArtifact

@RequestMapping(value="/artifacts",
                produces="application/json",
                consumes="multipart/form-data",
                method=POST)
default org.springframework.http.ResponseEntity<Artifact> createArtifact(@RequestPart(value="artifactProps",required=false)
 String artifactProps,
 @Valid @RequestPart(value="payload",required=false)
 @Valid org.springframework.web.multipart.MultipartFile payload,
 @RequestPart(value="httpResponseHeader",required=false)
 String httpResponseHeader)

deleteArtifact

@RequestMapping(value="/artifacts/{uuid}",
                produces="application/json",
                method=DELETE)
default org.springframework.http.ResponseEntity<Void> deleteArtifact(@PathVariable("uuid")
 String uuid,
 @Valid @RequestParam(value="namespace",required=false,defaultValue="lockss")
 @Valid String namespace)

getArtifactDataByMultipart

@RequestMapping(value="/artifacts/{uuid}",
                produces={"multipart/form-data","application/json"},
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getArtifactDataByMultipart(@PathVariable("uuid")
 String uuid,
 @Valid @RequestParam(value="namespace",required=false,defaultValue="lockss")
 @Valid String namespace,
 @Valid @RequestParam(value="includeContent",required=false,defaultValue="ALWAYS")
 @Valid String includeContent)

getArtifactDataByPayload

@RequestMapping(value="/artifacts/{uuid}/payload",
                produces={"application/octet-stream","application/json"},
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getArtifactDataByPayload(@PathVariable("uuid")
 String uuid,
 @Valid @RequestParam(value="namespace",required=false,defaultValue="lockss")
 @Valid String namespace,
 @Valid @RequestParam(value="includeContent",required=false,defaultValue="ALWAYS")
 @Valid String includeContent)

getArtifactDataByResponse

@RequestMapping(value="/artifacts/{uuid}/response",
                produces={"application/http;msgtype=response","application/json"},
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getArtifactDataByResponse(@PathVariable("uuid")
 String uuid,
 @Valid @RequestParam(value="namespace",required=false,defaultValue="lockss")
 @Valid String namespace,
 @Valid @RequestParam(value="includeContent",required=false,defaultValue="ALWAYS")
 @Valid String includeContent)

getArtifactsFromAllAus

@RequestMapping(value="/artifacts",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<ArtifactPageInfo> getArtifactsFromAllAus(@Valid @RequestParam(value="namespace",required=false,defaultValue="lockss")
 @Valid String namespace,
 @Valid @RequestParam(value="url",required=false)
 @Valid String url,
 @Valid @RequestParam(value="urlPrefix",required=false)
 @Valid String urlPrefix,
 @Valid @RequestParam(value="versions",required=false,defaultValue="all")
 @Valid String versions,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="continuationToken",required=false)
 @Valid String continuationToken)

updateArtifact

@RequestMapping(value="/artifacts/{uuid}",
                produces="application/json",
                method=PUT)
default org.springframework.http.ResponseEntity<Artifact> updateArtifact(@NotNull @Valid @RequestParam(value="committed",required=true)
 @NotNull @Valid Boolean committed,
 @PathVariable("uuid")
 String uuid,
 @Valid @RequestParam(value="namespace",required=false,defaultValue="lockss")
 @Valid String namespace)