org.lockss.laaws.rs.api

Interface CollectionsApi

All Superinterfaces:

SpringLockssBaseApi

All Known Implementing Classes:

CollectionsApiController

public interface CollectionsApi
extends SpringLockssBaseApi

Method Summary

Modifier and Type	Method and Description
default org.springframework.http.ResponseEntity<Artifact>	createArtifact(String collectionid, String auid, String uri, org.springframework.web.multipart.MultipartFile content, org.springframework.web.multipart.MultipartFile aspectParts)
default org.springframework.http.ResponseEntity<Void>	deleteArtifact(String collectionid, String artifactid)
default org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody>	getArtifact(String collectionid, String artifactid, String accept)
default org.springframework.http.ResponseEntity<Long>	getArtifactsSize(String collectionid, String auid, String url, String urlPrefix, String version)
default org.springframework.http.ResponseEntity<List<String>>	getAus(String collectionid)
default org.springframework.http.ResponseEntity<List<String>>	getCollections()
default org.springframework.http.ResponseEntity<List<Artifact>>	getCommittedArtifacts(String collectionid, String auid, String url, String urlPrefix, String version)
CollectionsApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<ApiStatus>	getStatus()
default org.springframework.http.ResponseEntity<Artifact>	updateArtifact(String collectionid, String artifactid, Boolean committed)

Methods inherited from interface org.lockss.spring.status.SpringLockssBaseApi

getApiStatus

Method Detail

getDelegate

CollectionsApiDelegate getDelegate()

createArtifact

@RequestMapping(value="/collections/{collectionid}/artifacts",
                produces="application/json",
                consumes="multipart/form-data",
                method=POST)
default org.springframework.http.ResponseEntity<Artifact> createArtifact(@PathVariable(value="collectionid")
                                                                                                                                                                                                                                                                  String collectionid,
                                                                                                                                                                                                                                                                  @RequestParam(value="auid",required=true)
                                                                                                                                                                                                                                                                  String auid,
                                                                                                                                                                                                                                                                  @RequestParam(value="uri",required=true)
                                                                                                                                                                                                                                                                  String uri,
                                                                                                                                                                                                                                                                  @RequestPart(value="file")
                                                                                                                                                                                                                                                                  org.springframework.web.multipart.MultipartFile content,
                                                                                                                                                                                                                                                                  @RequestPart(value="file")
                                                                                                                                                                                                                                                                  org.springframework.web.multipart.MultipartFile aspectParts)

deleteArtifact

@RequestMapping(value="/collections/{collectionid}/artifacts/{artifactid}",
                produces="application/json",
                consumes="application/json",
                method=DELETE)
default org.springframework.http.ResponseEntity<Void> deleteArtifact(@PathVariable(value="collectionid")
                                                                                                                                                                                                                                                                          String collectionid,
                                                                                                                                                                                                                                                                          @PathVariable(value="artifactid")
                                                                                                                                                                                                                                                                          String artifactid)

getArtifact

@RequestMapping(value="/collections/{collectionid}/artifacts/{artifactid}",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody> getArtifact(@PathVariable(value="collectionid")
                                                                                                                                                                                                                                                                                              String collectionid,
                                                                                                                                                                                                                                                                                              @PathVariable(value="artifactid")
                                                                                                                                                                                                                                                                                              String artifactid,
                                                                                                                                                                                                                                                                                              @RequestHeader(value="Accept",required=false)
                                                                                                                                                                                                                                                                                              String accept)

getArtifactsSize

@RequestMapping(value="/collections/{collectionid}/aus/{auid}/size",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<Long> getArtifactsSize(@PathVariable(value="collectionid")
                                                                                                                                                                                                                     String collectionid,
                                                                                                                                                                                                                     @PathVariable(value="auid")
                                                                                                                                                                                                                     String auid,
                                                                                                                                                                                                                     @RequestParam(value="url",required=false)
                                                                                                                                                                                                                     String url,
                                                                                                                                                                                                                     @RequestParam(value="urlPrefix",required=false)
                                                                                                                                                                                                                     String urlPrefix,
                                                                                                                                                                                                                     @RequestParam(value="version",required=false)
                                                                                                                                                                                                                     String version)

getAus

@RequestMapping(value="/collections/{collectionid}/aus",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<List<String>> getAus(@PathVariable(value="collectionid")
                                                                                                                                                                                                       String collectionid)

getCollections

@RequestMapping(value="/collections",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<List<String>> getCollections()

getCommittedArtifacts

@RequestMapping(value="/collections/{collectionid}/aus/{auid}/artifacts",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<List<Artifact>> getCommittedArtifacts(@PathVariable(value="collectionid")
                                                                                                                                                                                                                                         String collectionid,
                                                                                                                                                                                                                                         @PathVariable(value="auid")
                                                                                                                                                                                                                                         String auid,
                                                                                                                                                                                                                                         @RequestParam(value="url",required=false)
                                                                                                                                                                                                                                         String url,
                                                                                                                                                                                                                                         @RequestParam(value="urlPrefix",required=false)
                                                                                                                                                                                                                                         String urlPrefix,
                                                                                                                                                                                                                                         @RequestParam(value="version",required=false)
                                                                                                                                                                                                                                         String version)

updateArtifact

@RequestMapping(value="/collections/{collectionid}/artifacts/{artifactid}",
                produces="application/json",
                consumes="multipart/form-data",
                method=PUT)
default org.springframework.http.ResponseEntity<Artifact> updateArtifact(@PathVariable(value="collectionid")
                                                                                                                                                                                                                                                                              String collectionid,
                                                                                                                                                                                                                                                                              @PathVariable(value="artifactid")
                                                                                                                                                                                                                                                                              String artifactid,
                                                                                                                                                                                                                                                                              @RequestParam(value="committed",required=false)
                                                                                                                                                                                                                                                                              Boolean committed)

getStatus

default org.springframework.http.ResponseEntity<ApiStatus> getStatus()

Specified by:

getStatus in interface SpringLockssBaseApi