|
Secure iNet Factory | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.jscape.filetransfer.SftpTransfer
public class SftpTransfer
Implements the basic functionality of a SFTP (FTP over SSH) client.
Example Usage:// connection information String hostname = "10.0.0.1"; String username = "jsmith"; String password = "secret"; // create com.jscape.inet.ssh.util.SshParameters instance SshParameters params = new SshParameters(hostname,username,password); // create SftpTransfer instance FileTransfer ftp = new SftpTransfer(params) // connect to server ftp.connect(); // print directory listing to console System.out.println(ftp.getDirListingAsString()); // disconnect from server sftp.disconnect();
| Field Summary |
|---|
| Fields inherited from interface com.jscape.filetransfer.FileTransfer |
|---|
ASCII, AUTO, BINARY, CURRENT_DIR, UP_DIR |
| Constructor Summary | |
|---|---|
SftpTransfer(SshParameters parameters)
Creates SftpTransfer instance. |
|
SftpTransfer(SshParameters parameters,
SftpConfiguration configuration)
Creates SftpTransfer instance. |
|
SftpTransfer(SshParameters parameters,
SftpConfiguration configuration,
java.util.Set<FileTransferListener> listeners)
Creates SftpTransfer instance. |
|
SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd)
Creates SftpTransfer instance. |
|
SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd,
java.io.File privateKey)
Creates SftpTransfer instance. |
|
SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String password,
int port)
Creates SftpTransfer instance. |
|
SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd,
java.lang.Integer port)
Creates SftpTransfer instance. |
|
SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd,
int port,
SftpConfiguration configuration)
Creates SftpTransfer instance. |
|
| Method Summary | |
|---|---|
void |
abortDownloadThread(java.lang.String file)
Abort download thread. |
void |
abortDownloadThreads()
Abort all download thrads spawned by Sftp instance. |
void |
abortUploadThread(java.lang.String file)
Abort upload thread. |
void |
abortUploadThreads()
Abort all upload threads spawned by Sftp instance. |
void |
addFileTransferListener(FileTransferListener listener)
See FileTransfer interface for method description. |
void |
clearProxySettings()
Clears proxy server values. |
void |
connect()
See FileTransfer interface for method description. |
FileTransfer |
copy()
Returns a copy of current transfer instance with same listeners. |
void |
deleteDir(java.lang.String name)
See FileTransfer interface for method description. |
void |
deleteDir(java.lang.String name,
boolean recursive)
See FileTransfer interface for method description. |
void |
deleteFile(java.lang.String remoteFile)
See FileTransfer interface for method description. |
void |
disconnect()
See FileTransfer interface for method description. |
void |
download(java.io.OutputStream out,
java.lang.String remoteFile)
See FileTransfer interface for method description. |
java.io.File |
download(java.lang.String remoteFile)
See FileTransfer interface for method description. |
java.io.File |
download(java.lang.String localFile,
java.lang.String remoteFile)
See FileTransfer interface for method description. |
void |
downloadDir(java.lang.String remoteDir)
See FileTransfer interface for method description. |
void |
downloadDir(java.lang.String remoteDir,
int retryLimit,
boolean performChecksum)
Downloads remote directory and contents. |
void |
downloadDir(java.lang.String remoteDir,
int retryLimit,
boolean performChecksum,
int threadCount)
Downloads remote directory and contents. |
boolean |
exists(java.lang.String path)
Checks if the specified path exists on the remote server. |
int |
getBlockTransferSize()
Deprecated. see #getUploadBlockSize |
boolean |
getDebug()
See FileTransfer interface for method description. |
java.io.PrintStream |
getDebugStream()
See FileTransfer interface for method description. |
java.lang.String |
getDir()
See FileTransfer interface for method description. |
java.util.Enumeration |
getDirListing()
See FileTransfer interface for method description. |
java.util.Enumeration |
getDirListing(java.lang.String filter)
See FileTransfer interface for method description. |
java.lang.String |
getDirListingAsString()
See FileTransfer interface for method description. |
java.lang.String |
getDirListingAsString(java.lang.String filter)
See FileTransfer interface for method description. |
int |
getDownloadBlockSize()
Obtains the current download buffer size. |
long |
getFilesize(java.lang.String remoteFile)
See FileTransfer interface for method description. |
java.util.Date |
getFileTimestamp(java.lang.String remoteFile)
See FileTransfer interface for method description. |
java.lang.String |
getHostname()
See FileTransfer interface for method description. |
java.lang.Object |
getImplementation()
See FileTransfer interface for method description. |
java.io.InputStream |
getInputStream(java.lang.String filename,
long offset)
Get input stream. |
java.io.File |
getLocalDir()
See FileTransfer interface for method description. |
java.util.Enumeration |
getLocalDirListing()
See FileTransfer interface for method description. |
int |
getMode()
See FileTransfer interface for method description. |
java.util.Enumeration |
getNameListing()
See FileTransfer interface for method description. |
java.util.Enumeration |
getNameListing(java.lang.String filter)
See FileTransfer interface for method description. |
java.io.OutputStream |
getOutputStream(java.lang.String filename,
long offset,
boolean append)
Gets OutputStream for writing to remote file. |
boolean |
getPassive()
See FileTransfer interface for method description. |
java.lang.String |
getPassword()
See FileTransfer interface for method description. |
int |
getPort()
See FileTransfer interface for method description. |
java.io.File |
getPrivateKey()
Returns SSH private key used for session |
int |
getRecursiveDirectoryFileCount(java.lang.String directory)
Get recursive directory file count. |
long |
getRecursiveDirectorySize(java.lang.String directory)
Get recursive size of all files in directory. |
java.util.Vector |
getRemoteFileList(java.lang.String directory)
Get remote file list. |
long |
getTimeout()
See FileTransfer interface for method description. |
int |
getUploadBlockSize()
Obtains the current upload buffer size. |
java.lang.String |
getUsername()
See FileTransfer interface for method description. |
java.lang.String |
getWireEncoding()
Gets encoding set used when issuing commands and transferring files |
void |
interrupt()
See FileTransfer interface for method description. |
boolean |
interrupted()
See FileTransfer interface for method description. |
boolean |
isConnected()
See FileTransfer interface for method description. |
boolean |
isValidPath(java.lang.String path)
See FileTransfer interface for method description. |
void |
makeDir(java.lang.String name)
See FileTransfer interface for method description. |
void |
makeDirRecursive(java.lang.String name)
See FileTransfer interface for method description. |
java.io.File |
makeLocalDir(java.lang.String name)
See FileTransfer interface for method description. |
void |
mdelete(java.lang.String filter)
Deletes multiple files matching filter to SFTP server's current directory. |
void |
mdownload(java.util.Enumeration fileNames)
See FileTransfer interface for method description. |
void |
mdownload(java.lang.String filter)
See FileTransfer interface for method description. |
void |
mupload(java.util.Enumeration fileNames)
See FileTransfer interface for method description. |
void |
mupload(java.lang.String filter)
See FileTransfer interface for method description. |
void |
removeFileTransferListener(FileTransferListener listener)
See FileTransfer interface for method description. |
void |
renameFile(java.lang.String remoteFile,
java.lang.String newFile)
See FileTransfer interface for method description. |
void |
reset()
See FileTransfer interface for method description. |
void |
resumeDownload(java.lang.String remoteFile,
long offset)
See FileTransfer interface for method description. |
void |
resumeDownload(java.lang.String localFile,
java.lang.String remoteFile,
long offset)
See FileTransfer interface for method description. |
void |
resumeUpload(java.io.File file,
long offset)
See FileTransfer interface for method description. |
void |
resumeUpload(java.io.File localFile,
java.lang.String remoteFile,
long off)
Resume upload of file to server. |
void |
resumeUpload(java.lang.String file,
long offset)
See FileTransfer interface for method description. |
boolean |
sameChecksum(java.io.File localFile,
java.lang.String remoteFile)
Checks a checksum equality of local and remote files. |
void |
setAscii()
Sets data transfer mode to ASCII. |
void |
setAuto(boolean auto)
See FileTransfer interface for method description. |
void |
setBinary()
See FileTransfer interface for method description. |
void |
setBlockTransferSize(int blocksize)
Deprecated. see #setUploadBlockSize |
void |
setDebug(boolean debug)
See FileTransfer interface for method description. |
void |
setDebugStream(java.io.PrintStream ps)
See FileTransfer interface for method description. |
void |
setDir(java.lang.String name)
See FileTransfer interface for method description. |
void |
setDirUp()
See FileTransfer interface for method description. |
void |
setDownloadBlockSize(int blockSize)
Sets the transfer buffer size for download operation. |
void |
setFileModificationTime(java.lang.String remoteFile,
java.util.Date modificationTime)
Set modification time. |
void |
setFileTimestamp(java.lang.String remoteFile,
java.util.Date timestamp)
See FileTransfer interface for method description. |
void |
setHostname(java.lang.String host)
See FileTransfer interface for method description. |
void |
setLineTerminator(java.lang.String lineTerminator)
Sets the line terminator for transfer mode ASCII. |
void |
setLocalDir(java.io.File dir)
See FileTransfer interface for method description. |
void |
setPassive(boolean passive)
See FileTransfer interface for method description. |
void |
setPassword(java.lang.String password)
See FileTransfer interface for method description. |
void |
setPort(int port)
See FileTransfer interface for method description. |
void |
setPreserveFileDownloadTimestamp(boolean value)
Set preserve file download timestamps. |
void |
setPreserveFileUploadTimestamp(boolean value)
Get preserve file upload timestamps. |
void |
setProxyAuthentication(java.lang.String proxyUsername,
java.lang.String proxyPassword)
Sets the proxy authentication username and password to use with proxy server. |
void |
setProxyHost(java.lang.String proxyHostname,
int proxyPort)
Sets the proxy hostname and port for this connection. |
void |
setProxyType(java.lang.String proxyType)
Sets the proxy type will be used for this connection. |
void |
setTimeout(long timeout)
See FileTransfer interface for method description. |
void |
setTimeZone(java.util.TimeZone timeZone)
Set the timezone, used for preserving timestamps. |
void |
setUploadBlockSize(int blockSize)
Sets the transfer buffer size for upload operation. |
void |
setUsername(java.lang.String username)
See FileTransfer interface for method description. |
void |
setWireEncoding(java.lang.String encoding)
Sets encoding set used when issuing commands and transferring files. |
void |
upload(byte[] data,
java.lang.String name)
See FileTransfer interface for method description. |
void |
upload(byte[] data,
java.lang.String name,
boolean append)
See FileTransfer interface for method description. |
void |
upload(java.io.File file)
See FileTransfer interface for method description. |
void |
upload(java.io.File file,
boolean append)
See FileTransfer interface for method description. |
void |
upload(java.io.File file,
java.lang.String remoteName)
See FileTransfer interface for method description. |
void |
upload(java.io.File file,
java.lang.String remoteName,
boolean append)
See FileTransfer interface for method description. |
void |
upload(java.lang.String name)
See FileTransfer interface for method description. |
void |
upload(java.lang.String name,
boolean append)
See FileTransfer interface for method description. |
void |
upload(java.lang.String extension,
java.io.File file)
Uploads a file to server with the extension specified by the argument. |
void |
upload(java.lang.String name,
java.lang.String remoteName)
See FileTransfer interface for method description. |
void |
upload(java.lang.String name,
java.lang.String remoteName,
boolean append)
See FileTransfer interface for method description. |
void |
uploadDir(java.io.File localDir)
See FileTransfer interface for method description. |
void |
uploadDir(java.io.File localDir,
int retryLimit,
boolean performChecksum,
java.lang.String extension)
Uploads local directory and contents. |
void |
uploadDir(java.io.File localDir,
int retryLimit,
boolean performChecksum,
java.lang.String extension,
int threadCount)
Uploads local directory and contents. |
void |
uploadDir(java.io.File localDir,
java.lang.String extension)
Uploads local directory and contents recursively to server. |
java.lang.String |
uploadUnique(java.io.File file)
See FileTransfer interface for method description. |
java.lang.String |
uploadUnique(java.io.InputStream in,
java.lang.String fileName)
See FileTransfer interface for method description. |
java.lang.String |
uploadUnique(java.lang.String fileName)
See FileTransfer interface for method description. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SftpTransfer(SshParameters parameters,
SftpConfiguration configuration,
java.util.Set<FileTransferListener> listeners)
parameters - the connection parametersconfiguration - the configuration
public SftpTransfer(SshParameters parameters,
SftpConfiguration configuration)
parameters - the connection parametersconfiguration - the configurationpublic SftpTransfer(SshParameters parameters)
parameters - Connection parameters for SSH protocol
public SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String password,
int port)
host - the hostname of SSH serveruser - the username of SSH userpassword - the password of SSH userport - the port of SSH server
public SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd)
host - the hostname of SSH serveruser - the username of SSH userpwd - the password of SSH user
public SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd,
java.lang.Integer port)
host - the hostname of SSH serveruser - the username of SSH userpwd - the password of SSH userport - the port of SSH server
public SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd,
java.io.File privateKey)
host - the hostname of SSH serveruser - the username of SSH userpwd - the password of SSH userprivateKey - a private key for session
public SftpTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd,
int port,
SftpConfiguration configuration)
host - the hostname of SSH serveruser - the username of SSH userpwd - the password of SSH userport - the port of SSH serverconfiguration - Sftp configuration instance.| Method Detail |
|---|
public void setAscii()
throws FileTransferException
FileTransfer
setAscii in interface FileTransferFileTransferException - exceptionpublic void setAuto(boolean auto)
setAuto in interface FileTransferauto - true to turn automatic detect on false to turn offFileTransfer.setAuto(boolean)
public void setBinary()
throws FileTransferException
setBinary in interface FileTransferFileTransferException - if an I/O or server error occurs.FileTransfer.setBinary()public void setBlockTransferSize(int blocksize)
setBlockTransferSize in interface FileTransferblocksize - the blocksize in bytespublic int getBlockTransferSize()
getBlockTransferSize in interface FileTransferpublic boolean isConnected()
isConnected in interface FileTransfertrue if connected false otherwiseFileTransfer.isConnected()public void setDebug(boolean debug)
setDebug in interface FileTransferdebug - true to turn debugging onFileTransfer.setDebug(boolean)public boolean getDebug()
getDebug in interface FileTransfertrue if debugging is onFileTransfer.getDebug()public void setDebugStream(java.io.PrintStream ps)
setDebugStream in interface FileTransferps - the PrintStream to send debug statements toFileTransfer.setDebugStream(PrintStream)public java.io.PrintStream getDebugStream()
getDebugStream in interface FileTransferPrintStream used in reporting debug statementsFileTransfer.getDebugStream()
public void setDir(java.lang.String name)
throws FileTransferException
setDir in interface FileTransfername - the remote directory
FileTransferException - if an I/O or server error occurs.FileTransfer.setDir(String)
public java.lang.String getDir()
throws FileTransferException
getDir in interface FileTransferFileTransferException - if an I/O or server error occurs.FileTransfer.getDir()
public java.util.Enumeration getDirListing()
throws FileTransferException
getDirListing in interface FileTransferEnumeration of FileTransferRemoteFile objects
FileTransferException - if an I/O or server error occurs.FileTransfer.getDirListing()
public java.util.Enumeration getDirListing(java.lang.String filter)
throws FileTransferException
getDirListing in interface FileTransferfilter - the filename filter
Enumeration of FileTransferRemoteFile objects
FileTransferException - if an I/O or server error occurs.FileTransfer.getDirListing(String)
public java.lang.String getDirListingAsString()
throws FileTransferException
getDirListingAsString in interface FileTransferFileTransferException - if an I/O or server error occurs.FileTransfer.getDirListingAsString()
public java.lang.String getDirListingAsString(java.lang.String filter)
throws FileTransferException
getDirListingAsString in interface FileTransferfilter - a filename filter
FileTransferException - if an I/O or server error occurs.FileTransfer.getDirListingAsString(String)
public void setDirUp()
throws FileTransferException
setDirUp in interface FileTransferFileTransferException - if an I/O or server error occurs.FileTransfer.setDirUp()public void setDownloadBlockSize(int blockSize)
blockSize - desired buffer sizepublic int getDownloadBlockSize()
public void setFileTimestamp(java.lang.String remoteFile,
java.util.Date timestamp)
throws FileTransferException
setFileTimestamp in interface FileTransferremoteFile - the remote filetimestamp - the new date/timestamp
FileTransferException - if an I/O or server error occurs.FileTransfer.setFileTimestamp(String, Date)
public void setFileModificationTime(java.lang.String remoteFile,
java.util.Date modificationTime)
throws FileTransferException
setFileModificationTime in interface FileTransferremoteFile - - the remote file.modificationTime - - the time.
FileTransferException
public boolean sameChecksum(java.io.File localFile,
java.lang.String remoteFile)
throws FileTransferException
FileTransfer
sameChecksum in interface FileTransferlocalFile - a local fileremoteFile - a remote file
true if checksums are equal; false otherwise
FileTransferException - if an error occurs
public java.util.Date getFileTimestamp(java.lang.String remoteFile)
throws FileTransferException
getFileTimestamp in interface FileTransferremoteFile - the remote file
FileTransferException - if an I/O or server error occurs.FileTransfer.getFileTimestamp(String)
public long getFilesize(java.lang.String remoteFile)
throws FileTransferException
getFilesize in interface FileTransferremoteFile - the remote file
FileTransferException - if an I/O or protocol error occurs.FileTransfer.getFilesize(String)public void setHostname(java.lang.String host)
setHostname in interface FileTransferhost - the hostname or IP address of serverFileTransfer.setHostname(String)public java.lang.String getHostname()
getHostname in interface FileTransferFileTransfer.getHostname()
public java.io.InputStream getInputStream(java.lang.String filename,
long offset)
throws FileTransferException
getInputStream in interface FileTransferfilename - the remote file to get InputStream foroffset - the byte offset, 0 to get full file
InputStream
FileTransferException - if an I/O or protocol related error occurspublic java.lang.Object getImplementation()
getImplementation in interface FileTransferFtp,
Ftpspublic void setLineTerminator(java.lang.String lineTerminator)
lineTerminator - The line terminatorpublic void setLocalDir(java.io.File dir)
setLocalDir in interface FileTransferdir - the local directoryFileTransfer.setLocalDir(File)public java.io.File getLocalDir()
getLocalDir in interface FileTransferFileTransfer.getLocalDir()public void abortDownloadThread(java.lang.String file)
FileTransfer
abortDownloadThread in interface FileTransferpublic void abortUploadThread(java.lang.String file)
FileTransfer
abortUploadThread in interface FileTransferpublic void abortUploadThreads()
abortUploadThreads in interface FileTransferpublic void abortDownloadThreads()
abortDownloadThreads in interface FileTransfer
public java.util.Vector getRemoteFileList(java.lang.String directory)
throws FileTransferException
getRemoteFileList in interface FileTransferFileTransferExceptionpublic long getRecursiveDirectorySize(java.lang.String directory)
getRecursiveDirectorySize in interface FileTransferpublic int getRecursiveDirectoryFileCount(java.lang.String directory)
getRecursiveDirectoryFileCount in interface FileTransferpublic java.util.Enumeration getLocalDirListing()
getLocalDirListing in interface FileTransferjava.util.Enumeration of FileFileTransfer.getLocalDirListing()public int getMode()
getMode in interface FileTransferFileTransfer.getMode()
public java.util.Enumeration getNameListing()
throws FileTransferException
getNameListing in interface FileTransferEnumeration of String where each item represents a file
or directory name
FileTransferException - if an I/O or server related error occursFileTransfer.getNameListing()
public java.util.Enumeration getNameListing(java.lang.String filter)
throws FileTransferException
getNameListing in interface FileTransferfilter - the filename filter
Enumeration of String where each item represents a file
or directory name
FileTransferException - if an I/O or server related error occursFileTransfer.getNameListing(String)
public java.io.OutputStream getOutputStream(java.lang.String filename,
long offset,
boolean append)
throws FileTransferException
FileTransferOutputStream for writing to remote file.
getOutputStream in interface FileTransferfilename - the remote filenameoffset - the byte offset, 0 to write at beginning of fileappend - true to append to remote file, false otherwise
OutputStream
FileTransferException - if an I/O or protocol related error occurspublic FileTransfer copy()
FileTransfer
copy in interface FileTransferpublic void setPassive(boolean passive)
setPassive in interface FileTransferpassive - if true, the transfers will be passive.FileTransfer.setPassive(boolean)public boolean getPassive()
getPassive in interface FileTransfertrue if passive mode is used, false otherwiseFileTransfer.getPassive()public void setPassword(java.lang.String password)
setPassword in interface FileTransferpassword - the passwordFileTransfer.setPassword(String)public java.lang.String getPassword()
getPassword in interface FileTransferFileTransfer.getPassword()public void setPort(int port)
setPort in interface FileTransferport - the portFileTransfer.setPort(int)public int getPort()
getPort in interface FileTransferFileTransfer.getPort()public java.io.File getPrivateKey()
public void setProxyAuthentication(java.lang.String proxyUsername,
java.lang.String proxyPassword)
setProxyAuthentication in interface FileTransferproxyUsername - the proxy usernameproxyPassword - the proxy passwordclearProxySettings()
public void setProxyHost(java.lang.String proxyHostname,
int proxyPort)
setProxyHost in interface FileTransferproxyHostname - the hostname or ip address of the proxy serverproxyPort - the port of the proxy server to connect toclearProxySettings()public void setProxyType(java.lang.String proxyType)
setProxyType in interface FileTransferproxyType - The proxy type. Values allowed: HTTP, SOCKS5public void clearProxySettings()
clearProxySettings in interface FileTransferpublic void setTimeout(long timeout)
setTimeout in interface FileTransfertimeout - the timeout in millisecondsFileTransfer.setTimeout(long)public long getTimeout()
getTimeout in interface FileTransferFileTransfer.getTimeout()public void setUploadBlockSize(int blockSize)
blockSize - desired buffer sizepublic int getUploadBlockSize()
public void setUsername(java.lang.String username)
setUsername in interface FileTransferusername - the usernameFileTransfer.setUsername(String)public java.lang.String getUsername()
getUsername in interface FileTransferFileTransfer.getUsername()
public boolean isValidPath(java.lang.String path)
throws FileTransferException
path - the absolute path to check
FileTransferException - if error occurspublic void setWireEncoding(java.lang.String encoding)
setWireEncoding in interface FileTransferencoding - the character encoding to be usedpublic java.lang.String getWireEncoding()
getWireEncoding in interface FileTransferpublic void addFileTransferListener(FileTransferListener listener)
addFileTransferListener in interface FileTransferlistener - the listener to addFileTransfer.addFileTransferListener(FileTransferListener)
public void connect()
throws FileTransferException
connect in interface FileTransferFileTransferException - if an I/O or server error occurs.FileTransfer.connect()public void setPreserveFileUploadTimestamp(boolean value)
FileTransfer
setPreserveFileUploadTimestamp in interface FileTransferpublic void setPreserveFileDownloadTimestamp(boolean value)
FileTransfer
setPreserveFileDownloadTimestamp in interface FileTransferpublic void setTimeZone(java.util.TimeZone timeZone)
FileTransfer
setTimeZone in interface FileTransfer
public void deleteDir(java.lang.String name)
throws FileTransferException
deleteDir in interface FileTransfername - the directory to remove
FileTransferException - if an I/O or server error occurs.FileTransfer.deleteDir(String)
public void deleteDir(java.lang.String name,
boolean recursive)
throws FileTransferException
deleteDir in interface FileTransfername - the directory to removerecursive - true if it should delete files and subdirectories within directory
FileTransferException - if an I/O or server error occurs.FileTransfer.deleteDir(String, boolean)
public boolean exists(java.lang.String path)
throws FileTransferException
FileTransfer
exists in interface FileTransferpath - a path to verify
true if path exists; false otherwise
FileTransferException - if an error occurs
public void deleteFile(java.lang.String remoteFile)
throws FileTransferException
deleteFile in interface FileTransferremoteFile - name of file to delete
FileTransferException - if an I/O or server error occurs.FileTransfer.deleteFile(String)
public void disconnect()
throws FileTransferException
disconnect in interface FileTransferFileTransferException - if an I/O or server error occurs.FileTransfer.disconnect()
public void download(java.io.OutputStream out,
java.lang.String remoteFile)
throws FileTransferException
download in interface FileTransferout - the OutputStream to write download toremoteFile - remote filename
FileTransferException - if an I/O or server error occurs.FileTransfer.download(OutputStream, String)
public java.io.File download(java.lang.String remoteFile)
throws FileTransferException
download in interface FileTransferremoteFile - the file to download
FileTransferException - if an I/O or server error occurs.FileTransfer.download(String)
public java.io.File download(java.lang.String localFile,
java.lang.String remoteFile)
throws FileTransferException
download in interface FileTransferlocalFile - destination filenameremoteFile - remote filename
FileTransferException - if an I/O or server error occurs.FileTransfer.download(String, String)
public void downloadDir(java.lang.String remoteDir)
throws FileTransferException
downloadDir in interface FileTransferremoteDir - the directory to download
FileTransferException - if an I/O or server error occurs.FileTransfer.downloadDir(String)
public void downloadDir(java.lang.String remoteDir,
int retryLimit,
boolean performChecksum)
throws FileTransferException
downloadDir in interface FileTransferremoteDir - the directory to downloadretryLimit - Retry number when an error occursperformChecksum - Checksum perform indicator
FileTransferException - if an I/O or FTP error occurs.
public void downloadDir(java.lang.String remoteDir,
int retryLimit,
boolean performChecksum,
int threadCount)
throws FileTransferException
downloadDir in interface FileTransferremoteDir - the directory to downloadretryLimit - Retry number when an error occursperformChecksum - Checksum perform indicatorthreadCount - the number of threads to start for download.
FileTransferException - if an I/O or FTP error occurs.public void interrupt()
interrupt in interface FileTransferFileTransfer.interrupt()public boolean interrupted()
interrupted in interface FileTransfertrue if transfer process was interrupted.FileTransfer.interrupted()
public void makeDir(java.lang.String name)
throws FileTransferException
makeDir in interface FileTransfername - name of directory to make
FileTransferException - if an I/O or server error occurs.FileTransfer.makeDir(String)
public void makeDirRecursive(java.lang.String name)
throws FileTransferException
makeDirRecursive in interface FileTransfername - full path of directory to make
FileTransferException - if an I/O or server error occursFileTransfer.makeDirRecursive(String)public java.io.File makeLocalDir(java.lang.String name)
makeLocalDir in interface FileTransfername - name of directory
FileTransfer.makeLocalDir(String)
public void mdelete(java.lang.String filter)
throws FileTransferException
mdelete in interface FileTransferfilter - the regular expression filter to use
FileTransferException - if an I/O or SFTP error occurs.
public void mdownload(java.util.Enumeration fileNames)
throws FileTransferException
mdownload in interface FileTransferfileNames - filenames of files to download
FileTransferException - if an I/O or server error occurs.FileTransfer.mdownload(Enumeration)
public void mdownload(java.lang.String filter)
throws FileTransferException
mdownload in interface FileTransferfilter - the regular expression to use
FileTransferException - if an I/O or server error occurs.FileTransfer.mdownload(String)
public void mupload(java.util.Enumeration fileNames)
throws FileTransferException
mupload in interface FileTransferfileNames - filenames of files to upload
FileTransferException - if an I/O or server error occurs.FileTransfer.mupload(Enumeration)
public void mupload(java.lang.String filter)
throws FileTransferException
mupload in interface FileTransferfilter - the regular expression to use
FileTransferException - if an I/O or server error occurs.FileTransfer.mupload(String)public void removeFileTransferListener(FileTransferListener listener)
removeFileTransferListener in interface FileTransferlistener - the listener to removeFileTransfer.removeFileTransferListener(FileTransferListener)
public void renameFile(java.lang.String remoteFile,
java.lang.String newFile)
throws FileTransferException
renameFile in interface FileTransferremoteFile - name of file to renamenewFile - new name of file
FileTransferException - if an I/O or server error occurs.FileTransfer.renameFile(String, String)public void reset()
reset in interface FileTransferFileTransfer.reset()
public void resumeDownload(java.lang.String remoteFile,
long offset)
throws FileTransferException
resumeDownload in interface FileTransferremoteFile - the file to downloadoffset - file offset in bytes
FileTransferException - if an I/O or server error occurs.FileTransfer.resumeDownload(String, long)
public void resumeDownload(java.lang.String localFile,
java.lang.String remoteFile,
long offset)
throws FileTransferException
resumeDownload in interface FileTransferlocalFile - local file nameremoteFile - the file to downloadoffset - file offset in bytes
FileTransferException - if an I/O or server error occurs.FileTransfer.resumeDownload(String, String, long)
public void resumeUpload(java.io.File file,
long offset)
throws FileTransferException
resumeUpload in interface FileTransferfile - the local file to uploadoffset - file offset in bytes
FileTransferException - if an I/O or server error occurs.FileTransfer.resumeUpload(File, long)
public void resumeUpload(java.lang.String file,
long offset)
throws FileTransferException
resumeUpload in interface FileTransferfile - the local file to uploadoffset - file offset in bytes
FileTransferException - if an I/O or server error occurs.FileTransfer.resumeUpload(String, long)
public void upload(byte[] data,
java.lang.String name)
throws FileTransferException
upload in interface FileTransferdata - the raw contents of the file to uploadname - the filename to store file as on FTP server
FileTransferException - if an I/O or server related error occursFileTransfer.upload(byte[], String)
public void upload(byte[] data,
java.lang.String name,
boolean append)
throws FileTransferException
upload in interface FileTransferdata - the raw contents of the file to uploadname - the filename to store file as on serverappend - true to append to remote file on FTP server, false otherwise
FileTransferException - if an I/O or server related error occursFileTransfer.upload(byte[], String, boolean)
public void upload(java.io.File file)
throws FileTransferException
upload in interface FileTransferfile - the local file to upload
FileTransferException - if an I/O or server related error occursFileTransfer.upload(File)
public void upload(java.io.File file,
boolean append)
throws FileTransferException
upload in interface FileTransferfile - the local file to uploadappend - true to append to remote file on server, false otherwise
FileTransferException - if an I/O or server related error occursFileTransfer.upload(File, boolean)
public void upload(java.lang.String extension,
java.io.File file)
throws FileTransferException
upload in interface FileTransferextension - The extension file will be used to upload the file.file - The file will be uploaded
FileTransferException
public void upload(java.io.File file,
java.lang.String remoteName)
throws FileTransferException
upload in interface FileTransferfile - the local file to uploadremoteName - the destination filename of upload
FileTransferException - if an I/O or server related error occursFileTransfer.upload(File, String)
public void upload(java.io.File file,
java.lang.String remoteName,
boolean append)
throws FileTransferException
upload in interface FileTransferfile - the local file to uploadremoteName - the destination filename of uploadappend - true to append to remote file on server, false otherwise
FileTransferException - if an I/O or server related error occursFileTransfer.upload(File, String, boolean)
public void upload(java.lang.String name)
throws FileTransferException
upload in interface FileTransfername - the local file to upload
FileTransferException - if an I/O or server error occurs.FileTransfer.upload(String)
public void upload(java.lang.String name,
boolean append)
throws FileTransferException
upload in interface FileTransfername - the local file to uploadappend - true to append to remote file on server, false otherwise
FileTransferException - if an I/O or server error occurs.FileTransfer.upload(String, boolean)
public void upload(java.lang.String name,
java.lang.String remoteName)
throws FileTransferException
upload in interface FileTransfername - the local file to uploadremoteName - the destination of upload
FileTransferException - if an I/O or server error occurs.FileTransfer.upload(String, String)
public void upload(java.lang.String name,
java.lang.String remoteName,
boolean append)
throws FileTransferException
upload in interface FileTransfername - the local file to uploadremoteName - the destination of uploadappend - true to append to remote file on FTP server, false otherwise
FileTransferException - if an I/O or server error occurs.FileTransfer.upload(String, String, boolean)
public void uploadDir(java.io.File localDir)
throws FileTransferException
uploadDir in interface FileTransferlocalDir - the directory to upload
FileTransferException - if an I/O or protocol error occurs.FileTransfer.uploadDir(File)
public void uploadDir(java.io.File localDir,
java.lang.String extension)
throws FileTransferException
uploadDir in interface FileTransferlocalDir - the directory to uploadextension - The extension file name used to upload each file
FileTransferException - if an I/O or FTP error occurs.
public void uploadDir(java.io.File localDir,
int retryLimit,
boolean performChecksum,
java.lang.String extension,
int threadCount)
throws FileTransferException
uploadDir in interface FileTransferlocalDir - the directory to uploadretryLimit - Retry number when an error occursperformChecksum - Checksum perform indicatorextension - the extension which will be used to upload the filesthreadCount - the thread count
FileTransferException - if an I/O or FTP error occurs.
public void uploadDir(java.io.File localDir,
int retryLimit,
boolean performChecksum,
java.lang.String extension)
throws FileTransferException
uploadDir in interface FileTransferlocalDir - the directory to uploadretryLimit - Retry number when an error occursperformChecksum - Checksum perform indicatorextension - The extension which will be used to upload the files
FileTransferException - if an I/O or FTP error occurs.
public java.lang.String uploadUnique(java.lang.String fileName)
throws FileTransferException
uploadUnique in interface FileTransferfileName - the file to be uploaded relative to current local directory
FileTransferException - if an I/O or protocol error occurs.FileTransfer.uploadUnique(String)
public java.lang.String uploadUnique(java.io.File file)
throws FileTransferException
uploadUnique in interface FileTransferfile - the file to be uploaded
FileTransferException - if an I/O or protocol error occurs.FileTransfer.uploadUnique(File)
public java.lang.String uploadUnique(java.io.InputStream in,
java.lang.String fileName)
throws FileTransferException
uploadUnique in interface FileTransferin - the InputStream to upload file fromfileName - the filename to be used as seed value for determining unique filename
FileTransferException - if an I/O or protocol error occurs.FileTransfer.uploadUnique(InputStream, String)
public void resumeUpload(java.io.File localFile,
java.lang.String remoteFile,
long off)
throws FileTransferException
FileTransfer
resumeUpload in interface FileTransferFileTransferException
|
Secure iNet Factory | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||