org.lockss.ws.control

Class AuControlServiceImpl

java.lang.Object

org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.ws.BaseServiceImpl

org.lockss.ws.control.AuControlServiceImpl

All Implemented Interfaces:

LockssConfigurableService, AuControlService

@Service
public class AuControlServiceImpl
extends BaseServiceImpl
implements AuControlService

The AU Control 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 and Description
AuControlServiceImpl()

Method Summary

Modifier and Type	Method and Description
CheckSubstanceResult	checkSubstanceById(String auId) Provides an indication of whether an Archival Unit has substance.
List<CheckSubstanceResult>	checkSubstanceByIdList(List<String> auIds) Provides an indication of whether the archival units defined by a list with their identifiers have substance.
RequestAuControlResult	disableMdIndexingById(String auId) Disables the metadata indexing of an archival unit.
List<RequestAuControlResult>	disableMdIndexingByIdList(List<String> auIds) Disables the metadata indexing of the archival units defined by a list with their identifiers.
RequestAuControlResult	enableMdIndexingById(String auId) Enables the metadata indexing of an archival unit.
List<RequestAuControlResult>	enableMdIndexingByIdList(List<String> auIds) Enables the metadata indexing of the archival units defined by a list with their identifiers.
RequestCrawlResult	requestCrawlById(String auId, Integer priority, boolean force) Requests the crawl of an archival unit.
List<RequestCrawlResult>	requestCrawlByIdList(List<String> auIds, Integer priority, boolean force) Requests the crawl of the archival units defined by a list with their identifiers.
RequestDeepCrawlResult	requestDeepCrawlById(String auId, int refetchDepth, Integer priority, boolean force) Requests the deep crawl of an archival unit.
List<RequestDeepCrawlResult>	requestDeepCrawlByIdList(List<String> auIds, int refetchDepth, Integer priority, boolean force) Requests the deep crawl of the archival units defined by a list with their identifiers.
RequestAuControlResult	requestMdIndexingById(String auId, boolean force) Requests the metadata indexing of an archival unit.
List<RequestAuControlResult>	requestMdIndexingByIdList(List<String> auIds, boolean force) Requests the metadata indexing of the archival units defined by a list with their identifiers.
RequestAuControlResult	requestPollById(String auId) Requests the polling of an archival unit.
List<RequestAuControlResult>	requestPollByIdList(List<String> auIds) Requests the polling of the archival units defined by a list with their identifiers.

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, 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 Detail

AuControlServiceImpl

public AuControlServiceImpl()

Method Detail

checkSubstanceById

public CheckSubstanceResult checkSubstanceById(String auId)
                                        throws LockssWebServicesFault

Provides an indication of whether an Archival Unit has substance.

Specified by:

checkSubstanceById in interface AuControlService

Parameters:

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

Returns:

a CheckSubstanceResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

checkSubstanceByIdList

public List<CheckSubstanceResult> checkSubstanceByIdList(List<String> auIds)
                                                  throws LockssWebServicesFault

Provides an indication of whether the archival units defined by a list with their identifiers have substance.

Specified by:

checkSubstanceByIdList in interface AuControlService

Parameters:

auIds - A List<String> with the identifiers (auids) of the archival units.

Returns:

a List<CheckSubstanceResult> with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestCrawlById

public RequestCrawlResult requestCrawlById(String auId,
                                           Integer priority,
                                           boolean force)
                                    throws LockssWebServicesFault

Requests the crawl of an archival unit.

Specified by:

requestCrawlById in interface AuControlService

Parameters:

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

priority - An Integer with the priority of the crawl request.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a RequestCrawlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestCrawlByIdList

public List<RequestCrawlResult> requestCrawlByIdList(List<String> auIds,
                                                     Integer priority,
                                                     boolean force)
                                              throws LockssWebServicesFault

Requests the crawl of the archival units defined by a list with their identifiers.

Specified by:

requestCrawlByIdList in interface AuControlService

Parameters:

