Package jadex.bridge.service.types.filetransfer

Interface IFileTransferService

  • public interface IFileTransferService
    Interface for the file transfer service.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      jadex.commons.future.IFuture<java.lang.Void> deleteFile​(java.lang.String path)
      Delete a file.
      jadex.commons.future.ISubscriptionIntermediateFuture<java.lang.Long> downloadFile​(IOutputConnection con, java.lang.String name)
      Download a file.
      jadex.commons.future.IFuture<FileData[]> getRoots()
      Get the root devices.
      jadex.commons.future.IFuture<FileData[]> listDirectory​(java.lang.String dir)
      List the contents of a directory.
      jadex.commons.future.IFuture<java.lang.Void> openFile​(java.lang.String path)
      Open a file.
      jadex.commons.future.IFuture<java.lang.String> renameFile​(java.lang.String path, java.lang.String name)
      Rename a file.
      jadex.commons.future.ISubscriptionIntermediateFuture<java.lang.Long> uploadFile​(IInputConnection con, java.lang.String path, java.lang.String name)
      Put a file.

    • Method Detail

      • uploadFile

        jadex.commons.future.ISubscriptionIntermediateFuture<java.lang.Long> uploadFile​(IInputConnection con,
                                                                                java.lang.String path,
                                                                                java.lang.String name)
        Put a file.
        Parameters:
        file - The file data.
        path - The target path.
        Returns:
        True, when the file has been copied.

      • downloadFile

        jadex.commons.future.ISubscriptionIntermediateFuture<java.lang.Long> downloadFile​(IOutputConnection con,
                                                                                  java.lang.String name)
        Download a file.
        Parameters:
        file - The file data.
        path - The target path.
        Returns:
        True, when the file has been copied.

      • renameFile

        jadex.commons.future.IFuture<java.lang.String> renameFile​(java.lang.String path,
                                                          java.lang.String name)
        Rename a file.
        Parameters:
        path - The target path.
        name - The name.
        Returns:
        True, if rename was successful.

      • deleteFile

        jadex.commons.future.IFuture<java.lang.Void> deleteFile​(java.lang.String path)
        Delete a file.
        Parameters:
        path - The target path.
        Returns:
        True, if delete was successful.

      • openFile

        jadex.commons.future.IFuture<java.lang.Void> openFile​(java.lang.String path)
        Open a file.
        Parameters:
        path - The filename to open.

      • getRoots

        jadex.commons.future.IFuture<FileData[]> getRoots()
        Get the root devices.
        Returns:
        The root device files.

      • listDirectory

        jadex.commons.future.IFuture<FileData[]> listDirectory​(java.lang.String dir)
        List the contents of a directory.
        Parameters:
        dir - The directory, null for current directory.
        Returns:
        The contained files.