org.lockss.laaws.rs.api

Interface ArtifactsApi

All Known Implementing Classes:

ArtifactsApiController

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

Method Summary

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

Method Detail

getDelegate

ArtifactsApiDelegate getDelegate()

createArtifact

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

deleteArtifact

@RequestMapping(value="/artifacts/{uuid}",
                produces="application/json",
                consumes="application/json",
                method=DELETE)
default org.springframework.http.ResponseEntity<Void> deleteArtifact(@PathVariable(value="uuid")
                                                                                                                                                                                                                                         String uuid,
                                                                                                                                                                                                                                         @RequestParam(value="namespace",required=false,defaultValue="lockss")
                                                                                                                                                                                                                                         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(value="uuid")
                                                                                                                                                                                                                                                             String uuid,
                                                                                                                                                                                                                                                             @RequestParam(value="namespace",required=false,defaultValue="lockss")
                                                                                                                                                                                                                                                             String namespace,
                                                                                                                                                                                                                                                             @RequestParam(value="includeContent",required=false,defaultValue="ALWAYS")
                                                                                                                                                                                                                                                             String includeContent)

getArtifactDataByPayload

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

getArtifactDataByResponse

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

getArtifactsFromAllAus

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

updateArtifact

@RequestMapping(value="/artifacts/{uuid}",
                produces="application/json",
                consumes="multipart/form-data",
                method=PUT)
default org.springframework.http.ResponseEntity<org.lockss.util.rest.repo.model.Artifact> updateArtifact(@PathVariable(value="uuid")
                                                                                                                                                                                                                                                                             String uuid,
                                                                                                                                                                                                                                                                             @RequestParam(value="committed",required=true)
                                                                                                                                                                                                                                                                             Boolean committed,
                                                                                                                                                                                                                                                                             @RequestParam(value="namespace",required=false,defaultValue="lockss")
                                                                                                                                                                                                                                                                             String namespace)