auIds - A List<String> with the identifiers (auids) of the archival units.

priority - An Integer with the priority of the crawl request.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a List<RequestCrawlResult> with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestDeepCrawlById

public RequestDeepCrawlResult requestDeepCrawlById(String auId,
                                                   int refetchDepth,
                                                   Integer priority,
                                                   boolean force)
                                            throws LockssWebServicesFault

Requests the deep crawl of an archival unit.

Specified by:

requestDeepCrawlById in interface AuControlService

Parameters:

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

refetchDepth - An int with the depth of the crawl request.

priority - An Integer with the priority of the crawl request.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a RequestDeepCrawlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestDeepCrawlByIdList

public List<RequestDeepCrawlResult> requestDeepCrawlByIdList(List<String> auIds,
                                                             int refetchDepth,
                                                             Integer priority,
                                                             boolean force)
                                                      throws LockssWebServicesFault

Requests the deep crawl of the archival units defined by a list with their identifiers.

Specified by:

requestDeepCrawlByIdList in interface AuControlService

Parameters:

auIds - A List<String> with the identifiers (auids) of the archival units.

refetchDepth - An int with the depth of the crawl request.

priority - An Integer with the priority of the crawl request.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a List<RequestDeepCrawlResult> with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestPollById

public RequestAuControlResult requestPollById(String auId)
                                       throws LockssWebServicesFault

Requests the polling of an archival unit.

Specified by:

requestPollById in interface AuControlService

Parameters:

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

Returns:

a RequestPollResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestPollByIdList

public List<RequestAuControlResult> requestPollByIdList(List<String> auIds)
                                                 throws LockssWebServicesFault

Requests the polling of the archival units defined by a list with their identifiers.

Specified by:

requestPollByIdList in interface AuControlService

Parameters:

auIds - A List<String> with the identifiers (auids) of the archival units.

Returns:

a List<RequestPollResult> with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestMdIndexingById

public RequestAuControlResult requestMdIndexingById(String auId,
                                                    boolean force)
                                             throws LockssWebServicesFault

Requests the metadata indexing of an archival unit.

Specified by:

requestMdIndexingById in interface AuControlService

Parameters:

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

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a RequestAuControlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestMdIndexingByIdList

public List<RequestAuControlResult> requestMdIndexingByIdList(List<String> auIds,
                                                              boolean force)
                                                       throws LockssWebServicesFault

Requests the metadata indexing of the archival units defined by a list with their identifiers.

Specified by:

requestMdIndexingByIdList in interface AuControlService

Parameters:

auIds - A List with the identifiers (auids) of the archival units.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a List with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

disableMdIndexingById

public RequestAuControlResult disableMdIndexingById(String auId)
                                             throws LockssWebServicesFault

Disables the metadata indexing of an archival unit.

Specified by:

disableMdIndexingById in interface AuControlService

Parameters:

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

Returns:

a RequestAuControlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

disableMdIndexingByIdList

public List<RequestAuControlResult> disableMdIndexingByIdList(List<String> auIds)
                                                       throws LockssWebServicesFault

Disables the metadata indexing of the archival units defined by a list with their identifiers.

Specified by:

disableMdIndexingByIdList in interface AuControlService

Parameters:

auIds - A List with the identifiers (auids) of the archival units.

Returns:

a List with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

enableMdIndexingById

public RequestAuControlResult enableMdIndexingById(String auId)
                                            throws LockssWebServicesFault

Enables the metadata indexing of an archival unit.

Specified by:

enableMdIndexingById in interface AuControlService

Parameters:

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

Returns:

a RequestAuControlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

enableMdIndexingByIdList

public List<RequestAuControlResult> enableMdIndexingByIdList(List<String> auIds)
                                                      throws LockssWebServicesFault

Enables the metadata indexing of the archival units defined by a list with their identifiers.

Specified by:

enableMdIndexingByIdList in interface AuControlService

Parameters:

auIds - A List with the identifiers (auids) of the archival units.

Returns:

a List with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.