AbstractSftpClient (Maverick Extensions 2.0.0-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sshtools.sftp
Class AbstractSftpClient

java.lang.Object
  com.sshtools.sftp.AbstractSftpClient

All Implemented Interfaces:: Client, SftpClient

Direct Known Subclasses:: ScpFallbackImpl, SftpClientImpl

public abstract class AbstractSftpClient
extends Object
implements Client, SftpClient
extends Object
implements Client, SftpClient

Implements a Secure File Transfer (SFTP) client.

Author:: Lee David Painter

Field Summary
`protected SshClient`	`ssh`
`protected int`	`umask`

Fields inherited from interface com.sshtools.sftp.SftpClient
`EOL_CR, EOL_CRLF, EOL_LF, GlobSyntax, MODE_BINARY, MODE_TEXT, NoSyntax, Perl5Syntax`

Constructor Summary
`protected`	`AbstractSftpClient(SshClient ssh, int maxVersion)`

Method Summary
`void`	`addCustomRoot(String rootPath)` Add a custom file system root path such as "flash:"
`void`	`cd(String dir)` Changes the working directory on the remote server, or the home directory if `null` or any empty string is provided as the directory path
`void`	`cdup()` Change the working directory to the parent directory
`protected abstract void`	`changeGroup(String gid, String path)`
`protected abstract void`	`changeOwner(String uid, String path)`
`protected abstract void`	`changePermissions(String file, int permissions)`
`void`	`chgrp(String gid, String path)` Sets the group ID for the file or directory.
`void`	`chmod(int permissions, String path)` Changes the access permissions or modes of the specified file or directory.
`void`	`chown(String uid, String path)` Sets the user ID to owner for the file or directory.
`protected abstract void`	`close()`
`DirectoryOperation`	`copyLocalDirectory(String localdir, String remotedir, boolean recurse, boolean sync, boolean commit, FileTransferProgress progress)` Copy the contents of a local directory into a remote remote directory.
`DirectoryOperation`	`copyRemoteDirectory(String remotedir, String localdir, boolean recurse, boolean sync, boolean commit, FileTransferProgress progress)` Copy the contents of a remote directory to a local directory
`protected abstract void`	`createSymbolicLink(String path, String link)`
`void`	`exit()` Close the SFTP client.
`static String`	`formatLongname(SftpFile file)` Format a String with the details of the file.
`static String`	`formatLongname(SftpFileAttributes attrs, String filename)` Format a String with the details of the file.
`SftpFileAttributes`	`get(String path)` Download the remote file to the local computer
`SftpFileAttributes`	`get(String path, boolean resume)` Download the remote file to the local computer
`SftpFileAttributes`	`get(String path, FileTransferProgress progress)` Download the remote file to the local computer.
`SftpFileAttributes`	`get(String path, FileTransferProgress progress, boolean resume)` Download the remote file to the local computer.
`SftpFileAttributes`	`get(String remote, OutputStream local)` Download the remote file into an OutputStream.
`SftpFileAttributes`	`get(String remote, OutputStream local, FileTransferProgress progress)` Download the remote file writing it to the specified `OutputStream`.
`SftpFileAttributes`	`get(String remote, OutputStream out, FileTransferProgress progress, long position)` Download the remote file writing it to the specified `OutputStream`.
`SftpFileAttributes`	`get(String remote, OutputStream local, long position)` Download the remote file into an OutputStream.
`SftpFileAttributes`	`get(String remote, String local)` Download the remote file into the local file.
`SftpFileAttributes`	`get(String remote, String local, boolean resume)` Download the remote file into the local file.
`SftpFileAttributes`	`get(String remote, String local, FileTransferProgress progress)` Download the remote file to the local computer.
`SftpFileAttributes`	`get(String remote, String local, FileTransferProgress progress, boolean resume)` Download the remote file to the local computer.
`String`	`getAbsolutePath(String path)` Get the absolute path for a file.
`protected abstract SftpFileAttributes`	`getAttributes(String file)`
`protected abstract byte[]`	`getCanonicalNewline()`
`String`	`getCharsetEncoding()`
`SftpFile`	`getFile(String path)`
`SftpFile[]`	`getFiles(String remote)` Download the remote files to the local computer
`SftpFile[]`	`getFiles(String remote, boolean resume)` Download the remote files to the local computer
`SftpFile[]`	`getFiles(String remote, FileTransferProgress progress)` Download the remote files to the local computer.
`SftpFile[]`	`getFiles(String remote, FileTransferProgress progress, boolean resume)` Download the remote files to the local computer.
`SftpFile[]`	`getFiles(String remote, OutputStream local)` Download the remote files into an OutputStream.
`SftpFile[]`	`getFiles(String remote, OutputStream local, FileTransferProgress progress)` Download the remote files writing it to the specified `OutputStream`.
`SftpFile[]`	`getFiles(String remote, OutputStream local, FileTransferProgress progress, long position)` make local copies of some of the variables, then call getfilematches, which calls get on each file that matches the regexp remote.
`SftpFile[]`	`getFiles(String remote, OutputStream local, long position)` Download the remote files into an OutputStream.
`SftpFile[]`	`getFiles(String remote, String local)` Download the remote files into the local file.
`SftpFile[]`	`getFiles(String remote, String local, boolean resume)` Download the remote files into the local file.
`SftpFile[]`	`getFiles(String remote, String local, FileTransferProgress progress)` Download the remote file to the local computer.
`SftpFile[]`	`getFiles(String remote, String local, FileTransferProgress progress, boolean resume)` make local copies of some of the variables, then call getfilematches, which calls get on each file that matches the regexp remote.
`InputStream`	`getInputStream(String remotefile)` Create an InputStream for reading a remote file.
`protected abstract String`	`getRealPath(String path)`
`int`	`getTransferMode()`
`abstract boolean`	`isClosed()` Returns the state of the SFTP client.
`boolean`	`isDirectoryOrLinkedDirectory(SftpFile file)` Determine whether the file object is pointing to a symbolic link that is pointing to a directory.
`void`	`lcd(String path)` Changes the local working directory.
`String`	`lpwd()` Returns the absolute path to the local working directory.
`SftpFile[]`	`ls()` List the contents of the current remote working directory.
`protected abstract void`	`makeDirectory(String path, SftpFileAttributes attrs)`
`void`	`mkdir(String dir)` Creates a new directory on the remote server.
`void`	`mkdirs(String dir)` Create a directory or set of directories.
`protected abstract void`	`onInit(int maxVersion)`
`protected abstract SftpFileAttributes`	`performDownload(String remote, OutputStream out, FileTransferProgress progress, long position)`
`protected abstract void`	`performUpload(InputStream in, String remotePath, FileTransferProgress progress, long position)`
`void`	`put(InputStream in, String remote)` Upload the contents of an InputStream to the remote computer.
`void`	`put(InputStream in, String remote, FileTransferProgress progress)` Upload a file to the remote computer reading from the specified `InputStream` .
`void`	`put(InputStream in, String remote, FileTransferProgress progress, long position)`
`void`	`put(InputStream in, String remote, long position)` Upload the contents of an InputStream to the remote computer.
`void`	`put(String local)` Upload a file to the remote computer
`void`	`put(String local, boolean resume)` Upload a file to the remote computer
`void`	`put(String local, FileTransferProgress progress)` Upload a file to the remote computer.
`void`	`put(String local, FileTransferProgress progress, boolean resume)` Upload a file to the remote computer.
`void`	`put(String local, String remote)` Upload a file to the remote computer
`void`	`put(String local, String remote, boolean resume)` Upload a file to the remote computer
`void`	`put(String local, String remote, FileTransferProgress progress)` Upload a file to the remote computer.
`void`	`put(String local, String remote, FileTransferProgress progress, boolean resume)` Upload a file to the remote computer.
`void`	`putFiles(InputStream in, String remote)` Upload the contents of an InputStream to the remote computer.
`void`	`putFiles(InputStream in, String remote, FileTransferProgress progress)` Upload files to the remote computer reading from the specified `InputStream` .
`void`	`putFiles(InputStream in, String remote, FileTransferProgress progress, long position)`
`void`	`putFiles(InputStream in, String remote, long position)` Upload the contents of an InputStream to the remote computer.
`void`	`putFiles(String local)` Upload the contents of an InputStream to the remote computer.
`void`	`putFiles(String local, boolean resume)` Upload files to the remote computer
`void`	`putFiles(String local, FileTransferProgress progress)` Upload files to the remote computer
`void`	`putFiles(String local, FileTransferProgress progress, boolean resume)` Upload files to the remote computer
`void`	`putFiles(String local, String remote)` Upload files to the remote computer
`void`	`putFiles(String local, String remote, boolean resume)` Upload files to the remote computer
`void`	`putFiles(String local, String remote, FileTransferProgress progress)` Upload files to the remote computer.
`void`	`putFiles(String local, String remote, FileTransferProgress progress, boolean resume)` make local copies of some of the variables, then call putfilematches, which calls "put" on each file that matches the regexp local.
`String`	`pwd()` Returns the absolute path name of the current remote working directory.
`void`	`quit()` Close the SFTP client.
`void`	`removeCustomRoot(String rootPath)` Remove a custom file system root path such as "flash:"
`protected abstract void`	`removeDirectory(String filename)`
`protected abstract void`	`removeFile(String filename)`
`void`	`rename(String oldpath, String newpath)` Rename a file on the remote computer.
`protected abstract void`	`renameFile(String from, String to)`
`protected String`	`resolveRemotePath(String path)` returns the canonical form of path, if path doesn't start with one of '/';cwd;a customRoot; or is a WindowsRoot then prepend cwd to path
`void`	`rm(String path)` Remove a file or directory from the remote computer.
`void`	`rm(String path, boolean force, boolean recurse)` Remove a file or directory on the remote computer with options to force deletion of existing files and recursion.
`void`	`setRegularExpressionSyntax(int syntax)` sets the type of regular expression matching to perform on gets and puts
`void`	`setRemoteEOL(int eolMode)` When connected to servers running SFTP version 3 (or less) the remote EOL type needs to be explicitly set because there is no reliable way for the client to determine the type of EOL for text files.
`void`	`setTransferMode(int transferMode)` Sets the transfer mode for current operations.
`SftpFileAttributes`	`stat(String path)` Returns the attributes of the file from the remote computer.
`void`	`symlink(String path, String link)` Create a symbolic link on the remote computer.
`int`	`umask(int umask)` Sets the umask used by this client.
`void`	`umask(String umask)` Sets the umask for this client.
`protected void`	`verifyConnection()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.sshtools.sftp.SftpClient
`getDefaultDirectory, getInputStream, getOutputStream, getVersion, ls, setAttributes`

Field Detail

ssh

protected SshClient ssh

umask

protected int umask

Constructor Detail

AbstractSftpClient

protected AbstractSftpClient(SshClient ssh,
                             int maxVersion)
                      throws SshException,
                             ChannelOpenException,
                             SftpStatusException

Throws:: SshException; ChannelOpenException; SftpStatusException

Method Detail

onInit

protected abstract void onInit(int maxVersion)
                        throws SshException,
                               ChannelOpenException,
                               SftpStatusException

Throws:: SshException; ChannelOpenException; SftpStatusException

setTransferMode

public void setTransferMode(int transferMode)

Description copied from interface: SftpClient

Sets the transfer mode for current operations. The valid modes are:

SftpClient.MODE_BINARY - Files are transferred in binary mode and no processing of text files is performed (default mode).

SftpClient.MODE_TEXT - For servers supporting version 4+ of the SFTP protocol files are transferred in text mode. For earlier protocol versions the files are transfered in binary mode but the client performs processing of text; if files are written to the remote server the client ensures that the line endings conform to the remote EOL mode set using SftpClient.setRemoteEOL(int). For files retrieved from the server the EOL policy is based upon System policy as defined by the "line.seperator" system property.

Specified by:: setTransferMode in interface SftpClient

Parameters:: transferMode - int

getCharsetEncoding

public String getCharsetEncoding()

Specified by:: getCharsetEncoding in interface SftpClient

setRemoteEOL

public void setRemoteEOL(int eolMode)

Description copied from interface: SftpClient

When connected to servers running SFTP version 3 (or less) the remote EOL type needs to be explicitly set because there is no reliable way for the client to determine the type of EOL for text files. In versions 4+ a mechanism is provided and this setting is overridden.

Valid values for this method are EOL_CRLF (default), EOL_CR, and EOL_LF.

Specified by:: setRemoteEOL in interface SftpClient

Parameters:: eolMode - int

getTransferMode

public int getTransferMode()

Specified by:: getTransferMode in interface SftpClient

Returns:: int

umask

public int umask(int umask)

Description copied from interface: SftpClient

Sets the umask used by this client.

 To give yourself full permissions for both files and directories and
 prevent the group and other users from having access:
 
   umask(077);
 
 This subtracts 077 from the system defaults for files and directories
 666 and 777. Giving a default access permissions for your files of
 600 (rw-------) and for directories of 700 (rwx------).
 
 To give all access permissions to the group and allow other users read
 and execute permission:
 
   umask(002);
 
 This subtracts 002 from the system defaults to give a default access permission
 for your files of 664 (rw-rw-r--) and for your directories of 775 (rwxrwxr-x).
 
 To give the group and other users all access except write access:
 
   umask(022);
 
 This subtracts 022 from the system defaults to give a default access permission
 for your files of 644 (rw-r--r--) and for your directories of 755 (rwxr-xr-x).

Specified by:: umask in interface SftpClient

Returns:: the previous umask value

getAttributes

protected abstract SftpFileAttributes getAttributes(String file)
                                             throws SftpStatusException,
                                                    SshException

Throws:: SftpStatusException; SshException

cd

public void cd(String dir)
        throws SftpStatusException,
               SshException

Description copied from interface: SftpClient

Changes the working directory on the remote server, or the home directory if null or any empty string is provided as the directory path

Specified by:: cd in interface SftpClient

Parameters:: dir - the new working directory
Throws:: SftpStatusException; SshException

cdup

public void cdup()
          throws SftpStatusException,
                 SshException

Description copied from interface: SftpClient

Change the working directory to the parent directory

Specified by:: cdup in interface SftpClient

Throws:: SftpStatusException; SshException

addCustomRoot

public void addCustomRoot(String rootPath)

Description copied from interface: SftpClient

Add a custom file system root path such as "flash:"

Specified by:: addCustomRoot in interface SftpClient

removeCustomRoot

public void removeCustomRoot(String rootPath)

Description copied from interface: SftpClient

Remove a custom file system root path such as "flash:"

Specified by:: removeCustomRoot in interface SftpClient

resolveRemotePath

protected String resolveRemotePath(String path)
                            throws SftpStatusException

returns the canonical form of path, if path doesn't start with one of '/';cwd;a customRoot; or is a WindowsRoot then prepend cwd to path

Parameters:: path -
Returns:: canonical form of path
Throws:: SftpStatusException

verifyConnection

protected void verifyConnection()
                         throws SftpStatusException

Throws:: SftpStatusException

makeDirectory

protected abstract void makeDirectory(String path,
                                      SftpFileAttributes attrs)
                               throws SftpStatusException,
                                      SshException

Throws:: SftpStatusException; SshException

mkdir

public void mkdir(String dir)
           throws SftpStatusException,
                  SshException

Description copied from interface: SftpClient

Creates a new directory on the remote server. This method will throw an exception if the directory already exists. To create directories and disregard any errors use the mkdirs method.

Specified by:: mkdir in interface SftpClient

Parameters:: dir - the name of the new directory
Throws:: SftpStatusException; SshException

mkdirs

public void mkdirs(String dir)
            throws SftpStatusException,
                   SshException

Description copied from interface: SftpClient

Create a directory or set of directories. This method will not fail even if the directories exist. It is advisable to test whether the directory exists before attempting an operation by using stat to return the directories attributes.

Specified by:: mkdirs in interface SftpClient

Parameters:: dir - the path of directories to create.
Throws:: SftpStatusException; SshException

isDirectoryOrLinkedDirectory

public boolean isDirectoryOrLinkedDirectory(SftpFile file)
                                     throws SftpStatusException,
                                            SshException

Description copied from interface: SftpClient

Determine whether the file object is pointing to a symbolic link that is pointing to a directory.

Specified by:: isDirectoryOrLinkedDirectory in interface SftpClient

Returns:: boolean
Throws:: SftpStatusException; SshException

pwd

public String pwd()

Description copied from interface: SftpClient

Returns the absolute path name of the current remote working directory.

Specified by:: pwd in interface SftpClient

Returns:: the absolute path of the remote working directory.

ls

public SftpFile[] ls()
              throws SftpStatusException,
                     SshException

Description copied from interface: SftpClient

List the contents of the current remote working directory.

Returns a list of SftpFile instances for the current working directory.

Specified by:: ls in interface SftpClient

Returns:: a list of SftpFile for the current working directory
Throws:: SftpStatusException; SshException

lcd

public void lcd(String path)
         throws SftpStatusException

Description copied from interface: SftpClient

Changes the local working directory.

Specified by:: lcd in interface SftpClient

Parameters:: path - the path to the new working directory
Throws:: SftpStatusException

lpwd

public String lpwd()

Description copied from interface: SftpClient

Returns the absolute path to the local working directory.

Specified by:: lpwd in interface SftpClient

Returns:: the absolute path of the local working directory.

get

public SftpFileAttributes get(String path,
                              FileTransferProgress progress)
                       throws FileNotFoundException,
                              SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file to the local computer.

Specified by:: get in interface SftpClient

Parameters:: path - the path to the remote file
Returns:: the downloaded file's attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

get

public SftpFileAttributes get(String path,
                              FileTransferProgress progress,
                              boolean resume)
                       throws FileNotFoundException,
                              SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file to the local computer.

Specified by:: get in interface SftpClient

Parameters:: path - the path to the remote file; resume - attempt to resume a interrupted download
Returns:: the downloaded file's attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

get

public SftpFileAttributes get(String path,
                              boolean resume)
                       throws FileNotFoundException,
                              SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file to the local computer

Specified by:: get in interface SftpClient

Parameters:: path - the path to the remote file; resume - attempt to resume an interrupted download
Returns:: the downloaded file's attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

get

public SftpFileAttributes get(String path)
                       throws FileNotFoundException,
                              SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file to the local computer

Specified by:: get in interface SftpClient

Parameters:: path - the path to the remote file
Returns:: the downloaded file's attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

get

public SftpFileAttributes get(String remote,
                              String local,
                              FileTransferProgress progress)
                       throws FileNotFoundException,
                              SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file to the local computer. If the paths provided are not absolute the current working directory is used.

Specified by:: get in interface SftpClient

Parameters:: remote - the path/name of the remote file; local - the path/name to place the file on the local computer
Returns:: the downloaded file's attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

getCanonicalNewline

protected abstract byte[] getCanonicalNewline()
                                       throws SftpStatusException

Throws:: SftpStatusException

get

public SftpFileAttributes get(String remote,
                              String local,
                              FileTransferProgress progress,
                              boolean resume)
                       throws FileNotFoundException,
                              SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file to the local computer. If the paths provided are not absolute the current working directory is used.

Specified by:: get in interface SftpClient

Parameters:: remote - the path/name of the remote file; local - the path/name to place the file on the local computer; resume - attempt to resume an interrupted download
Returns:: the downloaded file's attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

get

public SftpFileAttributes get(String remote,
                              OutputStream out,
                              FileTransferProgress progress,
                              long position)
                       throws SftpStatusException,
                              TransferCancelledException,
                              SshException

Description copied from interface: SftpClient

Download the remote file writing it to the specified OutputStream. The OutputStream is closed by this method even if the operation fails.

Specified by:: get in interface SftpClient

Parameters:: remote - the path/name of the remote file; out - the OutputStream to write; position - the position within the file to start reading from
Returns:: the downloaded file's attributes
Throws:: SftpStatusException; TransferCancelledException; SshException

performDownload

protected abstract SftpFileAttributes performDownload(String remote,
                                                      OutputStream out,
                                                      FileTransferProgress progress,
                                                      long position)
                                               throws SftpStatusException,
                                                      TransferCancelledException,
                                                      SshException

Throws:: SftpStatusException; TransferCancelledException; SshException

get

public SftpFileAttributes get(String remote,
                              String local,
                              boolean resume)
                       throws FileNotFoundException,
                              SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file into the local file.

Specified by:: get in interface SftpClient

resume - attempt to resume an interrupted download
Returns:: the downloaded file's attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

get

public SftpFileAttributes get(String remote,
                              String local)
                       throws FileNotFoundException,
                              SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file into the local file.

Specified by:: get in interface SftpClient

Returns:: the downloaded file's attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

get

public SftpFileAttributes get(String remote,
                              OutputStream local,
                              FileTransferProgress progress)
                       throws SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file writing it to the specified OutputStream. The OutputStream is closed by this method even if the operation fails.

Specified by:: get in interface SftpClient

Parameters:: remote - the path/name of the remote file; local - the OutputStream to write
Returns:: the downloaded file's attributes
Throws:: SftpStatusException; SshException; TransferCancelledException

getFiles

public SftpFile[] getFiles(String remote,
                           OutputStream local,
                           FileTransferProgress progress,
                           long position)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

make local copies of some of the variables, then call getfilematches, which calls get on each file that matches the regexp remote.

Specified by:: getFiles in interface SftpClient

Returns:: SftpFile[]
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

getFiles

public SftpFile[] getFiles(String remote,
                           String local,
                           FileTransferProgress progress,
                           boolean resume)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

make local copies of some of the variables, then call getfilematches, which calls get on each file that matches the regexp remote.

Specified by:: getFiles in interface SftpClient

Returns:: SftpFile[]
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

setRegularExpressionSyntax

public void setRegularExpressionSyntax(int syntax)

Description copied from interface: SftpClient

sets the type of regular expression matching to perform on gets and puts

Specified by:: setRegularExpressionSyntax in interface SftpClient

Parameters:: syntax - , NoSyntax for no regular expression matching, GlobSyntax for GlobSyntax, Perl5Syntax for Perl5Syntax

getFile

public SftpFile getFile(String path)
                 throws SshException,
                        SftpStatusException

Specified by:: getFile in interface SftpClient

Throws:: SshException; SftpStatusException

getInputStream

public InputStream getInputStream(String remotefile)
                           throws SftpStatusException,
                                  SshException

Description copied from interface: SftpClient

Create an InputStream for reading a remote file.

Specified by:: getInputStream in interface SftpClient

Returns:: InputStream
Throws:: SftpStatusException; SshException

get

public SftpFileAttributes get(String remote,
                              OutputStream local,
                              long position)
                       throws SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file into an OutputStream.

Specified by:: get in interface SftpClient

position - the position from which to start reading the remote file
Returns:: the downloaded file's attributes
Throws:: SftpStatusException; SshException; TransferCancelledException

get

public SftpFileAttributes get(String remote,
                              OutputStream local)
                       throws SftpStatusException,
                              SshException,
                              TransferCancelledException

Description copied from interface: SftpClient

Download the remote file into an OutputStream.

Specified by:: get in interface SftpClient

Returns:: the downloaded file's attributes
Throws:: SftpStatusException; SshException; TransferCancelledException

isClosed

public abstract boolean isClosed()

Description copied from interface: SftpClient

Returns the state of the SFTP client. The client is closed if the underlying session channel is closed. Invoking the quit method of this object will close the underlying session channel.

Specified by:: isClosed in interface SftpClient

Returns:: true if the client is still connected, otherwise false

put

public void put(String local,
                FileTransferProgress progress,
                boolean resume)
         throws FileNotFoundException,
                SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload a file to the remote computer.

Specified by:: put in interface SftpClient

Parameters:: local - the path/name of the local file
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

put

public void put(String local,
                FileTransferProgress progress)
         throws FileNotFoundException,
                SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload a file to the remote computer.

Specified by:: put in interface SftpClient

Parameters:: local - the path/name of the local file
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

put

public void put(String local)
         throws FileNotFoundException,
                SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload a file to the remote computer

Specified by:: put in interface SftpClient

Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

put

public void put(String local,
                boolean resume)
         throws FileNotFoundException,
                SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload a file to the remote computer

Specified by:: put in interface SftpClient

resume - attempt to resume after an interrupted transfer
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

put

public void put(String local,
                String remote,
                FileTransferProgress progress)
         throws FileNotFoundException,
                SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload a file to the remote computer. If the paths provided are not absolute the current working directory is used.

Specified by:: put in interface SftpClient

Parameters:: local - the path/name of the local file; remote - the path/name of the destination file
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

put

public void put(String local,
                String remote,
                FileTransferProgress progress,
                boolean resume)
         throws FileNotFoundException,
                SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload a file to the remote computer. If the paths provided are not absolute the current working directory is used.

Specified by:: put in interface SftpClient

Parameters:: local - the path/name of the local file; remote - the path/name of the destination file; resume - attempt to resume after an interrupted transfer
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

put

public void put(String local,
                String remote,
                boolean resume)
         throws FileNotFoundException,
                SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload a file to the remote computer

Specified by:: put in interface SftpClient

resume - attempt to resume after an interrupted transfer
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

put

public void put(String local,
                String remote)
         throws FileNotFoundException,
                SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload a file to the remote computer

Specified by:: put in interface SftpClient

Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

put

public void put(InputStream in,
                String remote,
                FileTransferProgress progress)
         throws SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload a file to the remote computer reading from the specified InputStream . The InputStream is closed, even if the operation fails.

Specified by:: put in interface SftpClient

Parameters:: in - the InputStream being read; remote - the path/name of the destination file
Throws:: SftpStatusException; SshException; TransferCancelledException

put

public void put(InputStream in,
                String remote,
                FileTransferProgress progress,
                long position)
         throws SftpStatusException,
                SshException,
                TransferCancelledException

Specified by:: put in interface SftpClient

Throws:: SftpStatusException; SshException; TransferCancelledException

performUpload

protected abstract void performUpload(InputStream in,
                                      String remotePath,
                                      FileTransferProgress progress,
                                      long position)
                               throws SftpStatusException,
                                      SshException,
                                      TransferCancelledException

Throws:: SftpStatusException; SshException; TransferCancelledException

put

public void put(InputStream in,
                String remote,
                long position)
         throws SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload the contents of an InputStream to the remote computer.

Specified by:: put in interface SftpClient

Throws:: SftpStatusException; SshException; TransferCancelledException

put

public void put(InputStream in,
                String remote)
         throws SftpStatusException,
                SshException,
                TransferCancelledException

Description copied from interface: SftpClient

Upload the contents of an InputStream to the remote computer.

Specified by:: put in interface SftpClient

Throws:: SftpStatusException; SshException; TransferCancelledException

chown

public void chown(String uid,
                  String path)
           throws SftpStatusException,
                  SshException

Description copied from interface: SftpClient

Sets the user ID to owner for the file or directory.

Specified by:: chown in interface SftpClient

Parameters:: uid - numeric user id of the new owner; path - the path to the remote file/directory
Throws:: SftpStatusException; SshException

changeOwner

protected abstract void changeOwner(String uid,
                                    String path)
                             throws SftpStatusException,
                                    SshException

Throws:: SftpStatusException; SshException

changeGroup

protected abstract void changeGroup(String gid,
                                    String path)
                             throws SftpStatusException,
                                    SshException

Throws:: SftpStatusException; SshException

chgrp

public void chgrp(String gid,
                  String path)
           throws SftpStatusException,
                  SshException

Description copied from interface: SftpClient

Sets the group ID for the file or directory.

Specified by:: chgrp in interface SftpClient

Parameters:: gid - the numeric group id for the new group; path - the path to the remote file/directory
Throws:: SftpStatusException; SshException

changePermissions

protected abstract void changePermissions(String file,
                                          int permissions)
                                   throws SftpStatusException,
                                          SshException

Throws:: SftpStatusException; SshException

chmod

public void chmod(int permissions,
                  String path)
           throws SftpStatusException,
                  SshException

Description copied from interface: SftpClient

Changes the access permissions or modes of the specified file or directory.

Modes determine who can read, change or execute a file.

 Absolute modes are octal numbers specifying the complete list of
 attributes for the files; you specify attributes by OR'ing together
 these bits.
 
 0400       Individual read
 0200       Individual write
 0100       Individual execute (or list directory)
 0040       Group read
 0020       Group write
 0010       Group execute
 0004       Other read
 0002       Other write
 0001       Other execute

Specified by:: chmod in interface SftpClient

Parameters:: permissions - the absolute mode of the file/directory; path - the path to the file/directory on the remote server
Throws:: SftpStatusException; SshException

umask

public void umask(String umask)
           throws SshException

Description copied from interface: SftpClient

Sets the umask for this client.

 To give yourself full permissions for both files and directories and
 prevent the group and other users from having access:
 
   umask("077");
 
 This subtracts 077 from the system defaults for files and directories
 666 and 777. Giving a default access permissions for your files of
 600 (rw-------) and for directories of 700 (rwx------).
 
 To give all access permissions to the group and allow other users read
 and execute permission:
 
   umask("002");
 
 This subtracts 002 from the system defaults to give a default access permission
 for your files of 664 (rw-rw-r--) and for your directories of 775 (rwxrwxr-x).
 
 To give the group and other users all access except write access:
 
   umask("022");
 
 This subtracts 022 from the system defaults to give a default access permission
 for your files of 644 (rw-r--r--) and for your directories of 755 (rwxr-xr-x).

Specified by:: umask in interface SftpClient

Throws:: SshException

renameFile

protected abstract void renameFile(String from,
                                   String to)
                            throws SftpStatusException,
                                   SshException

Throws:: SftpStatusException; SshException

rename

public void rename(String oldpath,
                   String newpath)
            throws SftpStatusException,
                   SshException

Description copied from interface: SftpClient

Rename a file on the remote computer.

Specified by:: rename in interface SftpClient

Parameters:: oldpath - the old path; newpath - the new path
Throws:: SftpStatusException; SshException

removeDirectory

protected abstract void removeDirectory(String filename)
                                 throws SftpStatusException,
                                        SshException

Throws:: SftpStatusException; SshException

removeFile

protected abstract void removeFile(String filename)
                            throws SftpStatusException,
                                   SshException

Throws:: SftpStatusException; SshException

rm

public void rm(String path)
        throws SftpStatusException,
               SshException

Description copied from interface: SftpClient

Remove a file or directory from the remote computer.

Specified by:: rm in interface SftpClient

Parameters:: path - the path of the remote file/directory
Throws:: SftpStatusException; SshException

rm

public void rm(String path,
               boolean force,
               boolean recurse)
        throws SftpStatusException,
               SshException

Description copied from interface: SftpClient

Remove a file or directory on the remote computer with options to force deletion of existing files and recursion.

Specified by:: rm in interface SftpClient

Throws:: SftpStatusException; SshException

createSymbolicLink

protected abstract void createSymbolicLink(String path,
                                           String link)
                                    throws SftpStatusException,
                                           SshException

Throws:: SftpStatusException; SshException

symlink

public void symlink(String path,
                    String link)
             throws SftpStatusException,
                    SshException

Description copied from interface: SftpClient

Create a symbolic link on the remote computer.

Specified by:: symlink in interface SftpClient

Parameters:: path - the path to the existing file; link - the new link
Throws:: SftpStatusException; SshException

stat

public SftpFileAttributes stat(String path)
                        throws SftpStatusException,
                               SshException

Description copied from interface: SftpClient

Returns the attributes of the file from the remote computer.

Specified by:: stat in interface SftpClient

Parameters:: path - the path of the file on the remote computer
Returns:: the attributes
Throws:: SftpStatusException; SshException
See Also:: SftpClient.setAttributes(String, SftpFileAttributes)

getRealPath

protected abstract String getRealPath(String path)
                               throws SftpStatusException,
                                      SshException

Throws:: SftpStatusException; SshException

getAbsolutePath

public String getAbsolutePath(String path)
                       throws SftpStatusException,
                              SshException

Description copied from interface: SftpClient

Get the absolute path for a file.

Specified by:: getAbsolutePath in interface SftpClient

Returns:: String
Throws:: SftpStatusException; SshException

quit

public void quit()
          throws SshException

Description copied from interface: SftpClient

Close the SFTP client.

Specified by:: quit in interface SftpClient

Throws:: SshException

close

protected abstract void close()
                       throws SshIOException,
                              IOException

Throws:: SshIOException; IOException

exit

public void exit()
          throws SshException

Description copied from interface: SftpClient

Close the SFTP client.

Specified by:: exit in interface Client
Specified by:: exit in interface SftpClient

Throws:: SshException

copyLocalDirectory

public DirectoryOperation copyLocalDirectory(String localdir,
                                             String remotedir,
                                             boolean recurse,
                                             boolean sync,
                                             boolean commit,
                                             FileTransferProgress progress)
                                      throws FileNotFoundException,
                                             SftpStatusException,
                                             SshException,
                                             TransferCancelledException

Description copied from interface: SftpClient

Copy the contents of a local directory into a remote remote directory.

Specified by:: copyLocalDirectory in interface SftpClient

Parameters:: localdir - the path to the local directory; remotedir - the remote directory which will receive the contents; recurse - recurse through child folders; sync - synchronize the directories by removing files on the remote server that do not exist locally; commit - actually perform the operation. If false a DirectoryOperation will be returned so that the operation can be evaluated and no actual files will be created/transfered.
Returns:: DirectoryOperation
Throws:: SftpStatusException; SshException; TransferCancelledException; FileNotFoundException

formatLongname

public static String formatLongname(SftpFile file)
                             throws SftpStatusException,
                                    SshException

Format a String with the details of the file.

 -rwxr-xr-x   1 mjos     staff      348911 Mar 25 14:29 t-filexfer

Parameters:: file -
Returns:: String
Throws:: SftpStatusException; SshException

formatLongname

public static String formatLongname(SftpFileAttributes attrs,
                                    String filename)

Format a String with the details of the file.

 -rwxr-xr-x   1 mjos     staff      348911 Mar 25 14:29 t-filexfer

Parameters:: attrs -; filename -
Returns:: String

copyRemoteDirectory

public DirectoryOperation copyRemoteDirectory(String remotedir,
                                              String localdir,
                                              boolean recurse,
                                              boolean sync,
                                              boolean commit,
                                              FileTransferProgress progress)
                                       throws FileNotFoundException,
                                              SftpStatusException,
                                              SshException,
                                              TransferCancelledException

Description copied from interface: SftpClient

Copy the contents of a remote directory to a local directory

Specified by:: copyRemoteDirectory in interface SftpClient

Parameters:: remotedir - the remote directory whose contents will be copied.; localdir - the local directory to where the contents will be copied; recurse - recurse into child folders; sync - synchronized the directories by removing files and directories that do not exist on the remote server.; commit - actually perform the operation. If false the operation will be processed and a DirectoryOperation will be returned without actually transfering any files.
Returns:: DirectoryOperation
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

getFiles

public SftpFile[] getFiles(String remote)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote files to the local computer

When RegExpSyntax is set to NoSyntax the getFiles() methods act identically to the get() methods except for a different return type.

When RegExpSyntax is set to GlobSyntax or Perl5Syntax, getFiles() treats 'remote' as a regular expression, and gets all the files in 'remote''s parent directory that match the pattern. The default parent directory of remote is the remote cwd unless 'remote' contains file seperators(/).

Examples can be found in SftpConnect.java

Code Example:

 //change reg exp syntax from default SftpClient.NoSyntax (no reg exp matching) to SftpClient.GlobSyntax
 sftp.setRegularExpressionSyntax(SftpClient.GlobSyntax);
 //get all .doc files with 'rfc' in their names, in the 'docs/unsorted/' folder relative to the remote cwd, and copy them to the local cwd.
 sftp.getFiles("docs/unsorted/*rfc*.doc");

Specified by:: getFiles in interface SftpClient

Parameters:: remote - the regular expression path to the remote file
Returns:: the downloaded files' attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

getFiles

public SftpFile[] getFiles(String remote,
                           boolean resume)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote files to the local computer

Specified by:: getFiles in interface SftpClient

Parameters:: remote - the regular expression path to the remote file; resume - attempt to resume an interrupted download
Returns:: the downloaded files' attributes
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

getFiles

public SftpFile[] getFiles(String remote,
                           FileTransferProgress progress)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote files to the local computer.

Specified by:: getFiles in interface SftpClient

Parameters:: remote - the regular expression path to the remote file
Returns:: SftpFile[]
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

getFiles

public SftpFile[] getFiles(String remote,
                           FileTransferProgress progress,
                           boolean resume)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote files to the local computer.

Specified by:: getFiles in interface SftpClient

Parameters:: remote - the regular expression path to the remote file; resume - attempt to resume a interrupted download
Returns:: SftpFile[]
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

getFiles

public SftpFile[] getFiles(String remote,
                           OutputStream local)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote files into an OutputStream.

Specified by:: getFiles in interface SftpClient

Returns:: SftpFile[]
Throws:: SftpStatusException; SshException; TransferCancelledException; FileNotFoundException

getFiles

public SftpFile[] getFiles(String remote,
                           OutputStream local,
                           FileTransferProgress progress)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote files writing it to the specified OutputStream. The OutputStream is closed by this mehtod even if the operation fails.

Specified by:: getFiles in interface SftpClient

Parameters:: remote - the regular expression path/name of the remote file; local - the OutputStream to write
Returns:: SftpFile[]
Throws:: SftpStatusException; SshException; TransferCancelledException; FileNotFoundException

getFiles

public SftpFile[] getFiles(String remote,
                           OutputStream local,
                           long position)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote files into an OutputStream.

Specified by:: getFiles in interface SftpClient

position - the position from which to start reading the remote file
Returns:: SftpFile[]
Throws:: SftpStatusException; SshException; TransferCancelledException; FileNotFoundException

getFiles

public SftpFile[] getFiles(String remote,
                           String local)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote files into the local file.

Specified by:: getFiles in interface SftpClient

Returns:: SftpFile[]
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

getFiles

public SftpFile[] getFiles(String remote,
                           String local,
                           boolean resume)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote files into the local file.

Specified by:: getFiles in interface SftpClient

resume - attempt to resume an interrupted download
Returns:: SftpFile[]
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

getFiles

public SftpFile[] getFiles(String remote,
                           String local,
                           FileTransferProgress progress)
                    throws FileNotFoundException,
                           SftpStatusException,
                           SshException,
                           TransferCancelledException

Description copied from interface: SftpClient

Download the remote file to the local computer. If the paths provided are not absolute the current working directory is used.

Specified by:: getFiles in interface SftpClient

Parameters:: remote - the regular expression path/name of the remote files; local - the path/name to place the file on the local computer
Returns:: SftpFile[]
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

putFiles

public void putFiles(InputStream in,
                     String remote)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload the contents of an InputStream to the remote computer.

Specified by:: putFiles in interface SftpClient

Throws:: SftpStatusException; SshException; TransferCancelledException; FileNotFoundException

putFiles

public void putFiles(InputStream in,
                     String remote,
                     FileTransferProgress progress)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload files to the remote computer reading from the specified InputStream . The InputStream is closed, even if the operation fails.

Specified by:: putFiles in interface SftpClient

Parameters:: in - the InputStream being read; remote - the path/name of the destination file
Throws:: SftpStatusException; SshException; TransferCancelledException; FileNotFoundException

putFiles

public void putFiles(InputStream in,
                     String remote,
                     FileTransferProgress progress,
                     long position)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Specified by:: putFiles in interface SftpClient

Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

putFiles

public void putFiles(InputStream in,
                     String remote,
                     long position)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload the contents of an InputStream to the remote computer.

Specified by:: putFiles in interface SftpClient

Throws:: SftpStatusException; SshException; TransferCancelledException; FileNotFoundException

putFiles

public void putFiles(String local)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload the contents of an InputStream to the remote computer.

When RegExpSyntax is set to NoSyntax the putFiles() methods act identically to the put() methods except for a different return type.

When RegExpSyntax is set to GlobSyntax or Perl5Syntax, putFiles() treats 'local' as a regular expression, and gets all the files in 'local''s parent directory that match the pattern. The default parent directory of local is the local cwd unless 'local' contains file seperators.

Examples can be found in SftpConnect.java

Code Example:

 //change reg exp syntax from default SftpClient.NoSyntax (no reg exp matching) to SftpClient.GlobSyntax
 sftp.setRegularExpressionSyntax(SftpClient.GlobSyntax);
 //put all .doc files with 'rfc' in their names, in the 'docs/unsorted/' folder relative to the local cwd, and copy them to the remote cwd.
 sftp.putFiles("docs/unsorted/*rfc*.doc");

Specified by:: putFiles in interface SftpClient

Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

putFiles

public void putFiles(String local,
                     boolean resume)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload files to the remote computer

Specified by:: putFiles in interface SftpClient

resume - attempt to resume after an interrupted transfer
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

putFiles

public void putFiles(String local,
                     FileTransferProgress progress)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload files to the remote computer

Specified by:: putFiles in interface SftpClient

Parameters:: local - the regular expression path/name of the local files
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

putFiles

public void putFiles(String local,
                     FileTransferProgress progress,
                     boolean resume)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload files to the remote computer

Specified by:: putFiles in interface SftpClient

Parameters:: local - the regular expression path/name of the local files
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

putFiles

public void putFiles(String local,
                     String remote)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload files to the remote computer

Specified by:: putFiles in interface SftpClient

Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

putFiles

public void putFiles(String local,
                     String remote,
                     boolean resume)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload files to the remote computer

Specified by:: putFiles in interface SftpClient

resume - attempt to resume after an interrupted transfer
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

putFiles

public void putFiles(String local,
                     String remote,
                     FileTransferProgress progress)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

Upload files to the remote computer. If the paths provided are not absolute the current working directory is used.

Specified by:: putFiles in interface SftpClient

Parameters:: local - the regular expression path/name of the local files; remote - the path/name of the destination file
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

putFiles

public void putFiles(String local,
                     String remote,
                     FileTransferProgress progress,
                     boolean resume)
              throws FileNotFoundException,
                     SftpStatusException,
                     SshException,
                     TransferCancelledException

Description copied from interface: SftpClient

make local copies of some of the variables, then call putfilematches, which calls "put" on each file that matches the regexp local.

Specified by:: putFiles in interface SftpClient

Parameters:: local - the regular expression path/name of the local files; remote - the path/name of the destination file; resume - attempt to resume after an interrupted transfer
Throws:: FileNotFoundException; SftpStatusException; SshException; TransferCancelledException

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sshtools.sftp Class AbstractSftpClient

ssh

umask

AbstractSftpClient

onInit

setTransferMode

getCharsetEncoding

setRemoteEOL

getTransferMode

umask

getAttributes

cd

cdup

addCustomRoot

removeCustomRoot

resolveRemotePath

verifyConnection

makeDirectory

mkdir

mkdirs

isDirectoryOrLinkedDirectory

pwd

ls

lcd

lpwd

get

get

get

get

get

getCanonicalNewline

get

get

performDownload

get

get

get

getFiles

getFiles

setRegularExpressionSyntax

getFile

getInputStream

get

get

isClosed

put

put

put

put

put

put

put

put

put

put

performUpload

put

put

chown

changeOwner

changeGroup

chgrp

changePermissions

chmod

umask

renameFile

rename

removeDirectory

removeFile

rm

rm

createSymbolicLink

symlink

stat

getRealPath

getAbsolutePath

quit

close

exit

copyLocalDirectory

com.sshtools.sftp
Class AbstractSftpClient