org.lockss.laaws.poller.impl

Class AusApiServiceImpl

java.lang.Object

org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.laaws.poller.impl.AusApiServiceImpl

All Implemented Interfaces:

AusApiDelegate

@Service
public class AusApiServiceImpl
extends BaseSpringApiServiceImpl
implements AusApiDelegate

Service for accessing the repository artifacts.

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 and Description
AusApiServiceImpl(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	getExportFiles(String auid, String fileType, Boolean isCompress, Boolean isExcludeDirNodes, String xlateFilenames, String filePrefix, Long maxSize, Integer maxVersions) GET /aus/{auid}/export: Export the Archival Unit artifacts as a group of archives.
Optional<com.fasterxml.jackson.databind.ObjectMapper>	getObjectMapper()
Optional<javax.servlet.http.HttpServletRequest>	getRequest()
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, getReadyWaitTime, getRunningLockssDaemon, getWaitTime, jmsSetUpDone, 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.poller.api.AusApiDelegate

getAcceptHeader

Constructor Detail

AusApiServiceImpl

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

getExportFiles

public org.springframework.http.ResponseEntity getExportFiles(String auid,
                                                              String fileType,
                                                              Boolean isCompress,
                                                              Boolean isExcludeDirNodes,
                                                              String xlateFilenames,
                                                              String filePrefix,
                                                              Long maxSize,
                                                              Integer maxVersions)

GET /aus/{auid}/export: Export the Archival Unit artifacts as a group of archives.

Specified by:

getExportFiles in interface AusApiDelegate

Parameters:

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

fileType - A String with the type of archive to create.

isCompress - A Boolean with the indication of whether contents should be compressed.

isExcludeDirNodes - A Boolean with the indication of whether directories should be excluded.

xlateFilenames - A String with the type of filename translation to be done.

filePrefix - A String with the prefix to be used to name the exported file.

maxSize - A Long with the maximum size in MB of the exported file.

maxVersions - An Integer with the maximum number of versions of an artifact to be exported.

Returns:

a ResponseEntity<MultiValueMap<String, Object>> with the archives containing the Archival Unit artifacts.

See Also:

AusApi.getExportFiles(java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Boolean, java.lang.String, java.lang.String, java.lang.Long, java.lang.Integer)

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 AusApiDelegate

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:

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

getObjectMapper

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

Specified by:

getObjectMapper in interface AusApiDelegate

getRequest

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

Specified by:

getRequest in interface AusApiDelegate