Package org.lockss.ws.hasher

Interface HasherService

All Known Implementing Classes:
HasherServiceImpl
public interface HasherService
The Hasher SOAP web service interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.lockss.ws.entities.HasherWsAsynchronousResult>
    getAllAsynchronousHashResults()
    Provides the results of all the asynchronous hashing operations.
    org.lockss.ws.entities.HasherWsAsynchronousResult
    getAsynchronousHashResult(String requestId)
    Provides the result of an asynchronous hashing operation.
    org.lockss.ws.entities.HasherWsResult
    hash(org.lockss.ws.entities.HasherWsParams hasherParams)
    Performs the hashing of an AU or a URL.
    org.lockss.ws.entities.HasherWsAsynchronousResult
    hashAsynchronously(org.lockss.ws.entities.HasherWsParams hasherParams)
    Performs asynchronously the hashing of an AU or a URL.
    org.lockss.ws.entities.HasherWsAsynchronousResult
    removeAsynchronousHashRequest(String requestId)
    Removes from the system an asynchronous hashing operation, terminating it if it's still running.

  • Method Details

    • hash

      org.lockss.ws.entities.HasherWsResult hash(org.lockss.ws.entities.HasherWsParams hasherParams) throws org.lockss.ws.entities.LockssWebServicesFault
      Performs the hashing of an AU or a URL.
      Parameters:
      hasherParams - A HasherWsParams with the parameters of the hashing operation.
      Returns:
      a HasherWsResult with the result of the hashing operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • hashAsynchronously

      org.lockss.ws.entities.HasherWsAsynchronousResult hashAsynchronously(org.lockss.ws.entities.HasherWsParams hasherParams) throws org.lockss.ws.entities.LockssWebServicesFault
      Performs asynchronously the hashing of an AU or a URL.
      Parameters:
      hasherParams - A HasherWsParams with the parameters of the hashing operation.
      Returns:
      a HasherWsAsynchronousResult with the result of the hashing operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • getAsynchronousHashResult

      org.lockss.ws.entities.HasherWsAsynchronousResult getAsynchronousHashResult(String requestId) throws org.lockss.ws.entities.LockssWebServicesFault
      Provides the result of an asynchronous hashing operation.
      Parameters:
      requestId - A String with the identifier of the requested asynchronous hashing operation.
      Returns:
      a HasherWsAsynchronousResult with the result of the hashing operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • getAllAsynchronousHashResults

      List<org.lockss.ws.entities.HasherWsAsynchronousResult> getAllAsynchronousHashResults() throws org.lockss.ws.entities.LockssWebServicesFault
      Provides the results of all the asynchronous hashing operations.
      Returns:
      a List<HasherWsAsynchronousResult> with the result of the hashing operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.

    • removeAsynchronousHashRequest

      org.lockss.ws.entities.HasherWsAsynchronousResult removeAsynchronousHashRequest(String requestId) throws org.lockss.ws.entities.LockssWebServicesFault
      Removes from the system an asynchronous hashing operation, terminating it if it's still running.
      Parameters:
      requestId - A String with the identifier of the requested asynchronous hashing operation.
      Returns:
      a HasherWsAsynchronousResult with the result of the removal of the hashing operation.
      Throws:
      org.lockss.ws.entities.LockssWebServicesFault - if there are problems.