Package 

Class SftpFileTransfer

  • All Implemented Interfaces:
    com.cognifide.gradle.common.file.transfer.FileTransfer , com.cognifide.gradle.common.file.transfer.FileTransferHandler , java.io.Serializable 
    
public final class SftpFileTransfer
extends ProtocolFileTransfer

    • Method Summary

      Modifier and Type Method Description
      final Unit client(Function1<SshClient, Unit> options)
      final Unit session(Function1<ClientSession, Unit> options)
      Unit downloadFrom(String dirUrl, String fileName, File target) Downloads file with given name from directory available at specified URL.
      Unit uploadTo(String dirUrl, String fileName, File source) Uploads file to directory available at specified URL and set given name.
      Unit deleteFrom(String dirUrl, String fileName) Deletes file of given name in directory available at specified URL.
      List<FileEntry> list(String dirUrl) Lists files in directory available at specified URL.
      Unit truncate(String dirUrl) Deletes all files in directory available at specified URL.
      FileEntry stat(String dirUrl, String fileName) Gets file status of given name in directory at specified URL.
      final <T extends Any> T connect(String url, Function2<SftpClient, String, T> callback)
      final <T extends Any> T connectDir(String dirUrl, Function2<SftpClient, String, T> callback)
      final Property<String> getUser()
      final Property<String> getPassword()
      final Property<Long> getTimeout()
      String getName()
      List<String> getProtocols()
      Property<Boolean> getEnabled() When enabled, transfer will be considered when finding transfer handling particular URL.
      Provider<Boolean> getParallelable() Determines if operations using this transfer could be done in parallel.

      • Methods inherited from class com.cognifide.gradle.common.file.transfer.FileTransferHandler

        delete, download, downloadTo, exists, exists, stat, upload, uploadTo

      • Methods inherited from class com.cognifide.gradle.common.file.transfer.sftp.SftpFileTransfer

        handles

      • Methods inherited from class com.cognifide.gradle.common.file.transfer.ProtocolFileTransfer

        download, downloader, uploader

      • Methods inherited from class com.cognifide.gradle.common.file.transfer.FileTransfer

        equals, hashCode, toString

      • Methods inherited from class java.lang.Object

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