org.lockss.laaws.rs.impl

Class CollectionsApiServiceImpl

java.lang.Object

org.lockss.spring.status.SpringLockssBaseApiController

org.lockss.laaws.rs.impl.CollectionsApiServiceImpl

All Implemented Interfaces:

CollectionsApiDelegate, SpringLockssBaseApi

@Service
public class CollectionsApiServiceImpl
extends SpringLockssBaseApiController
implements CollectionsApiDelegate

Service for accessing the repository artifacts.

Constructor Summary

Constructors

Constructor and Description
CollectionsApiServiceImpl(com.fasterxml.jackson.databind.ObjectMapper objectMapper, javax.servlet.http.HttpServletRequest request) Constructor for autowiring.

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<Artifact>	createArtifact(String collectionid, String auid, String uri, org.springframework.web.multipart.MultipartFile content, org.springframework.web.multipart.MultipartFile aspectParts) POST /collections/{collectionid}/artifacts: Adds artifacts to the repository
org.springframework.http.ResponseEntity<Void>	deleteArtifact(String collectionid, String artifactid) DELETE /collections/{collectionid}/artifacts/{artifactid}: Deletes an artifact from a collection managed by this repository.
ApiStatus	getApiStatus() Provides the status object.
org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody>	getArtifact(String collectionid, String artifactid, String accept) GET /collections/{collectionid}/artifacts/{artifactid}: Retrieves an artifact from the repository.
org.springframework.http.ResponseEntity<Long>	getArtifactsSize(String collectionid, String auid, String url, String urlPrefix, String version) GET /collections/{collectionid}/aus/{auid}/size: Get the size of Archival Unit artifacts in a collection.
org.springframework.http.ResponseEntity<List<String>>	getAus(String collectionid) GET /collections/{collectionid}/aus: Get Archival Unit IDs (AUIDs) in a collection.
org.springframework.http.ResponseEntity<List<String>>	getCollections() GET /collections: Returns a list of collection names managed by this repository.
org.springframework.http.ResponseEntity<List<Artifact>>	getCommittedArtifacts(String collectionid, String auid, String url, String urlPrefix, String version) GET /collections/{collectionid}/aus/{auid}/artifacts: Get committed artifacts in a collection and Archival Unit.
Optional<com.fasterxml.jackson.databind.ObjectMapper>	getObjectMapper()
Optional<javax.servlet.http.HttpServletRequest>	getRequest()
org.springframework.http.ResponseEntity<Artifact>	updateArtifact(String collectionid, String artifactid, Boolean committed) PUT /collections/{collectionid}/artifacts/{artifactid}: Updates an artifact's properties Currently limited to updating an artifact's committed status.

Methods inherited from class org.lockss.spring.status.SpringLockssBaseApiController

getStatus

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lockss.laaws.rs.api.CollectionsApiDelegate

getAcceptHeader, getStatus

Constructor Detail

CollectionsApiServiceImpl

@Autowired
public CollectionsApiServiceImpl(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                            javax.servlet.http.HttpServletRequest request)

Constructor for autowiring.

Parameters:

objectMapper - An ObjectMapper for JSON processing.

request - An HttpServletRequest with the HTTP request.

Method Detail

getCollections

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

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

Specified by:

getCollections in interface CollectionsApiDelegate

Returns:

a List with the collection names.

See Also:

CollectionsApi.getCollections()

deleteArtifact

public org.springframework.http.ResponseEntity<Void> deleteArtifact(String collectionid,
                                                                    String artifactid)

DELETE /collections/{collectionid}/artifacts/{artifactid}: Deletes an artifact from a collection managed by this repository.

Specified by:

deleteArtifact in interface CollectionsApiDelegate

Parameters:

collectionid - A String with the name of the collection containing the artifact.

artifactid - A String with the Identifier of the artifact.

Returns:

a ResponseEntity<Void>.

See Also:

CollectionsApi.deleteArtifact(java.lang.String, java.lang.String)

getArtifact

public org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody> getArtifact(String collectionid,
                                                                                                                                        String artifactid,
                                                                                                                                        String accept)

GET /collections/{collectionid}/artifacts/{artifactid}: Retrieves an artifact from the repository.

Specified by:

getArtifact in interface CollectionsApiDelegate

Parameters:

collectionid - A String with the name of the collection containing the artifact.

artifactid - A String with the Identifier of the artifact.

Returns:

a ResponseEntity<StreamingResponseBody>.

