Package ch.ethz.sis.openbis.generic.dssapi.v3.fastdownload

Class FastDownloadResult

  • public class FastDownloadResult
extends java.lang.Object
    The result of a download session.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDownloadSessionId()
      Returns the download session ID.
      java.lang.String getFileTransferUserSessionId()
      Returns the user session ID.
      java.util.Map<IDataSetFileId,​java.nio.file.Path> getPathsById()
      Returns the map of data set file IDs to local download paths.
      ch.ethz.sis.filetransfer.DownloadStatus getStatus()
      Returns the status of the download session.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • getStatus

        public ch.ethz.sis.filetransfer.DownloadStatus getStatus()
        Returns the status of the download session.

      • getPathsById

        public java.util.Map<IDataSetFileId,​java.nio.file.Path> getPathsById()
        Returns the map of data set file IDs to local download paths.
        Returns:
        an empty map if the download status isn't FINISHED.

      • getFileTransferUserSessionId

        public java.lang.String getFileTransferUserSessionId()
        Returns the user session ID.

      • getDownloadSessionId

        public java.lang.String getDownloadSessionId()
        Returns the download session ID.
        Returns:
        null if the download status is NEW.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object