org.lockss.laaws.rs.controller

Class ReposApiController

java.lang.Object

org.lockss.laaws.rs.controller.ReposApiController

All Implemented Interfaces:

ReposApi

@Controller
public class ReposApiController
extends Object
implements ReposApi

Spring controller for the REST presentation of the LOCKSS Repository service.

Field Summary

Fields

Modifier and Type	Field and Description
static org.springframework.http.MediaType	APPLICATION_HTTP_RESPONSE
static String	APPLICATION_HTTP_RESPONSE_VALUE

Constructor Summary

Constructors

Constructor and Description
ReposApiController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<Void>	reposArtifactsArtifactidDelete(String repository, String artifactid) DELETE /repos/{collection}/artifacts/{artifactId}: Deletes an artifact from a collection managed by this repository.
org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody>	reposArtifactsArtifactidGet(String repository, String artifactId) GET /repos/{collection}/artifacts/{artifactId}: Retrieves an artifact from the repository.
org.springframework.http.ResponseEntity<String>	reposArtifactsArtifactidPut(String repository, String artifactId, Boolean committed) Implementation of PUT on /repos/{repository}/artifacts/{artifactId}: Updates an artifact's properties Currently limited to updating an artifact's committed status.
org.springframework.http.ResponseEntity<List<String>>	reposArtifactsGet(String repository, String artifact, String auid, String uri, String aspect, Integer timestamp, Integer acquired, String hash, Boolean committed, Boolean includeAllAspects, Boolean includeAllVersions, Integer limit, String nextArtifact) Implementation of GET on /repos/{repository}/artifacts: Queries the repository for artifacts
org.springframework.http.ResponseEntity<org.lockss.laaws.rs.model.Artifact>	reposArtifactsPost(String repository, String auid, String uri, Integer version, org.springframework.web.multipart.MultipartFile artifactPart, org.springframework.web.multipart.MultipartFile... aspectParts) Implementation of POST on /repos/{repository}/artifacts: Adds artifacts to the repository
org.springframework.http.ResponseEntity<List<String>>	reposGet() GET /repos: Returns a list of collection names managed by this repository.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPLICATION_HTTP_RESPONSE_VALUE

public static final String APPLICATION_HTTP_RESPONSE_VALUE

See Also:

Constant Field Values

APPLICATION_HTTP_RESPONSE

public static final org.springframework.http.MediaType APPLICATION_HTTP_RESPONSE

Constructor Detail

ReposApiController

public ReposApiController()

Method Detail

reposGet

public org.springframework.http.ResponseEntity<List<String>> reposGet()

GET /repos: Returns a list of collection names managed by this repository.

Specified by:

reposGet in interface ReposApi

Returns:

List of collection names.

reposArtifactsArtifactidDelete

public org.springframework.http.ResponseEntity<Void> reposArtifactsArtifactidDelete(@PathVariable(value="repository")
                                                                                    String repository,
                                                                                    @PathVariable(value="artifactid")
                                                                                    String artifactid)

DELETE /repos/{collection}/artifacts/{artifactId}: Deletes an artifact from a collection managed by this repository.

Specified by:

reposArtifactsArtifactidDelete in interface ReposApi

Parameters:

repository -

artifactid -

Returns:

reposArtifactsArtifactidGet

public org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody> reposArtifactsArtifactidGet(@PathVariable(value="repository")
                                                                                                                                                        String repository,
                                                                                                                                                        @PathVariable(value="artifactid")
                                                                                                                                                        String artifactId)

GET /repos/{collection}/artifacts/{artifactId}: Retrieves an artifact from the repository.

Specified by:

reposArtifactsArtifactidGet in interface ReposApi

Parameters:

repository -

artifactId -

Returns:

reposArtifactsArtifactidPut

public org.springframework.http.ResponseEntity<String> reposArtifactsArtifactidPut(@PathVariable(value="repository")
                                                                                   String repository,
                                                                                   @PathVariable(value="artifactid")
                                                                                   String artifactId,
                                                                                   @RequestPart(value="committed",required=false)
                                                                                   Boolean committed)

Implementation of PUT on /repos/{repository}/artifacts/{artifactId}: Updates an artifact's properties Currently limited to updating an artifact's committed status.

Specified by:

reposArtifactsArtifactidPut in interface ReposApi

Parameters:

repository -

artifactId -

committed -

Returns:

reposArtifactsGet

public org.springframework.http.ResponseEntity<List<String>> reposArtifactsGet(@PathVariable(value="repository")
                                                                               String repository,
                                                                               @RequestParam(value="artifact",required=false)
                                                                               String artifact,
                                                                               @RequestParam(value="auid",required=false)
                                                                               String auid,
                                                                               @RequestParam(value="uri",required=false)
                                                                               String uri,
                                                                               @RequestParam(value="aspect",required=false)
                                                                               String aspect,
                                                                               @RequestParam(value="timestamp",required=false)
                                                                               Integer timestamp,
                                                                               @RequestParam(value="acquired",required=false)
                                                                               Integer acquired,
                                                                               @RequestParam(value="hash",required=false)
                                                                               String hash,
                                                                               @RequestParam(value="committed",required=false,defaultValue="true")
                                                                               Boolean committed,
                                                                               @RequestParam(value="includeAllAspects",required=false,defaultValue="false")
                                                                               Boolean includeAllAspects,
                                                                               @RequestParam(value="includeAllVersions",required=false,defaultValue="false")
                                                                               Boolean includeAllVersions,
                                                                               @RequestParam(value="limit",required=false,defaultValue="1000")
                                                                               Integer limit,
                                                                               @RequestParam(value="next_artifact",required=false)
                                                                               String nextArtifact)

Implementation of GET on /repos/{repository}/artifacts: Queries the repository for artifacts

Specified by:

reposArtifactsGet in interface ReposApi

Parameters:

repository -

artifact -

auid -

uri -

aspect -

timestamp -

acquired -

hash -

committed -

includeAllAspects -

includeAllVersions -

limit -

nextArtifact -

Returns:

reposArtifactsPost

public org.springframework.http.ResponseEntity<org.lockss.laaws.rs.model.Artifact> reposArtifactsPost(@PathVariable(value="repository")
                                                                                                      String repository,
                                                                                                      @RequestPart(value="auid",required=true)
                                                                                                      String auid,
                                                                                                      @RequestPart(value="uri",required=true)
                                                                                                      String uri,
                                                                                                      @RequestPart(value="version",required=true)
                                                                                                      Integer version,
                                                                                                      @RequestPart(value="artifact",required=true)
                                                                                                      org.springframework.web.multipart.MultipartFile artifactPart,
                                                                                                      @RequestPart(value="aspects")
                                                                                                      org.springframework.web.multipart.MultipartFile... aspectParts)

Implementation of POST on /repos/{repository}/artifacts: Adds artifacts to the repository

Specified by:

reposArtifactsPost in interface ReposApi

Parameters:

repository -

auid -

uri -

Returns: