Interface RESTInterface

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

  • 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

    • updateLiveTransferStatistics

      void updateLiveTransferStatistics(LiveTransferSample[] samples) throws Exception
      Live transfer statistics sent from a ProxyHost (relayed via this data mover's REST server) to the MasterServer, feeding the "Live Earth" globe visualisation.
      Parameters:
      samples - the samples
      Throws:
      Exception - the exception

    • updateTrafficAccounting

      void updateTrafficAccounting(String mover, Map<String,String> snapshot) throws Exception
      Throws:
      Exception

    • isLiveTransferMonitoringEnabled

      boolean isLiveTransferMonitoringEnabled() throws Exception
      Whether the MasterServer currently wants live transfer statistics, so a ProxyHost knows whether it is worth sampling/pushing at all (relayed via this data mover's REST server).
      Returns:
      true, if enabled
      Throws:
      Exception - the exception