Modifier and Type | Field and Description |
---|---|
static int |
EOL_CR
Specifies that the remote server is using \r as its newline convention
when used with
setRemoteEOL(int) |
static int |
EOL_CRLF
Specifies that the remote server is using \r\n as its newline convention
when used with
setRemoteEOL(int) |
static int |
EOL_LF
Specifies that the remote server is using \n as its newline convention
when used with
setRemoteEOL(int) |
static int |
GlobSyntax |
static int |
MODE_BINARY
Instructs the client to use a binary transfer mode when used with
setTransferMode(int) |
static int |
MODE_TEXT
Instructs the client to use a text transfer mode when used with
setTransferMode(int) . |
static int |
NoSyntax
constants for setting the regular expression syntax.
|
static int |
Perl5Syntax |
Constructor and Description |
---|
SftpClient(SshClient ssh) |
SftpClient(SshClient ssh,
int Max_Version)
Constructs the SFTP client with a given channel event listener.
|
SftpClient(SshSession session) |
SftpClient(SshSession session,
int Max_Version) |
Modifier and Type | Method and Description |
---|---|
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 user's default
directory if
null or any empty string is provided as the
directory path. |
void |
cdup()
Change the working directory to the parent directory
|
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.
|
DirectoryOperation |
copyLocalDirectory(String localdir,
String remotedir,
boolean recurse,
boolean sync,
boolean commit,
FileTransferProgress progress)
Copy the contents of a local directory into a 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
|
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 local,
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.
|
String |
getDefaultDirectory()
Get the default directory (or HOME directory)
|
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,
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,
boolean resume)
Download the remote file to the local computer.
|
InputStream |
getInputStream(String remotefile)
Create an InputStream for reading a remote file.
|
InputStream |
getInputStream(String remotefile,
long position)
Create an InputStream for reading a remote file.
|
OutputStream |
getOutputStream(String remotefile)
Create an OutputStream for writing to a remote file.
|
SftpSubsystemChannel |
getSubsystemChannel()
Returns the instance of the SftpSubsystemChannel used by this class
|
int |
getTransferMode() |
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.
|
SftpFile[] |
ls(String path)
List the contents remote directory.
|
SftpFile[] |
matchRemoteFiles(String remote)
Called by getFileMatches() to do regular expression pattern matching on
the files in 'remote''s parent directory.
|
void |
mkdir(String dir)
Creates a new directory on the remote server.
|
void |
mkdirs(String dir)
Create a directory or set of directories.
|
SftpFile |
openFile(String fileName) |
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(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:"
|
void |
rename(String oldpath,
String newpath)
Rename a file on the remote computer.
|
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 |
setBlockSize(int blocksize)
Sets the block size used when transferring files, defaults to the
optimized setting of 32768.
|
void |
setBufferSize(int buffersize)
Set the size of the buffer which is used to read from the local file
system.
|
void |
setMaxAsyncRequests(int asyncRequests)
Set the maximum number of asynchronous requests that are outstanding at
any one time.
|
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.
|
SftpFileAttributes |
statLink(String path)
Returns the attributes of a link on 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.
|
public static final int MODE_BINARY
setTransferMode(int)
public static final int MODE_TEXT
setTransferMode(int)
.public static final int EOL_CRLF
Specifies that the remote server is using \r\n as its newline convention
when used with setRemoteEOL(int)
public static final int EOL_LF
Specifies that the remote server is using \n as its newline convention
when used with setRemoteEOL(int)
public static final int EOL_CR
Specifies that the remote server is using \r as its newline convention
when used with setRemoteEOL(int)
public static final int NoSyntax
public static final int GlobSyntax
public static final int Perl5Syntax
public SftpClient(SshClient ssh) throws SftpStatusException, SshException, ChannelOpenException
public SftpClient(SshSession session) throws SftpStatusException, SshException
SftpStatusException
SshException
public SftpClient(SshSession session, int Max_Version) throws SftpStatusException, SshException
SftpStatusException
SshException
public SftpClient(SshClient ssh, int Max_Version) throws SftpStatusException, SshException, ChannelOpenException
Constructs the SFTP client with a given channel event listener.
ssh
- the SshClient
instanceMax_Version
- the maximum SFTP protocol version to useSftpStatusException
SshException
ChannelOpenException
public void setBlockSize(int blocksize)
blocksize
- public SftpSubsystemChannel getSubsystemChannel()
public void setTransferMode(int transferMode)
Sets the transfer mode for current operations. The valid modes are:
MODE_BINARY
- Files are transferred in binary mode and no
processing of text files is performed (default mode).
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
setRemoteEOL(int)
. For files retrieved from the server the EOL
policy is based upon System policy as defined by the "line.seperator"
system property.
transferMode
- intpublic 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. 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
.
eolMode
- intpublic int getTransferMode()
public void setBufferSize(int buffersize)
buffersize
- public void setMaxAsyncRequests(int asyncRequests)
asyncRequests
- public int umask(int umask)
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).
umask
- public SftpFile openFile(String fileName) throws SftpStatusException, SshException
SftpStatusException
SshException
public void cd(String dir) throws SftpStatusException, SshException
Changes the working directory on the remote server, or the user's default
directory if null
or any empty string is provided as the
directory path. The user's default directory is typically their home
directory but is dependent upon server implementation.
dir
- the new working directoryIOException
- if an IO error occurs or the file does not existSftpStatusException
SshException
public String getDefaultDirectory() throws SftpStatusException, SshException
Get the default directory (or HOME directory)
SftpStatusException
SshException
public void cdup() throws SftpStatusException, SshException
SftpStatusException
SshException
public void addCustomRoot(String rootPath)
rootPath
- public void removeCustomRoot(String rootPath)
rootPath
- public void mkdir(String dir) throws SftpStatusException, SshException
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.
dir
- the name of the new directorySftpStatusException
SshException
public void mkdirs(String dir) throws SftpStatusException, SshException
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.
dir
- the path of directories to create.SftpStatusException
SshException
public boolean isDirectoryOrLinkedDirectory(SftpFile file) throws SftpStatusException, SshException
SftpStatusException
SshException
public String pwd()
Returns the absolute path name of the current remote working directory.
public SftpFile[] ls() throws SftpStatusException, SshException
List the contents of the current remote working directory.
Returns a list of SftpFile instances for the current working directory.
SftpStatusException
SshException
public SftpFile[] ls(String path) throws SftpStatusException, SshException
List the contents remote directory.
Returns a list of SftpFile instances for the remote directory.
path
- the path on the remote server to listSftpStatusException
SshException
public void lcd(String path) throws SftpStatusException
Changes the local working directory.
path
- the path to the new working directorySftpStatusException
public String lpwd()
Returns the absolute path to the local working directory.
public SftpFileAttributes get(String path, FileTransferProgress progress) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote file to the local computer.
path
- the path to the remote fileprogress
- FileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFileAttributes get(String path, FileTransferProgress progress, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote file to the local computer.
path
- the path to the remote fileprogress
- resume
- attempt to resume a interrupted downloadFileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFileAttributes get(String path, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote file to the local computer
path
- the path to the remote fileresume
- attempt to resume an interrupted downloadFileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFileAttributes get(String path) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote file to the local computer
path
- the path to the remote fileFileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFileAttributes get(String remote, String local, FileTransferProgress progress) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote file to the local computer. If the paths provided are not absolute the current working directory is used.
remote
- the path/name of the remote filelocal
- the path/name to place the file on the local computerprogress
- SftpStatusException
FileNotFoundException
SshException
TransferCancelledException
public SftpFileAttributes get(String remote, String local, FileTransferProgress progress, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote file to the local computer. If the paths provided are not absolute the current working directory is used.
remote
- the path/name of the remote filelocal
- the path/name to place the file on the local computerprogress
- resume
- attempt to resume an interrupted downloadSftpStatusException
FileNotFoundException
SshException
TransferCancelledException
public SftpFileAttributes get(String remote, String local, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
remote
- local
- resume
- attempt to resume an interrupted downloadFileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFileAttributes get(String remote, String local) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
remote
- local
- FileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFileAttributes get(String remote, OutputStream local, FileTransferProgress progress) throws SftpStatusException, SshException, TransferCancelledException
Download the remote file writing it to the specified
OutputStream
. The OutputStream is closed by this method even
if the operation fails.
remote
- the path/name of the remote filelocal
- the OutputStream to writeprogress
- SftpStatusException
SshException
TransferCancelledException
public void setRegularExpressionSyntax(int syntax)
syntax
- , NoSyntax for no regular expression matching, GlobSyntax for
GlobSyntax, Perl5Syntax for Perl5Syntaxpublic SftpFile[] matchRemoteFiles(String remote) throws SftpStatusException, SshException
remote
- SftpStatusException
SshException
public SftpFileAttributes get(String remote, OutputStream local, FileTransferProgress progress, long position) throws SftpStatusException, SshException, TransferCancelledException
Download the remote file writing it to the specified
OutputStream
. The OutputStream is closed by this method even
if the operation fails.
remote
- the path/name of the remote filelocal
- the OutputStream to writeprogress
- position
- the position within the file to start reading fromSftpStatusException
SshException
TransferCancelledException
public InputStream getInputStream(String remotefile, long position) throws SftpStatusException, SshException
remotefile
- position
- SftpStatusException
SshException
public InputStream getInputStream(String remotefile) throws SftpStatusException, SshException
remotefile
- SftpStatusException
SshException
public SftpFileAttributes get(String remote, OutputStream local, long position) throws SftpStatusException, SshException, TransferCancelledException
remote
- local
- position
- the position from which to start reading the remote fileSftpStatusException
SshException
TransferCancelledException
public SftpFileAttributes get(String remote, OutputStream local) throws SftpStatusException, SshException, TransferCancelledException
remote
- local
- SftpStatusException
SshException
TransferCancelledException
public boolean isClosed()
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.
public void put(String local, FileTransferProgress progress, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Upload a file to the remote computer.
local
- the path/name of the local fileprogress
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void put(String local, FileTransferProgress progress) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Upload a file to the remote computer.
local
- the path/name of the local fileprogress
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void put(String local) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
local
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void put(String local, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
local
- resume
- attempt to resume after an interrupted transferSftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void put(String local, String remote, FileTransferProgress progress) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Upload a file to the remote computer. If the paths provided are not absolute the current working directory is used.
local
- the path/name of the local fileremote
- the path/name of the destination fileprogress
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void put(String local, String remote, FileTransferProgress progress, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Upload a file to the remote computer. If the paths provided are not absolute the current working directory is used.
local
- the path/name of the local fileremote
- the path/name of the destination fileprogress
- resume
- attempt to resume after an interrupted transferSftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void put(String local, String remote, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
local
- remote
- resume
- attempt to resume after an interrupted transferSftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void put(String local, String remote) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
local
- remote
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void put(InputStream in, String remote, FileTransferProgress progress) throws SftpStatusException, SshException, TransferCancelledException
Upload a file to the remote computer reading from the specified
InputStream
. The InputStream is closed, even if the operation
fails.
in
- the InputStream being readremote
- the path/name of the destination fileprogress
- SftpStatusException
SshException
TransferCancelledException
public void put(InputStream in, String remote, FileTransferProgress progress, long position) throws SftpStatusException, SshException, TransferCancelledException
public OutputStream getOutputStream(String remotefile) throws SftpStatusException, SshException
remotefile
- SftpStatusException
SshException
public void put(InputStream in, String remote, long position) throws SftpStatusException, SshException, TransferCancelledException
in
- remote
- position
- SftpStatusException
SshException
TransferCancelledException
public void put(InputStream in, String remote) throws SftpStatusException, SshException, TransferCancelledException
in
- remote
- SftpStatusException
SshException
TransferCancelledException
public void chown(String uid, String path) throws SftpStatusException, SshException
Sets the user ID to owner for the file or directory.
uid
- numeric user id of the new ownerpath
- the path to the remote file/directorySftpStatusException
SshException
TransferCancelledException
public void chgrp(String gid, String path) throws SftpStatusException, SshException
Sets the group ID for the file or directory.
gid
- the numeric group id for the new grouppath
- the path to the remote file/directorySftpStatusException
SshException
public void chmod(int permissions, String path) throws SftpStatusException, SshException
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
permissions
- the absolute mode of the file/directorypath
- the path to the file/directory on the remote serverSftpStatusException
SshException
public void umask(String umask) throws SshException
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).
umask
- SshException
public void rename(String oldpath, String newpath) throws SftpStatusException, SshException
Rename a file on the remote computer.
oldpath
- the old pathnewpath
- the new pathSftpStatusException
SshException
public void rm(String path) throws SftpStatusException, SshException
Remove a file or directory from the remote computer.
path
- the path of the remote file/directorySftpStatusException
SshException
public void rm(String path, boolean force, boolean recurse) throws SftpStatusException, SshException
path
- force
- recurse
- SftpStatusException
SshException
public void symlink(String path, String link) throws SftpStatusException, SshException
Create a symbolic link on the remote computer.
path
- the path to the existing filelink
- the new linkSftpStatusException
SshException
public SftpFileAttributes stat(String path) throws SftpStatusException, SshException
Returns the attributes of the file from the remote computer.
path
- the path of the file on the remote computerSftpStatusException
SshException
public SftpFileAttributes statLink(String path) throws SftpStatusException, SshException
Returns the attributes of a link on the remote computer.
path
- the path of the file on the remote computerSftpStatusException
SshException
public String getAbsolutePath(String path) throws SftpStatusException, SshException
path
- SftpStatusException
SshException
public void quit() throws SshException
Close the SFTP client.
SshException
public void exit() throws SshException
Close the SFTP client.
exit
in interface Client
SshException
public DirectoryOperation copyLocalDirectory(String localdir, String remotedir, boolean recurse, boolean sync, boolean commit, FileTransferProgress progress) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
localdir
- the path to the local directoryremotedir
- the remote directory which will receive the contentsrecurse
- recurse through child folderssync
- synchronize the directories by removing files on the remote
server that do not exist locallycommit
- 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.progress
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public static String formatLongname(SftpFile file) throws SftpStatusException, SshException
-rwxr-xr-x 1 mjos staff 348911 Mar 25 14:29 t-filexfer
file
- SftpStatusException
SshException
public static String formatLongname(SftpFileAttributes attrs, String filename)
-rwxr-xr-x 1 mjos staff 348911 Mar 25 14:29 t-filexfer
attrs
- filename
- public DirectoryOperation copyRemoteDirectory(String remotedir, String localdir, boolean recurse, boolean sync, boolean commit, FileTransferProgress progress) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
remotedir
- the remote directory whose contents will be copied.localdir
- the local directory to where the contents will be copiedrecurse
- recurse into child folderssync
- 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.progress
- FileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFile[] getFiles(String remote) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
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");
remote
- the regular expression path to the remote fileFileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFile[] getFiles(String remote, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote files to the local computer
remote
- the regular expression path to the remote fileresume
- attempt to resume an interrupted downloadFileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFile[] getFiles(String remote, FileTransferProgress progress) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote files to the local computer.
remote
- the regular expression path to the remote fileprogress
- FileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFile[] getFiles(String remote, FileTransferProgress progress, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote files to the local computer.
remote
- the regular expression path to the remote fileprogress
- resume
- attempt to resume a interrupted downloadFileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFile[] getFiles(String remote, String local) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
remote
- local
- FileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFile[] getFiles(String remote, String local, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
remote
- local
- resume
- attempt to resume an interrupted downloadFileNotFoundException
SftpStatusException
SshException
TransferCancelledException
public SftpFile[] getFiles(String remote, String local, FileTransferProgress progress, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Download the remote file to the local computer. If the paths provided are not absolute the current working directory is used.
remote
- the regular expression path/name of the remote fileslocal
- the path/name to place the file on the local computerprogress
- SftpStatusException
FileNotFoundException
SshException
TransferCancelledException
public void putFiles(String local) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
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");
local
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void putFiles(String local, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
local
- resume
- attempt to resume after an interrupted transferSftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void putFiles(String local, FileTransferProgress progress) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Upload files to the remote computer
local
- the regular expression path/name of the local filesprogress
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void putFiles(String local, FileTransferProgress progress, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Upload files to the remote computer
local
- the regular expression path/name of the local filesprogress
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void putFiles(String local, String remote) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
local
- remote
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void putFiles(String local, String remote, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
local
- remote
- resume
- attempt to resume after an interrupted transferSftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void putFiles(String local, String remote, FileTransferProgress progress) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
Upload files to the remote computer. If the paths provided are not absolute the current working directory is used.
local
- the regular expression path/name of the local filesremote
- the path/name of the destination fileprogress
- SftpStatusException
SshException
TransferCancelledException
FileNotFoundException
public void putFiles(String local, String remote, FileTransferProgress progress, boolean resume) throws FileNotFoundException, SftpStatusException, SshException, TransferCancelledException
local
- the regular expression path/name of the local filesremote
- the path/name of the destination fileprogress
- resume
- attempt to resume after an interrupted transferSftpStatusException
SshException
TransferCancelledException
FileNotFoundException
Copyright © 2014. All rights reserved.