Package org.lockss.laaws.rs.impl

Class ArtifactsApiServiceImpl

java.lang.Object

org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.laaws.rs.impl.ArtifactsApiServiceImpl

All Implemented Interfaces:

ArtifactsApiDelegate, LockssConfigurableService

@Service
public class ArtifactsApiServiceImpl
extends BaseSpringApiServiceImpl
implements ArtifactsApiDelegate, LockssConfigurableService

Nested Class Summary

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

BaseSpringApiServiceImpl.MapMessageListener

Field Summary

Fields

Modifier and Type	Field	Description
static final org.springframework.http.MediaType	APPLICATION_HTTP_RESPONSE
static final String	APPLICATION_HTTP_RESPONSE_VALUE
static final long	DEFAULT_ARTIFACT_ITERATOR_TIMEOUT
static final int	DEFAULT_DEFAULT_ARTIFACT_PAGESIZE
static final int	DEFAULT_MAX_ARTIFACT_PAGESIZE
static final long	DEFAULT_SMALL_CONTENT_THRESHOLD
static final String	PARAM_ARTIFACT_ITERATOR_TIMEOUT	Interval after which unused Artifact iterator continuations will be discarded.
static final String	PARAM_DEFAULT_ARTIFACT_PAGESIZE	Default number of Artifacts that will be returned in a single (paged) response
static final String	PARAM_MAX_ARTIFACT_PAGESIZE	Max number of Artifacts that will be returned in a single (paged) response
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
static final 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	Description
ArtifactsApiServiceImpl(jakarta.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<org.lockss.util.rest.repo.model.Artifact>	createArtifact(String properties, org.springframework.web.multipart.MultipartFile payload, String httpResponseHeader)	POST /artifacts: Adds artifacts to the repository
org.springframework.http.ResponseEntity<Void>	deleteArtifact(String artifactid, String namespace)	DELETE /artifacts/{artifactid}: Deletes an artifact from this repository.
org.springframework.http.ResponseEntity	getArtifactDataByMultipart(String artifactid, String namespace, String includeContent)	GET /artifacts/{artifactid}: Retrieves an artifact from the repository.
org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getArtifactDataByPayload(String artifactId, String namespace, String includeContentParam)	GET /artifacts/{artifactid}/payload: Retrieves an artifact from the repository.
org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getArtifactDataByResponse(String artifactId, String namespace, String includeContentParam)	GET /artifacts/{artifactid}/response: Retrieves an artifact from the repository.
org.springframework.http.ResponseEntity<org.lockss.util.rest.repo.model.ArtifactPageInfo>	getArtifactsFromAllAus(String namespace, String url, String urlPrefix, String versions, Integer limit, String continuationToken)	GET /artifacts: Returns the committed artifacts of all versions of a given URL, from a specified namespace.
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	sendCacheInvalidateArtifact(org.lockss.util.rest.repo.util.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(Boolean committed, String artifactid, String namespace)	PUT /artifacts/{artifactid}: Updates an artifact's properties

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

configMgrCreated, getClassName, getConfigWaitTime, getJMSManager, getPluginManager, getReadyWaitTime, getRunningLockssDaemon, getStateManager, getWaitTime, jsonResponse, receiveMessage, registerConfigCallback, setUpJms, setUpJms, setUpJms, stopJms, stringResponse, 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.ArtifactsApiDelegate

getAcceptHeader, getObjectMapper, getRequest

Field Details

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

PREFIX

public static final String PREFIX

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

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_ARTIFACT_ITERATOR_TIMEOUT

public static final String PARAM_ARTIFACT_ITERATOR_TIMEOUT

Interval after which unused Artifact iterator continuations will be discarded. Change requires restart to take effect.

See Also:

• Constant Field Values

DEFAULT_ARTIFACT_ITERATOR_TIMEOUT

public static final long DEFAULT_ARTIFACT_ITERATOR_TIMEOUT

See Also:

• Constant Field Values

Constructor Details

ArtifactsApiServiceImpl

@Autowired
public ArtifactsApiServiceImpl(jakarta.servlet.http.HttpServletRequest request)

Method Details

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 LockssConfigurableService

createArtifact

public org.springframework.http.ResponseEntity<org.lockss.util.rest.repo.model.Artifact> createArtifact(String properties,
 org.springframework.web.multipart.MultipartFile payload,
 String httpResponseHeader)

POST /artifacts: Adds artifacts to the repository

Specified by:

createArtifact in interface ArtifactsApiDelegate

Parameters:

properties -

payload -

httpResponseHeader -

Returns:

a ResponseEntity<Artifact>.

See Also:

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

deleteArtifact

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

DELETE /artifacts/{artifactid}: Deletes an artifact from this repository.

Specified by:

deleteArtifact in interface ArtifactsApiDelegate

Parameters:

artifactid - A String with the Identifier of the artifact.

namespace - A String with the namespace of the artifact.

Returns:

a ResponseEntity<Void>.

See Also:

• ArtifactsApi.deleteArtifact(java.lang.String, java.lang.String)

getArtifactDataByMultipart

public org.springframework.http.ResponseEntity getArtifactDataByMultipart(String artifactid,
 String namespace,
 String includeContent)

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

Specified by:

getArtifactDataByMultipart in interface ArtifactsApiDelegate

Parameters:

artifactid - A String with the Identifier of the artifact.

namespace - A String with the namespace of the artifact.

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

Returns:

a ResponseEntity containing a MultipartResponse.

See Also:

• ArtifactsApi.getArtifactDataByMultipart(java.lang.String, java.lang.String, java.lang.String)

getArtifactDataByPayload

public org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getArtifactDataByPayload(String artifactId,
 String namespace,
 String includeContentParam)

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

Specified by:

getArtifactDataByPayload in interface ArtifactsApiDelegate

Parameters:

artifactId - A String with the Identifier of the artifact.

namespace - A String with the namespace of the artifact.

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

Returns:

a ResponseEntity containing a MultipartResponse.

See Also:

• ArtifactsApi.getArtifactDataByPayload(java.lang.String, java.lang.String, java.lang.String)

getArtifactDataByResponse

public org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getArtifactDataByResponse(String artifactId,
 String namespace,
 String includeContentParam)

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

Specified by:

getArtifactDataByResponse in interface ArtifactsApiDelegate

Parameters:

artifactId - A String with the Identifier of the artifact.

namespace - A String with the namespace of the artifact.

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

Returns:

a ResponseEntity containing a MultipartResponse.

See Also:

• ArtifactsApi.getArtifactDataByResponse(java.lang.String, java.lang.String, java.lang.String)

getArtifactsFromAllAus

public org.springframework.http.ResponseEntity<org.lockss.util.rest.repo.model.ArtifactPageInfo> getArtifactsFromAllAus(String namespace,
 String url,
 String urlPrefix,
 String versions,
 Integer limit,
 String continuationToken)

GET /artifacts: Returns the committed artifacts of all versions of a given URL, from a specified namespace.

Specified by:

getArtifactsFromAllAus in interface ArtifactsApiDelegate

Parameters:

namespace - A String with the namespace of the artifact.

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

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

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:

• ArtifactsApi.getArtifactsFromAllAus(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.Integer, java.lang.String)

updateArtifact

public org.springframework.http.ResponseEntity updateArtifact(Boolean committed,
 String artifactid,
 String namespace)

PUT /artifacts/{artifactid}: Updates an artifact's properties

Currently limited to updating an artifact's committed status.

Specified by:

updateArtifact in interface ArtifactsApiDelegate

Parameters:

artifactid - A String with the Identifier of the artifact.

committed - A Boolean with the artifact committed status.

namespace - A String with the namespace of the artifact.

Returns:

a ResponseEntity<Artifact>.

See Also:

• ArtifactsApi.updateArtifact(java.lang.Boolean, java.lang.String, java.lang.String)

sendCacheInvalidateArtifact

protected void sendCacheInvalidateArtifact(org.lockss.util.rest.repo.util.ArtifactCache.InvalidateOp op,
 String key)

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 BaseSpringApiServiceImpl

sendCacheFlush

protected void sendCacheFlush()

sendPingResponse

protected void sendPingResponse(String key)