Package org.lockss.ws.control

Interface AuControlService

All Known Implementing Classes:
AuControlServiceImpl
public interface AuControlService
The AU Control SOAP web service interface.

  • Method Summary

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

  • Method Details

    • checkSubstanceById

      org.lockss.ws.entities.CheckSubstanceResult checkSubstanceById(String auId) throws org.lockss.ws.entities.LockssWebServicesFault
      Provides an indication of whether an archival unit has substance.
      Parameters:
      auId - A String with the identifier (auid) of the archival unit.
      Returns:
      a CheckSubstanceResult with the result of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • checkSubstanceByIdList

      List<org.lockss.ws.entities.CheckSubstanceResult> checkSubstanceByIdList(List<String> auIds) throws org.lockss.ws.entities.LockssWebServicesFault
      Provides an indication of whether the archival units defined by a list with their identifiers have substance.
      Parameters:
      auIds - A List<String> with the identifiers (auids) of the archival units.
      Returns:
      a List<CheckSubstanceResult> with the results of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • requestCrawlById

      org.lockss.ws.entities.RequestCrawlResult requestCrawlById(String auId, Integer priority, boolean force) throws org.lockss.ws.entities.LockssWebServicesFault
      Requests the crawl of an archival unit.
      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:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • requestCrawlByIdList

      List<org.lockss.ws.entities.RequestCrawlResult> requestCrawlByIdList(List<String> auIds, Integer priority, boolean force) throws org.lockss.ws.entities.LockssWebServicesFault
      Requests the crawl of the archival units defined by a list with their identifiers.
      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:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • requestDeepCrawlById

      org.lockss.ws.entities.RequestDeepCrawlResult requestDeepCrawlById(String auId, int refetchDepth, Integer priority, boolean force) throws org.lockss.ws.entities.LockssWebServicesFault
      Requests the deep crawl of an archival unit.
      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:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • requestDeepCrawlByIdList

      List<org.lockss.ws.entities.RequestDeepCrawlResult> requestDeepCrawlByIdList(List<String> auIds, int refetchDepth, Integer priority, boolean force) throws org.lockss.ws.entities.LockssWebServicesFault
      Requests the deep crawl of the archival units defined by a list with their identifiers.
      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:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • requestPollById

      org.lockss.ws.entities.RequestAuControlResult requestPollById(String auId) throws org.lockss.ws.entities.LockssWebServicesFault
      Requests the polling of an archival unit.
      Parameters:
      auId - A String with the identifier (auid) of the archival unit.
      Returns:
      a RequestAuControlResult with the result of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • requestPollByIdList

      List<org.lockss.ws.entities.RequestAuControlResult> requestPollByIdList(List<String> auIds) throws org.lockss.ws.entities.LockssWebServicesFault
      Requests the polling of the archival units defined by a list with their identifiers.
      Parameters:
      auIds - A List<String> with the identifiers (auids) of the archival units.
      Returns:
      a List<RequestAuControlResult> with the results of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • requestMdIndexingById

      org.lockss.ws.entities.RequestAuControlResult requestMdIndexingById(String auId, boolean force) throws org.lockss.ws.entities.LockssWebServicesFault
      Requests the metadata indexing of an archival unit.
      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:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • requestMdIndexingByIdList

      List<org.lockss.ws.entities.RequestAuControlResult> requestMdIndexingByIdList(List<String> auIds, boolean force) throws org.lockss.ws.entities.LockssWebServicesFault
      Requests the metadata indexing of the archival units defined by a list with their identifiers.
      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:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • disableMdIndexingById

      org.lockss.ws.entities.RequestAuControlResult disableMdIndexingById(String auId) throws org.lockss.ws.entities.LockssWebServicesFault
      Disables the metadata indexing of an archival unit.
      Parameters:
      auId - A String with the identifier (auid) of the archival unit.
      Returns:
      a RequestAuControlResult with the result of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • disableMdIndexingByIdList

      List<org.lockss.ws.entities.RequestAuControlResult> disableMdIndexingByIdList(List<String> auIds) throws org.lockss.ws.entities.LockssWebServicesFault
      Disables the metadata indexing of the archival units defined by a list with their identifiers.
      Parameters:
      auIds - A List with the identifiers (auids) of the archival units.
      Returns:
      a List with the results of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • enableMdIndexingById

      org.lockss.ws.entities.RequestAuControlResult enableMdIndexingById(String auId) throws org.lockss.ws.entities.LockssWebServicesFault
      Enables the metadata indexing of an archival unit.
      Parameters:
      auId - A String with the identifier (auid) of the archival unit.
      Returns:
      a RequestAuControlResult with the result of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • enableMdIndexingByIdList

      List<org.lockss.ws.entities.RequestAuControlResult> enableMdIndexingByIdList(List<String> auIds) throws org.lockss.ws.entities.LockssWebServicesFault
      Enables the metadata indexing of the archival units defined by a list with their identifiers.
      Parameters:
      auIds - A List with the identifiers (auids) of the archival units.
      Returns:
      a List with the results of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.