org.lockss.laaws.rs.impl

Class CollectionsApiServiceImpl

java.lang.Object

org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.laaws.rs.impl.CollectionsApiServiceImpl

All Implemented Interfaces:

CollectionsApiDelegate, org.lockss.spring.base.LockssConfigurableService

@Service
public class CollectionsApiServiceImpl
extends org.lockss.spring.base.BaseSpringApiServiceImpl
implements CollectionsApiDelegate, org.lockss.spring.base.LockssConfigurableService

Service for accessing the repository artifacts.

Nested Class Summary

Nested classes/interfaces inherited from class org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.spring.base.BaseSpringApiServiceImpl.MapMessageListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DEFAULT_ARTIFACT_PAGESIZE
static int	DEFAULT_DEFAULT_AUID_PAGESIZE
static int	DEFAULT_MAX_ARTIFACT_PAGESIZE
static int	DEFAULT_MAX_AUID_PAGESIZE
static long	DEFAULT_SMALL_CONTENT_THRESHOLD
static String	PARAM_DEFAULT_ARTIFACT_PAGESIZE Default number of Artifacts that will be returned in a single (paged) response
static String	PARAM_DEFAULT_AUID_PAGESIZE Default number of AUIDs that will be returned in a single (paged) response
static String	PARAM_MAX_ARTIFACT_PAGESIZE Max number of Artifacts that will be returned in a single (paged) response
static String	PARAM_MAX_AUID_PAGESIZE Max number of AUIDs that will be returned in a single (paged) response
static String	PARAM_SMALL_CONTENT_THRESHOLD Largest Artifact content that will be included in a response to a getArtifactData call with includeContent == IF_SMALL
static String	PREFIX

Fields inherited from class org.lockss.spring.base.BaseSpringApiServiceImpl

DEFAULT_CONFIG_WAIT_TIME, DEFAULT_READY_WAIT_TIME, JMS_BOTH, JMS_RECEIVE, JMS_SEND, jmsConsumer, jmsProducer, PARAM_CONFIG_WAIT_TIME, PARAM_READY_WAIT_TIME

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, Long collectionDate) 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.
static org.springframework.util.MultiValueMap<String,Object>	generateMultipartResponseFromArtifactData(ArtifactData artifactData, LockssRepository.IncludeContent includeContent, long smallContentThreshold)
org.springframework.http.ResponseEntity	getArtifact(String collectionid, String artifactid, String includeContent) GET /collections/{collectionid}/artifacts/{artifactid}: Retrieves an artifact from the repository.
org.springframework.http.ResponseEntity<ArtifactPageInfo>	getArtifacts(String collectionid, String auid, String url, String urlPrefix, String version, Boolean includeUncommitted, Integer limit, String continuationToken) GET /collections/{collectionid}/aus/{auid}/artifacts: Get a list with all the artifacts in a collection and Archival Unit or a pageful of the list defined by the continuation token and size.
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<AuidPageInfo>	getAus(String collectionid, Integer limit, String continuationToken) GET /collections/{collectionid}/aus: Get all Archival Unit IDs (AUIDs) in a collection or a pageful of the list defined by the continuation token and size.
org.springframework.http.ResponseEntity<List<String>>	getCollections() GET /collections: Returns a list of collection names managed by this repository.
Optional<com.fasterxml.jackson.databind.ObjectMapper>	getObjectMapper()
Optional<javax.servlet.http.HttpServletRequest>	getRequest()
protected void	jmsSetUpDone() When JMS connection is established, tell clients to flush their artifact cache to ensure that no stale cached artifacts.
protected void	sendCacheFlush()
protected void	sendCacheInvalidate(ArtifactCache.InvalidateOp op, String key)
protected void	sendPingResponse(String key)
void	setConfig(org.lockss.config.Configuration newConfig, org.lockss.config.Configuration prevConfig, org.lockss.config.Configuration.Differences changedKeys)
org.springframework.http.ResponseEntity	updateArtifact(String collectionid, String artifactid, Boolean committed) PUT /collections/{collectionid}/artifacts/{artifactid}: Updates an artifact's properties

Methods inherited from class org.lockss.spring.base.BaseSpringApiServiceImpl

configMgrCreated, getClassName, getConfigWaitTime, getJMSManager, getReadyWaitTime, getRunningLockssDaemon, getWaitTime, receiveMessage, registerConfigCallback, setUpJms, setUpJms, setUpJms, stopJms, waitConfig, waitConfig, waitReady, waitReady

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

PARAM_DEFAULT_ARTIFACT_PAGESIZE

public static final String PARAM_DEFAULT_ARTIFACT_PAGESIZE

Default number of Artifacts that will be returned in a single (paged) response

See Also:

Constant Field Values

DEFAULT_DEFAULT_ARTIFACT_PAGESIZE

public static final int DEFAULT_DEFAULT_ARTIFACT_PAGESIZE

See Also:

Constant Field Values

