Package org.lockss.laaws.poller.impl

Class WsApiServiceImpl

java.lang.Object

org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.laaws.poller.impl.WsApiServiceImpl

All Implemented Interfaces:

WsApiDelegate

@Service
public class WsApiServiceImpl
extends BaseSpringApiServiceImpl
implements WsApiDelegate

Nested Class Summary

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

BaseSpringApiServiceImpl.MapMessageListener

Field Summary

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
WsApiServiceImpl(jakarta.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<String>	deleteHash(String requestId)	Removes from the system an asynchronous hashing operation, terminating it if it's still running.
org.springframework.http.ResponseEntity	getAllHashes()
org.springframework.http.ResponseEntity	getHash(String requestId)	Provides the result of an asynchronous hashing operation.
org.springframework.http.ResponseEntity	getPeers(String peerQuery)	Provides the selected properties of selected peers.
org.springframework.http.ResponseEntity	getPolls(String pollQuery)	Provides the selected properties of selected polls.
org.springframework.http.ResponseEntity	getRepositories(String repositoryQuery)	GET /aurepositories?query={repositoryQuery}: Provides the selected properties of selected repositories in the system.
org.springframework.http.ResponseEntity	getRepositorySpaces(String repositorySpaceQuery)	GET /repositoryspaces?query={repositoryQuery}: Provides the selected properties of selected repository spaces in the system.
org.springframework.http.ResponseEntity	getVotes(String voteQuery)	Provides the selected properties of selected votes.
org.springframework.http.ResponseEntity	putHash(org.lockss.ws.entities.HasherWsParams hasherWsParams, Boolean isAsynchronous)
org.springframework.http.ResponseEntity<Void>	putImportFile(String targetBaseUrlPath, String targetUrl, org.springframework.web.multipart.MultipartFile file, List<String> userProperties)	PUT /aus/import: Import a file as an artifact in an Archival Unit.

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.poller.api.WsApiDelegate

getAcceptHeader, getObjectMapper, getRequest

Constructor Details

WsApiServiceImpl

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

Method Details

putImportFile

public org.springframework.http.ResponseEntity<Void> putImportFile(String targetBaseUrlPath,
 String targetUrl,
 org.springframework.web.multipart.MultipartFile file,
 List<String> userProperties)

PUT /aus/import: Import a file as an artifact in an Archival Unit.

Specified by:

putImportFile in interface WsApiDelegate

Parameters:

targetBaseUrlPath - A String with the base URL path of the target Archival Unit.

targetUrl - A String with the target Archival Unit URL.

file - A MultipartFile with the content of the file to be imported.

userProperties - A List<String> with the user-specified properties.

Returns:

a ResponseEntity<Void>.

See Also:

• WsApi.putImportFile(java.lang.String, java.lang.String, org.springframework.web.multipart.MultipartFile, java.util.List<java.lang.String>)

getRepositories

public org.springframework.http.ResponseEntity getRepositories(String repositoryQuery)

GET /aurepositories?query={repositoryQuery}: Provides the selected properties of selected repositories in the system.

Specified by:

getRepositories in interface WsApiDelegate

Parameters:

repositoryQuery - A String with the SQL-like query used to specify what properties to retrieve from which repository.

Returns:

a List<RepositoryWsResult> with the results.

See Also:

• WsApi.getRepositories(java.lang.String)

deleteHash

public org.springframework.http.ResponseEntity<String> deleteHash(String requestId)

Removes from the system an asynchronous hashing operation, terminating it if it's still running.

Specified by:

deleteHash in interface WsApiDelegate

Parameters:

requestId - A String with the identifier of the requested asynchronous hashing operation.

Returns:

a ResponseEntity<String> with the result of the removal of the hashing operation.

See Also:

• WsApi.deleteHash(java.lang.String)

getAllHashes

public org.springframework.http.ResponseEntity getAllHashes()

Specified by:

getAllHashes in interface WsApiDelegate

See Also:

• WsApi.getAllHashes()

getHash

public org.springframework.http.ResponseEntity getHash(String requestId)

Provides the result of an asynchronous hashing operation.

Specified by:

getHash in interface WsApiDelegate

Parameters:

requestId - A String with the identifier of the requested asynchronous hashing operation.

Returns:

a ResponseEntity<MultiValueMap<String, Object>> with the result of the hashing operation.

See Also:

• WsApi.getHash(java.lang.String)

putHash

public org.springframework.http.ResponseEntity putHash(org.lockss.ws.entities.HasherWsParams hasherWsParams,
 Boolean isAsynchronous)

Specified by:

putHash in interface WsApiDelegate

See Also:

• WsApi.putHash(org.lockss.ws.entities.HasherWsParams, java.lang.Boolean)

getPeers

public org.springframework.http.ResponseEntity getPeers(String peerQuery)

Provides the selected properties of selected peers.

Specified by:

getPeers in interface WsApiDelegate

Parameters:

peerQuery - A String with the SQL-like query used to specify what properties to retrieve from which peers.

Returns:

a ResponseEntity<List<PeerWsResult>> with the results.

See Also:

• WsApi.getPeers(java.lang.String)

getPolls

public org.springframework.http.ResponseEntity getPolls(String pollQuery)

Provides the selected properties of selected polls.

Specified by:

getPolls in interface WsApiDelegate

Parameters:

pollQuery - A String with the SQL-like query used to specify what properties to retrieve from which polls.

Returns:

a ResponseEntity<List<PollWsResult>> with the results.

See Also:

• WsApi.getPolls(java.lang.String)

getRepositorySpaces

public org.springframework.http.ResponseEntity getRepositorySpaces(String repositorySpaceQuery)

GET /repositoryspaces?query={repositoryQuery}: Provides the selected properties of selected repository spaces in the system.

Specified by:

getRepositorySpaces in interface WsApiDelegate

Parameters:

repositorySpaceQuery - A String with the SQL-like query used to specify what properties to retrieve from which repository space.

Returns:

a List<RepositorySpaceWsResult> with the results.

See Also:

• WsApi.getRepositorySpaces(java.lang.String)

getVotes

public org.springframework.http.ResponseEntity getVotes(String voteQuery)

Provides the selected properties of selected votes.

Specified by:

getVotes in interface WsApiDelegate

Parameters:

voteQuery - A String with the SQL-like query used to specify what properties to retrieve from which votes.

Returns:

a ResponseEntity<List<VoteWsResult>> with the results.

See Also:

• WsApi.getVotes(java.lang.String)