See Also:

CollectionsApi.getArtifact(java.lang.String, java.lang.String, java.lang.String)

updateArtifact

public org.springframework.http.ResponseEntity<Artifact> updateArtifact(String collectionid,
                                                                        String artifactid,
                                                                        Boolean committed)

PUT /collections/{collectionid}/artifacts/{artifactid}: Updates an artifact's properties Currently limited to updating an artifact's committed status.

Specified by:

updateArtifact in interface CollectionsApiDelegate

Parameters:

collectionid - A String with the name of the collection containing the artifact.

artifactid - A String with the Identifier of the artifact.

committed - A Boolean with the artifact committed status.

Returns:

a ResponseEntity<Artifact>.

See Also:

CollectionsApi.updateArtifact(java.lang.String, java.lang.String, java.lang.Boolean)

createArtifact

public org.springframework.http.ResponseEntity<Artifact> createArtifact(String collectionid,
                                                                        String auid,
                                                                        String uri,
                                                                        org.springframework.web.multipart.MultipartFile content,
                                                                        org.springframework.web.multipart.MultipartFile aspectParts)

POST /collections/{collectionid}/artifacts: Adds artifacts to the repository

Specified by:

createArtifact in interface CollectionsApiDelegate

Parameters:

collectionid - A String with the name of the collection containing the artifact.

auid - A String with the Archival Unit ID (AUID) of new artifact.

uri - A String with the URI represented by this artifact.

content - A MultipartFile with the artifact content.

aspectParts - A MultipartFile... with the artifact aspects.

Returns:

a ResponseEntity<Artifact>.

See Also:

CollectionsApi.createArtifact(java.lang.String, java.lang.String, java.lang.String, org.springframework.web.multipart.MultipartFile, org.springframework.web.multipart.MultipartFile)

getCommittedArtifacts

public org.springframework.http.ResponseEntity<List<Artifact>> getCommittedArtifacts(String collectionid,
                                                                                     String auid,
                                                                                     String url,
                                                                                     String urlPrefix,
                                                                                     String version)

GET /collections/{collectionid}/aus/{auid}/artifacts: Get committed artifacts in a collection and Archival Unit.

Specified by:

getCommittedArtifacts in interface CollectionsApiDelegate

Parameters:

collectionid - A String with the name of the collection containing the artifact.

auid - A String with the Archival Unit ID (AUID) of artifact.

url - A String with the URL contained by the artifacts.

urlPrefix - A String with the prefix to be matched by the artifact URLs.

version - An Integer with the version of the URL contained by the artifacts.

Returns:

a ResponseEntity<List<Artifact>>.

See Also:

CollectionsApi.getCommittedArtifacts(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getArtifactsSize

public org.springframework.http.ResponseEntity<Long> getArtifactsSize(String collectionid,
                                                                      String auid,
                                                                      String url,
                                                                      String urlPrefix,
                                                                      String version)

GET /collections/{collectionid}/aus/{auid}/size: Get the size of Archival Unit artifacts in a collection.

Specified by:

getArtifactsSize in interface CollectionsApiDelegate

Parameters:

collectionid - A String with the name of the collection containing the Archival Unit.

auid - A String with the Archival Unit ID (AUID).

url - A String with the URL contained by the artifacts.

urlPrefix - A String with the prefix to be matched by the artifact URLs.

version - An Integer with the version of the URL contained by the artifacts.

Returns:

a LongResponseEntity<Long>.

See Also:

CollectionsApi.getArtifactsSize(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getAus

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

GET /collections/{collectionid}/aus: Get Archival Unit IDs (AUIDs) in a collection.

Specified by:

getAus in interface CollectionsApiDelegate

Parameters:

collectionid - A String with the name of the collection containing the archival units.

Returns:

a ResponseEntity<List<String>>.

See Also:

CollectionsApi.getAus(java.lang.String)

getObjectMapper

public Optional<com.fasterxml.jackson.databind.ObjectMapper> getObjectMapper()

Specified by:

getObjectMapper in interface CollectionsApiDelegate

getRequest

public Optional<javax.servlet.http.HttpServletRequest> getRequest()

Specified by:

getRequest in interface CollectionsApiDelegate

getApiStatus

public ApiStatus getApiStatus()

Provides the status object.

Specified by:

getApiStatus in interface SpringLockssBaseApi

Specified by:

getApiStatus in class SpringLockssBaseApiController

Returns:

an ApiStatus with the status.