PARAM_MAX_ARTIFACT_PAGESIZE

public static final String PARAM_MAX_ARTIFACT_PAGESIZE

Max number of Artifacts that will be returned in a single (paged) response

See Also:

Constant Field Values

DEFAULT_MAX_ARTIFACT_PAGESIZE

public static final int DEFAULT_MAX_ARTIFACT_PAGESIZE

See Also:

Constant Field Values

PARAM_DEFAULT_AUID_PAGESIZE

public static final String PARAM_DEFAULT_AUID_PAGESIZE

Default number of AUIDs that will be returned in a single (paged) response

See Also:

Constant Field Values

DEFAULT_DEFAULT_AUID_PAGESIZE

public static final int DEFAULT_DEFAULT_AUID_PAGESIZE

See Also:

Constant Field Values

PARAM_MAX_AUID_PAGESIZE

public static final String PARAM_MAX_AUID_PAGESIZE

Max number of AUIDs that will be returned in a single (paged) response

See Also:

Constant Field Values

DEFAULT_MAX_AUID_PAGESIZE

public static final int DEFAULT_MAX_AUID_PAGESIZE

See Also:

Constant Field Values

PARAM_SMALL_CONTENT_THRESHOLD

public static final String PARAM_SMALL_CONTENT_THRESHOLD

Largest Artifact content that will be included in a response to a getArtifactData call with includeContent == IF_SMALL

See Also:

Constant Field Values

DEFAULT_SMALL_CONTENT_THRESHOLD

public static final long DEFAULT_SMALL_CONTENT_THRESHOLD

See Also:

Constant Field Values

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

setConfig

public void setConfig(org.lockss.config.Configuration newConfig,
                      org.lockss.config.Configuration prevConfig,
                      org.lockss.config.Configuration.Differences changedKeys)

Specified by:

setConfig in interface org.lockss.spring.base.LockssConfigurableService

jmsSetUpDone

protected void jmsSetUpDone()

When JMS connection is established, tell clients to flush their artifact cache to ensure that no stale cached artifacts. (Normally shouldn't matter, as artifact IDs are stable, even after an index rebuild, but it's conceivable that the repository service that's starting isn't the same one that was previously running at the same address.)

Overrides:

jmsSetUpDone in class org.lockss.spring.base.BaseSpringApiServiceImpl

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 getArtifact(String collectionid,
                                                           String artifactid,
                                                           String includeContent)

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.

includeContent - A Boolean indicating whether the artifact content part should be included in the multipart response.

Returns:

a ResponseEntity containing a org.lockss.util.rest.multipart.MultipartResponse.

See Also:

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

generateMultipartResponseFromArtifactData

public static org.springframework.util.MultiValueMap<String,Object> generateMultipartResponseFromArtifactData(ArtifactData artifactData,
                                                                                                              LockssRepository.IncludeContent includeContent,
                                                                                                              long smallContentThreshold)
                                                                                                       throws IOException

Throws:

IOException

updateArtifact

public org.springframework.http.ResponseEntity 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,
                                                                        Long collectionDate)

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.

Returns:

a ResponseEntity<Artifact>.

See Also:

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

getArtifacts

public org.springframework.http.ResponseEntity<ArtifactPageInfo> getArtifacts(String collectionid,
                                                                              String auid,
                                                                              String url,
                                                                              String urlPrefix,
                                                                              String version,
                                                                              Boolean includeUncommitted,
                                                                              Integer limit,
                                                                              String continuationToken)

GET /collections/{collectionid}/aus/{auid}/artifacts: Get a list with all the artifacts in a collection and Archival Unit or a pageful of the list defined by the continuation token and size.

Specified by:

getArtifacts 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.

includeUncommitted - A boolean with the indication of whether uncommitted artifacts should be returned.

limit - An Integer with the maximum number of artifacts to be returned.

continuationToken - A String with the continuation token of the next page of artifacts to be returned.

Returns:

a ResponseEntity<ArtifactPageInfo> with the requested artifacts.

See Also:

CollectionsApi.getArtifacts(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Integer, 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<AuidPageInfo> getAus(String collectionid,
                                                                    Integer limit,
                                                                    String continuationToken)

GET /collections/{collectionid}/aus: Get all Archival Unit IDs (AUIDs) in a collection or a pageful of the list defined by the continuation token and size.

Specified by:

getAus in interface CollectionsApiDelegate

Parameters:

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

limit - An Integer with the maximum number of archival unit identifiers to be returned.

continuationToken - A String with the continuation token of the next page of archival unit identifiers to be returned.

Returns:

a ResponseEntity<AuidPageInfo>.

See Also:

CollectionsApi.getAus(java.lang.String, java.lang.Integer, 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

sendCacheInvalidate

protected void sendCacheInvalidate(ArtifactCache.InvalidateOp op,
                                   String key)

sendCacheFlush

protected void sendCacheFlush()

sendPingResponse

protected void sendPingResponse(String key)