Package org.lockss.ws.content

Interface ContentConfigurationService

All Known Implementing Classes:
ContentConfigurationServiceImpl
public interface ContentConfigurationService
The Content Configuration SOAP web service interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.lockss.ws.entities.ContentConfigurationResult
    addAuById(String auId)
    Configures the archival unit defined by its identifier.
    List<org.lockss.ws.entities.ContentConfigurationResult>
    addAusByIdList(List<String> auIds)
    Configures the archival units defined by a list with their identifiers.
    org.lockss.ws.entities.ContentConfigurationResult
    deactivateAuById(String auId)
    Deactivates the archival unit defined by its identifier.
    List<org.lockss.ws.entities.ContentConfigurationResult>
    deactivateAusByIdList(List<String> auIds)
    Deactivates the archival units defined by a list with their identifiers.
    org.lockss.ws.entities.ContentConfigurationResult
    deleteAuById(String auId)
    Unconfigures the archival unit defined by its identifier.
    List<org.lockss.ws.entities.ContentConfigurationResult>
    deleteAusByIdList(List<String> auIds)
    Unconfigures the archival units defined by a list with their identifiers.
    org.lockss.ws.entities.ContentConfigurationResult
    reactivateAuById(String auId)
    Reactivates the archival unit defined by its identifier.
    List<org.lockss.ws.entities.ContentConfigurationResult>
    reactivateAusByIdList(List<String> auIds)
    Reactivates the archival units defined by a list with their identifiers.

  • Method Details

    • addAuById

      org.lockss.ws.entities.ContentConfigurationResult addAuById(String auId) throws org.lockss.ws.entities.LockssWebServicesFault
      Configures the archival unit defined by its identifier.
      Parameters:
      auId - A String with the identifier (auid) of the archival unit. The archival unit to be added must already be in the title db that's loaded into the daemon.
      Returns:
      a ContentConfigurationResult with the result of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • addAusByIdList

      List<org.lockss.ws.entities.ContentConfigurationResult> addAusByIdList(List<String> auIds) throws org.lockss.ws.entities.LockssWebServicesFault
      Configures the archival units defined by a list with their identifiers.
      Parameters:
      auIds - A List<String> with the identifiers (auids) of the archival units. The archival units to be added must already be in the title db that's loaded into the daemon.
      Returns:
      a List<ContentConfigurationResult> with the results of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • deleteAuById

      org.lockss.ws.entities.ContentConfigurationResult deleteAuById(String auId) throws org.lockss.ws.entities.LockssWebServicesFault
      Unconfigures the archival unit defined by its identifier.
      Parameters:
      auId - A String with the identifier (auid) of the archival unit.
      Returns:
      a ContentConfigurationResult with the result of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • deleteAusByIdList

      List<org.lockss.ws.entities.ContentConfigurationResult> deleteAusByIdList(List<String> auIds) throws org.lockss.ws.entities.LockssWebServicesFault
      Unconfigures 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<ContentConfigurationResult> with the results of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • reactivateAuById

      org.lockss.ws.entities.ContentConfigurationResult reactivateAuById(String auId) throws org.lockss.ws.entities.LockssWebServicesFault
      Reactivates the archival unit defined by its identifier.
      Parameters:
      auId - A String with the identifier (auid) of the archival unit.
      Returns:
      a ContentConfigurationResult with the result of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • reactivateAusByIdList

      List<org.lockss.ws.entities.ContentConfigurationResult> reactivateAusByIdList(List<String> auIds) throws org.lockss.ws.entities.LockssWebServicesFault
      Reactivates 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<ContentConfigurationResult> with the results of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • deactivateAuById

      org.lockss.ws.entities.ContentConfigurationResult deactivateAuById(String auId) throws org.lockss.ws.entities.LockssWebServicesFault
      Deactivates the archival unit defined by its identifier.
      Parameters:
      auId - A String with the identifier (auid) of the archival unit.
      Returns:
      a ContentConfigurationResult with the result of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • deactivateAusByIdList

      List<org.lockss.ws.entities.ContentConfigurationResult> deactivateAusByIdList(List<String> auIds) throws org.lockss.ws.entities.LockssWebServicesFault
      Deactivates 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<ContentConfigurationResult> with the results of the operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.