Package org.lockss.ws.content

Class ContentServiceImpl

java.lang.Object

org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.ws.BaseServiceImpl

org.lockss.ws.content.ContentServiceImpl

All Implemented Interfaces:

LockssConfigurableService, ContentService

@Service
public class ContentServiceImpl
extends BaseServiceImpl
implements ContentService

The Content SOAP web service implementation.

Nested Class Summary

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

BaseSpringApiServiceImpl.MapMessageListener

Field Summary

Fields inherited from class org.lockss.ws.BaseServiceImpl

connectionTimeout, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT, DEFAULT_REPO_NAMESPACE, PARAM_CONNECTION_TIMEOUT, PARAM_READ_TIMEOUT, PARAM_REPO_NAMESPACE, PREFIX, readTimeout, repoNamespace, restTemplate

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
ContentServiceImpl()

Method Summary

Modifier and Type	Method	Description
org.lockss.ws.entities.ContentResult	fetchFile(String url, String auId)	Provides the content defined by a URL and Archival Unit.
org.lockss.ws.entities.ContentResult	fetchVersionedFile(String url, String auId, Integer version)	Provides the content defined by a URL, an Archival Unit and a version.
List<org.lockss.ws.entities.FileWsResult>	getVersions(String url, String auId)	Provides a list of the versions of a URL in an Archival Unit.
boolean	isUrlCached(String url, String auId)	Provides an indication of whether the content defined by a URL and Archival Unit is cached.
boolean	isUrlVersionCached(String url, String auId, Integer version)	Provides an indication of whether the content defined by a URL, an Archival Unit and a version is cached.

Methods inherited from class org.lockss.ws.BaseServiceImpl

callRestServiceEndpoint, callRestServiceUri, callRestServiceUri, getAuthHeaders, getConnectionTimeout, getMultipartResponse, getReadTimeout, getRequestorIpAddress, getRestLockssRepository, getServiceBinding, getServiceEndpoint, getSoapRequestAuthorizationHeader, getSoapRequestCredentials, separatedString, setConfig

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

Constructor Details

ContentServiceImpl

public ContentServiceImpl()

Method Details

getVersions

public List<org.lockss.ws.entities.FileWsResult> getVersions(String url,
 String auId)
                                                      throws org.lockss.ws.entities.LockssWebServicesFault

Provides a list of the versions of a URL in an Archival Unit.

Specified by:

getVersions in interface ContentService

Parameters:

url - A String with the URL.

auId - A String with the identifier (auid) of the archival unit.

Returns:

a List<FileWsResult> with the results.

Throws:

org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

isUrlCached

public boolean isUrlCached(String url,
 String auId)
                    throws org.lockss.ws.entities.LockssWebServicesFault

Provides an indication of whether the content defined by a URL and Archival Unit is cached.

Specified by:

isUrlCached in interface ContentService

Parameters:

url - A String with the URL.

auId - A String with the identifier (auid) of the archival unit.

Returns:

a boolean with the indication.

Throws:

org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

isUrlVersionCached

public boolean isUrlVersionCached(String url,
 String auId,
 Integer version)
                           throws org.lockss.ws.entities.LockssWebServicesFault

Provides an indication of whether the content defined by a URL, an Archival Unit and a version is cached.

Specified by:

isUrlVersionCached in interface ContentService

Parameters:

url - A String with the URL.

auId - A String with the identifier (auid) of the archival unit.

version - An Integer with the requested version of the content.

Returns:

a boolean with the indication.

Throws:

org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

fetchFile

public org.lockss.ws.entities.ContentResult fetchFile(String url,
 String auId)
                                               throws org.lockss.ws.entities.LockssWebServicesFault

Provides the content defined by a URL and Archival Unit.

Specified by:

fetchFile in interface ContentService

Parameters:

url - A String with the URL.

auId - A String with the identifier (auid) of the archival unit.

Returns:

a ContentResult with the result of the operation.

Throws:

org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

fetchVersionedFile

public org.lockss.ws.entities.ContentResult fetchVersionedFile(String url,
 String auId,
 Integer version)
                                                        throws org.lockss.ws.entities.LockssWebServicesFault

Provides the content defined by a URL, an Archival Unit and a version.

Specified by:

fetchVersionedFile in interface ContentService

Parameters:

url - A String with the URL.

auId - A String with the identifier (auid) of the archival unit.

version - An Integer with the requested version of the content.

Returns:

a ContentResult with the result of the operation.

Throws:

org.lockss.ws.entities.LockssWebServicesFault - if there are problems.