Interface RESTInterface

All Known Implementing Classes:
RESTClient
public interface RESTInterface
The Interface RESTInterface.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close(DataTransfer dataTransfer)
    Stops the transmission of the DataTransfer on the mover.
    void
    del(DataFile dataFile)
    Deletes the physical file associated to the DataFile on the mover.
    ECauthToken
    getECauthToken(String user)
    Requests a ecauth token to allow a connection to a ecauth compliant server.
    String
    getHostReport(Host host)
    Requests a report for the specified Host (e.g. traceroute, paping).
    String
    getMoverReport()
    Requests a report from the Data Mover (e.g. df, sar).
    String
    getVersion()
    Gets the version of the remote ECaccess software (mover).
    boolean
    isValidDataFile(long dataFileId)
    Checks if the DataFile exists and is not expired.
    long
    proxyHostIsAlive(String name)
    Live message sent from the ProxyHost to the Master server.
    void
    purge(List<ExistingStorageDirectory> directories)
    Requests an asynchronous purge of the DataFiles on the data mover which are more than the specified date.
    String
    put(DataTransfer transfer, String fileName, long localPosn, long remotePosn)
    Requests a transmission of the DataTransfer with the target name as specified in fileName.
    void
    sendMessage(RESTClient.MonitorRequest request)
    Sends a message to Monitor.
    void
    updateData(Host host)
    Requests an update of the data part of the Host on the master (e.g. when the data is updated by the ectrans module).
    void
    updateDataRequest(RESTClient.UpdateDataRequest request)
    Requests an update of the data part of the Host on the master (e.g. when the data is updated by the ectrans module).
    void
    updateDataTransfers(List<DataTransfer> transfers)
    Requests an update of the transfers on the master (e.g. status).
    void
    updateLocation(Host host)
    Requests an update of the location part of the Host on the master (e.g. when the IP is updated by the ectrans module).

  • Method Details

    • getVersion

      String getVersion() throws Exception
      Gets the version of the remote ECaccess software (mover).
      Returns:
      the version
      Throws:
      Exception - the exception

    • del

      void del(DataFile dataFile) throws Exception
      Deletes the physical file associated to the DataFile on the mover.
      Parameters:
      dataFile - the data file
      Throws:
      Exception - the exception

    • close

      void close(DataTransfer dataTransfer) throws Exception
      Stops the transmission of the DataTransfer on the mover.
      Parameters:
      dataTransfer - the data transfer
      Throws:
      Exception - the exception

    • put

      String put(DataTransfer transfer, String fileName, long localPosn, long remotePosn) throws Exception
      Requests a transmission of the DataTransfer with the target name as specified in fileName. Return the name of the DataMover used for the transmission.
      Parameters:
      transfer - the transfer
      fileName - the file name
      localPosn - the local posn
      remotePosn - the remote posn
      Returns:
      the string
      Throws:
      Exception - the exception

    • purge

      void purge(List<ExistingStorageDirectory> directories) throws Exception
      Requests an asynchronous purge of the DataFiles on the data mover which are more than the specified date.
      Parameters:
      directories - the directories
      Throws:
      Exception - the exception

    • getHostReport

      String getHostReport(Host host) throws Exception
      Requests a report for the specified Host (e.g. traceroute, paping).
      Parameters:
      host - the host
      Returns:
      the host report
      Throws:
      Exception - the exception

    • getMoverReport

      String getMoverReport() throws Exception
      Requests a report from the Data Mover (e.g. df, sar).
      Returns:
      the mover report
      Throws:
      Exception - the exception

    • getECauthToken

      ECauthToken getECauthToken(String user) throws Exception
      Requests a ecauth token to allow a connection to a ecauth compliant server.
      Parameters:
      user - the user
      Returns:
      the ecauth token
      Throws:
      Exception - the exception

    • proxyHostIsAlive

      long proxyHostIsAlive(String name) throws Exception
      Live message sent from the ProxyHost to the Master server.
      Parameters:
      name - the name
      Returns:
      the long
      Throws:
      Exception - the exception

    • updateDataRequest

      void updateDataRequest(RESTClient.UpdateDataRequest request) throws Exception
      Requests an update of the data part of the Host on the master (e.g. when the data is updated by the ectrans module).
      Parameters:
      request - the request
      Throws:
      Exception - the exception

    • updateData

      void updateData(Host host) throws Exception
      Requests an update of the data part of the Host on the master (e.g. when the data is updated by the ectrans module).
      Parameters:
      host - the host
      Throws:
      Exception - the exception

    • updateLocation

      void updateLocation(Host host) throws Exception
      Requests an update of the location part of the Host on the master (e.g. when the IP is updated by the ectrans module).
      Parameters:
      host - the host
      Throws:
      Exception - the exception

    • updateDataTransfers

      void updateDataTransfers(List<DataTransfer> transfers) throws Exception
      Requests an update of the transfers on the master (e.g. status).
      Parameters:
      transfers - the transfers
      Throws:
      Exception - the exception

    • sendMessage

      void sendMessage(RESTClient.MonitorRequest request) throws Exception
      Sends a message to Monitor.
      Parameters:
      request - the request
      Throws:
      Exception - the exception

    • isValidDataFile

      boolean isValidDataFile(long dataFileId) throws Exception
      Checks if the DataFile exists and is not expired.
      Parameters:
      dataFileId - the data file id
      Returns:
      true, if is valid data file
      Throws:
      Exception - the exception