Package org.lockss.laaws.rs.impl

Class AusApiServiceImpl

java.lang.Object

org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.laaws.rs.impl.AusApiServiceImpl

All Implemented Interfaces:

AusApiDelegate, LockssConfigurableService

@Service
public class AusApiServiceImpl
extends BaseSpringApiServiceImpl
implements AusApiDelegate, 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 long	DEFAULT_ARTIFACT_ITERATOR_TIMEOUT
static final long	DEFAULT_AUID_ITERATOR_TIMEOUT
static final int	DEFAULT_BULK_INDEX_BATCH_SIZE
static final boolean	DEFAULT_BULK_INDEX_ENABLED
static final int	DEFAULT_DEFAULT_ARTIFACT_PAGESIZE
static final int	DEFAULT_DEFAULT_AUID_PAGESIZE
static final int	DEFAULT_MAX_ARTIFACT_PAGESIZE
static final int	DEFAULT_MAX_AUID_PAGESIZE
static final String	PARAM_ARTIFACT_ITERATOR_TIMEOUT	Interval after which unused Artifact iterator continuations will be discarded.
static final String	PARAM_AUID_ITERATOR_TIMEOUT	Interval after which unused AUID iterator continuations will be discarded.
static final String	PARAM_BULK_INDEX_BATCH_SIZE	Batch size when adding Artifacts in bulk, when using a DispatchingArtifactIndex.
static final String	PARAM_BULK_INDEX_ENABLED	Set false to disable putting AUs into bulk mode
static final String	PARAM_DEFAULT_ARTIFACT_PAGESIZE	Default number of Artifacts that will be returned in a single (paged) response
static final String	PARAM_DEFAULT_AUID_PAGESIZE	Default number of AUIDs 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_MAX_AUID_PAGESIZE	Max number of AUIDs that will be returned in a single (paged) response
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
AusApiServiceImpl(jakarta.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<ArtifactPageInfo>	getArtifacts(String auid, String namespace, String url, String urlPrefix, String version, Boolean includeUncommitted, Integer limit, String continuationToken)	GET /aus/{auid}/artifacts: Get a list with all the artifacts in a namespace and Archival Unit or a pageful of the list defined by the continuation token and size.
org.springframework.http.ResponseEntity<AuSize>	getArtifactsSize(String auid, String namespace)	GET /aus/{auid}/size: Get the size of Archival Unit artifacts in a namespace.
org.springframework.http.ResponseEntity<AuidPageInfo>	getAus(String namespace, Integer limit, String continuationToken)	GET /aus: Get all Archival Unit IDs (AUIDs) in a namespace or a pageful of the list defined by the continuation token and size.
org.springframework.http.ResponseEntity<Void>	handleBulkAuOp(String auid, String op, String namespace)	Handles bulk transfer operations for an AUID in a namespace.
void	setConfig(org.lockss.config.Configuration newConfig, org.lockss.config.Configuration prevConfig, org.lockss.config.Configuration.Differences changedKeys)

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

configMgrCreated, getClassName, getConfigWaitTime, getJMSManager, getPluginManager, getReadyWaitTime, getRunningLockssDaemon, getStateManager, getWaitTime, jmsSetUpDone, 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.AusApiDelegate

getAcceptHeader, getObjectMapper, getRequest

Field Details

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_BULK_INDEX_BATCH_SIZE

public static final String PARAM_BULK_INDEX_BATCH_SIZE

Batch size when adding Artifacts in bulk, when using a DispatchingArtifactIndex.

See Also:

• Constant Field Values

DEFAULT_BULK_INDEX_BATCH_SIZE

public static final int DEFAULT_BULK_INDEX_BATCH_SIZE

See Also:

• Constant Field Values

PARAM_BULK_INDEX_ENABLED

public static final String PARAM_BULK_INDEX_ENABLED

Set false to disable putting AUs into bulk mode

See Also:

• Constant Field Values

DEFAULT_BULK_INDEX_ENABLED

public static final boolean DEFAULT_BULK_INDEX_ENABLED

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

PARAM_AUID_ITERATOR_TIMEOUT

public static final String PARAM_AUID_ITERATOR_TIMEOUT

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

See Also:

• Constant Field Values

DEFAULT_AUID_ITERATOR_TIMEOUT

public static final long DEFAULT_AUID_ITERATOR_TIMEOUT

See Also:

• Constant Field Values

Constructor Details

AusApiServiceImpl

@Autowired
public AusApiServiceImpl(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

getArtifacts

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

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

Specified by:

getArtifacts in interface AusApiDelegate

Parameters:

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

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.

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:

• AusApi.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<AuSize> getArtifactsSize(String auid,
 String namespace)

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

Specified by:

getArtifactsSize in interface AusApiDelegate

Parameters:

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

namespace - A String with the namespace of the Archival Unit.

Returns:

a org.springframework.http.ResponseEntity<AuSize>.

See Also:

• AusApi.getArtifactsSize(java.lang.String, java.lang.String)

getAus

public org.springframework.http.ResponseEntity<AuidPageInfo> getAus(String namespace,
 Integer limit,
 String continuationToken)

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

Specified by:

getAus in interface AusApiDelegate

Parameters:

namespace - A String with the namespace of 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:

• AusApi.getAus(java.lang.String, java.lang.Integer, java.lang.String)

handleBulkAuOp

public org.springframework.http.ResponseEntity<Void> handleBulkAuOp(String auid,
 String op,
 String namespace)

Handles bulk transfer operations for an AUID in a namespace. Possible operations are start and finish.

Specified by:

handleBulkAuOp in interface AusApiDelegate

Parameters:

auid - A String containing the AUID to operate on.

op - A String with the operation to perform. Must be either start or finish.

namespace - A String containing the namespace of the AUID to operate on.

Returns:

TBD

See Also:

• AusApi.handleBulkAuOp(java.lang.String, java.lang.String, java.lang.String)