Package org.lockss.ws.content

Interface ContentService

All Known Implementing Classes:
ContentServiceImpl
public interface ContentService
The Content SOAP web service interface.

  • 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.

  • Method Details

    • getVersions

      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.
      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

      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.
      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

      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.
      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

      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.
      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

      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.
      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.