|
Secure FTP Factory | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jscape.filetransfer.FtpsTransfer
public class FtpsTransfer
Implements the basic functionality of a FTPS client using explicit SSL.
Example Usage:// create new FtpsTransfer instance FileTransfer ftp = new FtpsTransfer("ftp.myserver.com","anonymous","user@myserver.com"); try { // connect to FTP server ftp.connect(); <p/> // print out directory listing System.out.println(ftp.getDirListingAsString()); <p/> // disconnect from FTP server ftp.disconnect(); } catch(Exception e) { System.out.println(e); }
Field Summary |
---|
Fields inherited from interface com.jscape.filetransfer.FileTransfer |
---|
ASCII, AUTO, BINARY, CURRENT_DIR, UP_DIR |
Constructor Summary | |
---|---|
FtpsTransfer()
Creates FtpsTransfer instance. |
|
FtpsTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd)
Creates FtpsTransfer instance. |
|
FtpsTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd,
java.io.File localDirectory)
Creates FtpsTransfer instance. |
|
FtpsTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd,
int port)
Creates FtpsTransfer instance. |
|
FtpsTransfer(java.lang.String host,
java.lang.String user,
java.lang.String pwd,
java.lang.Integer port)
Method FtpsTransfer |
Method Summary | |
---|---|
void |
abortDownloadThreads()
Abort download threads. |
void |
abortUploadThreads()
Abort upload threads. |
void |
addFileTransferListener(FileTransferListener listener)
See FileTransfer interface for method description. |
void |
addFtpsCertificateVerifier(FtpsCertificateVerifier listener)
Set certificate verifier handle acceptance of SSL certificate. |
void |
changePassword(java.lang.String oldPassword,
java.lang.String newPassword)
Changes the password. |
void |
checksum(java.io.File localFile,
java.lang.String remoteFile)
|
void |
clearCommandChannel()
Clears command channel. |
void |
clearProxySettings()
Clears proxy server values. |
void |
connect()
See FileTransfer interface for method description. |
void |
connect(boolean login)
Establishes a connection with FTP server with optional login |
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)
Download directory. |
boolean |
getAutoDetectIpv6()
Get auto detect Ipv6. |
int |
getBlockTransferSize()
Gets blocksize for use in transferring files. |
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. |
boolean |
getErrorOnSizeCommand()
Gets the error on size command indicator. |
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 remoteFile,
long pos)
Gets InputStream for remote file for reading. |
java.lang.String |
getLocalChecksum(java.io.File localFile)
Returns local checksum. |
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 off,
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. |
int |
getRecursiveDirectoryFileCount(java.lang.String directory)
Get recursive file count. |
long |
getRecursiveDirectorySize(java.lang.String directory)
Get recursive directory size. |
java.lang.String |
getRemoteFileChecksum(java.lang.String remoteFile)
Returns remote file checksum. |
java.util.Vector |
getRemoteFileList(java.lang.String directory)
Get remote file list. |
boolean |
getShutdownCCC()
Gets whether SSL connection should be shutdown after successfully issuing CCC command. |
long |
getTimeout()
See FileTransfer interface for method description. |
boolean |
getUseEPRT()
Gets use EPRT value. |
boolean |
getUseEPSV()
Gets use EPSV value. |
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 |
isFeatureSupported(java.lang.String command)
|
void |
issueCommand(java.lang.String command)
Issues command to the server. |
void |
login()
Logs into FTP server after establishing a connection. |
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 FTP 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.lang.String file,
long offset)
See FileTransfer interface for method description. |
void |
setAscii()
See FileTransfer interface for method description. |
void |
setAuto(boolean auto)
See FileTransfer interface for method description. |
void |
setAutoDetectIpv6(boolean autoDetect)
Set auto detect Ipv6. |
void |
setBinary()
See FileTransfer interface for method description. |
void |
setBlockTransferSize(int blocksize)
Sets block size for use in transferring files. |
void |
setClientCertificates(java.security.KeyStore keystore,
java.lang.String password)
Sets optional client certificate keystore for use during authentication. |
void |
setClientCertificates(java.lang.String filename,
java.lang.String password)
Sets optional client certificate to be used during authentication. |
void |
setClientCertificates(java.lang.String filename,
java.lang.String password,
java.lang.String storetype)
Sets optional client certificate to be used during authentication. |
void |
setCompression(boolean compression)
Sets whether the data will be compressed during the transfering. |
void |
setConnectBeforeCommand(boolean before)
Sets the connectBefore property value |
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 |
setErrorOnSizeCommand(boolean error)
Sets the indicator value which will be used by methods that invokes getFileSize. |
void |
setFileTimestamp(java.lang.String remoteFile,
java.util.Date dateFile)
See FileTransfer interface for method description. |
void |
setHostname(java.lang.String host)
See FileTransfer interface for method description. |
void |
setLocalDir(java.io.File dir)
See FileTransfer interface for method description. |
void |
setNATAddress(java.lang.String ipAddress)
Sets a NAT address which will be used after PASV command. |
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 |
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 |
setServerCertificates(java.security.KeyStore keystore)
Sets optional server certificate keystore to use during authentication. |
void |
setServerCertificates(java.lang.String filename,
java.lang.String password)
Sets optional server certificate to be used during authentication. |
void |
setServerCertificates(java.lang.String filename,
java.lang.String password,
java.lang.String storetype)
Sets optional server certificate to be used during authentication. |
void |
setShutdownCCC(boolean shutdownCCC)
Sets whether SSL connection should be shutdown after successfully issuing CCC command. |
void |
setTimeout(long timeout)
See FileTransfer interface for method description. |
void |
setUseEPRT(boolean useEPRT)
Set use EPRT. |
void |
setUseEPSV(boolean useEPSV)
Sets use EPSV indicator. |
void |
setUseExtendedDirectoryListing(boolean useExtendedDirectoryListing)
Sets the use extended directory listing field. |
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)
Upload directory. |
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 FtpsTransfer() throws FileTransferException
FileTransferException
- FileTransferException instancepublic FtpsTransfer(java.lang.String host, java.lang.String user, java.lang.String pwd) throws FileTransferException
host
- the hostname of FTP serveruser
- the username of FTP userpwd
- the password of FTP user
FileTransferException
public FtpsTransfer(java.lang.String host, java.lang.String user, java.lang.String pwd, int port)
host
- the hostname of FTP serveruser
- the username of FTP userpwd
- the password of FTP userport
- the port of FTP serverpublic FtpsTransfer(java.lang.String host, java.lang.String user, java.lang.String pwd, java.lang.Integer port) throws FileTransferException
host
- user
- pwd
- port
-
FileTransferException
public FtpsTransfer(java.lang.String host, java.lang.String user, java.lang.String pwd, java.io.File localDirectory) throws FileTransferException
host
- the hostname of FTP serveruser
- the username of FTP userpwd
- the password of FTP userlocalDirectory
- the local directory to be used for uploading / downloading
files
FileTransferException
Method Detail |
---|
public void addFtpsCertificateVerifier(FtpsCertificateVerifier listener)
listener
- a FtpsCertificateVerifier
FtpsCertificateVerifier
public void connect() throws FileTransferException
connect
in interface FileTransfer
FileTransferException
- if an I/O or server error occurs.FileTransfer.connect()
public void clearCommandChannel() throws FileTransferException
FileTransferException
public void setCompression(boolean compression)
compression
- When it is true the data will be compressed before it is
sent between the client and the server.public void connect(boolean login) throws FileTransferException
login
- true to login, false otherwise
FileTransferException
public void login() throws FileTransferException
FileTransferException
- if an I/O or FTP error occurspublic void issueCommand(java.lang.String command) throws FileTransferException
command
- a command
FileTransferException
- if an error occurspublic void changePassword(java.lang.String oldPassword, java.lang.String newPassword) throws FileTransferException
oldPassword
- The old password.newPassword
- The new password.
FileTransferException
- FileTransferException if underlayed I/O or FTP error occurs.public void deleteDir(java.lang.String name) throws FileTransferException
deleteDir
in interface FileTransfer
name
- 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 FileTransfer
name
- 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 void deleteFile(java.lang.String remoteFile) throws FileTransferException
deleteFile
in interface FileTransfer
remoteFile
- 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 FileTransfer
FileTransferException
- 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 FileTransfer
out
- 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 FileTransfer
remoteFile
- 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 FileTransfer
localFile
- 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 FileTransfer
remoteDir
- 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 FileTransfer
remoteDir
- the directory to downloadretryLimit
- Retry number when an error occursperformChecksum
- Checksum perform indicator
FtpException
- if an I/O or FTP error occurs.
FileTransferException
- if an I/O or protocol error occurs.public boolean getDebug()
getDebug
in interface FileTransfer
true
if debugging is onFileTransfer.getDebug()
public java.io.PrintStream getDebugStream()
getDebugStream
in interface FileTransfer
PrintStream
used in reporting debug statementsFileTransfer.getDebugStream()
public java.lang.String getDir() throws FileTransferException
getDir
in interface FileTransfer
FileTransferException
- if an I/O or server error occurs.FileTransfer.getDir()
public java.util.Enumeration getDirListing() throws FileTransferException
getDirListing
in interface FileTransfer
Enumeration
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 FileTransfer
filter
- 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 FileTransfer
FileTransferException
- if an I/O or server error occurs.FileTransfer.getDirListingAsString()
public java.lang.String getDirListingAsString(java.lang.String filter) throws FileTransferException
getDirListingAsString
in interface FileTransfer
filter
- a filename filter
FileTransferException
- if an I/O or server error occurs.FileTransfer.getDirListingAsString(String)
public long getFilesize(java.lang.String remoteFile) throws FileTransferException
getFilesize
in interface FileTransfer
remoteFile
- the remote file
FileTransferException
- if an I/O or protocol error occurs.FileTransfer.getFilesize(String)
public java.util.Date getFileTimestamp(java.lang.String remoteFile) throws FileTransferException
getFileTimestamp
in interface FileTransfer
remoteFile
- the remote file
FileTransferException
- if an I/O or server error occurs.FileTransfer.getFileTimestamp(String)
public void setFileTimestamp(java.lang.String remoteFile, java.util.Date dateFile) throws FileTransferException
setFileTimestamp
in interface FileTransfer
remoteFile
- the remote filedateFile
- the new date/timestamp
FileTransferException
- if an I/O or server error occurs.FileTransfer.setFileTimestamp(String,Date)
public java.lang.String getHostname()
getHostname
in interface FileTransfer
FileTransfer.getHostname()
public java.io.File getLocalDir()
getLocalDir
in interface FileTransfer
FileTransfer.getLocalDir()
public java.util.Enumeration getLocalDirListing()
getLocalDirListing
in interface FileTransfer
java.util.Enumeration
of File
FileTransfer.getLocalDirListing()
public int getMode()
getMode
in interface FileTransfer
FileTransfer.getMode()
public java.util.Enumeration getNameListing() throws FileTransferException
getNameListing
in interface FileTransfer
Enumeration
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 FileTransfer
filter
- 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 boolean getPassive()
getPassive
in interface FileTransfer
true
if passive mode is used, false
otherwiseFileTransfer.getPassive()
public java.lang.String getPassword()
getPassword
in interface FileTransfer
FileTransfer.getPassword()
public int getPort()
getPort
in interface FileTransfer
FileTransfer.getPort()
public long getTimeout()
getTimeout
in interface FileTransfer
FileTransfer.getTimeout()
public java.lang.String getUsername()
getUsername
in interface FileTransfer
FileTransfer.getUsername()
public void interrupt()
interrupt
in interface FileTransfer
FileTransfer.interrupt()
public boolean interrupted()
interrupted
in interface FileTransfer
true
if transfer process was interrupted.FileTransfer.interrupted()
public boolean isConnected()
isConnected
in interface FileTransfer
true
if connected false
otherwiseFileTransfer.isConnected()
public void makeDir(java.lang.String name) throws FileTransferException
makeDir
in interface FileTransfer
name
- 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 FileTransfer
name
- full path of directory to make
FileTransferException
- if an I/O or server error occursFileTransfer.makeDirRecursive(String)
public void mdelete(java.lang.String filter) throws FileTransferException
mdelete
in interface FileTransfer
filter
- the regular expression filter to use
FileTransferException
- if an I/O or FTP error occurs.public java.io.File makeLocalDir(java.lang.String name)
makeLocalDir
in interface FileTransfer
name
- name of directory
FileTransfer.makeLocalDir(String)
public void mdownload(java.util.Enumeration fileNames) throws FileTransferException
mdownload
in interface FileTransfer
fileNames
- 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 FileTransfer
filter
- 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 FileTransfer
fileNames
- 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 FileTransfer
filter
- the regular expression to use
FileTransferException
- if an I/O or server error occurs.FileTransfer.mupload(String)
public void renameFile(java.lang.String remoteFile, java.lang.String newFile) throws FileTransferException
renameFile
in interface FileTransfer
remoteFile
- 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 FileTransfer
FileTransfer.reset()
public void resumeDownload(java.lang.String remoteFile, long offset) throws FileTransferException
resumeDownload
in interface FileTransfer
remoteFile
- 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 FileTransfer
localFile
- 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 FileTransfer
file
- 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 FileTransfer
file
- the local file to uploadoffset
- file offset in bytes
FileTransferException
- if an I/O or server error occurs.FileTransfer.resumeUpload(String, long)
public void setAscii() throws FileTransferException
setAscii
in interface FileTransfer
FileTransferException
- if an I/O or server error occurs.FileTransfer.setAscii()
public void setAuto(boolean auto) throws FileTransferException
setAuto
in interface FileTransfer
auto
- true
to turn automatic detect on false
to turn off
FileTransferException
- if an I/O or server error occurs.FileTransfer.setAuto(boolean)
public void setBinary() throws FileTransferException
setBinary
in interface FileTransfer
FileTransferException
- if an I/O or server error occurs.FileTransfer.setBinary()
public void setDebug(boolean debug)
setDebug
in interface FileTransfer
debug
- true
to turn debugging onFileTransfer.setDebug(boolean)
public void setDebugStream(java.io.PrintStream ps)
setDebugStream
in interface FileTransfer
ps
- the PrintStream
to send debug statements toFileTransfer.setDebugStream(PrintStream)
public void setDir(java.lang.String name) throws FileTransferException
setDir
in interface FileTransfer
name
- the remote directory
FileTransferException
- if an I/O or server error occurs.FileTransfer.setDir(String)
public void setDirUp() throws FileTransferException
setDirUp
in interface FileTransfer
FileTransferException
- if an I/O or server error occurs.FileTransfer.setDirUp()
public void setErrorOnSizeCommand(boolean error)
error
- Error indicator valuepublic boolean getErrorOnSizeCommand()
true
then method which invokes getFileSize will throw
an exception when it caused an error, false
the error will be ignored.public void setHostname(java.lang.String host)
setHostname
in interface FileTransfer
host
- the hostname or IP address of serverFileTransfer.setHostname(String)
public void setPort(int port)
setPort
in interface FileTransfer
port
- the portFileTransfer.setPort(int)
public void setLocalDir(java.io.File dir)
setLocalDir
in interface FileTransfer
dir
- the local directoryFileTransfer.setLocalDir(File)
public void setNATAddress(java.lang.String ipAddress) throws FileTransferException
ipAddress
- The NAT IP address.
FtpException
- If an error occurs.
FileTransferException
public void setPassive(boolean passive)
setPassive
in interface FileTransfer
passive
- if true, the transfers will be passive.FileTransfer.setPassive(boolean)
public void setPassword(java.lang.String password)
setPassword
in interface FileTransfer
password
- the passwordFileTransfer.setPassword(String)
public void setClientCertificates(java.security.KeyStore keystore, java.lang.String password) throws FileTransferException
keystore
- the client keystorepassword
- the keystore password
FileTransferException
- if an I/O error occurspublic void setClientCertificates(java.lang.String filename, java.lang.String password) throws FileTransferException
keytool
utility
provided in the Sun JDK.
Example:
keytool.exe -import -file x509.cer -keystore your_store_nameThe example above imports the certificate x509.cer into a keystore named your_store_name
filename
- the keystore file containing the client certificatepassword
- the keystore password
FileTransferException
- if an I/O error occurspublic void setClientCertificates(java.lang.String filename, java.lang.String password, java.lang.String storetype) throws FileTransferException
keytool
utility
provided in the Sun JDK.
Example:
keytool.exe -import -file x509.cer -keystore your_store_nameThe example above imports the certificate x509.cer into a keystore named your_store_name
filename
- the keystore file containing the client certificatepassword
- the keystore passwordstoretype
- the keystore type valid values include jks and pkcs12
FileTransferException
- if an I/O error occurspublic void setServerCertificates(java.security.KeyStore keystore) throws FileTransferException
keystore
- the keystore
FileTransferException
- if an I/O error occurspublic void setServerCertificates(java.lang.String filename, java.lang.String password) throws FileTransferException
keytool
utility
provided in the Sun JDK.
Example:
keytool.exe -import -file x509.cer -keystore your_store_nameThe example above imports the certificate x509.cer into a keystore named your_store_name
filename
- the keystore file containing the server certificatepassword
- the keystore password
FileTransferException
- if an I/O error occurspublic void setServerCertificates(java.lang.String filename, java.lang.String password, java.lang.String storetype) throws FileTransferException
keytool
utility
provided in the Sun JDK.
Example:
keytool.exe -import -file x509.cer -keystore your_store_nameThe example above imports the certificate x509.cer into a keystore named your_store_name
filename
- the keystore file containing the server certificatepassword
- the keystore passwordstoretype
- the keystore type valid values include jks and pkcs12
FileTransferException
- if an I/O error occurspublic void setTimeout(long timeout)
setTimeout
in interface FileTransfer
timeout
- the timeout in millisecondsFileTransfer.setTimeout(long)
public void setUsername(java.lang.String username)
setUsername
in interface FileTransfer
username
- the usernameFileTransfer.setUsername(String)
public void setUseEPSV(boolean useEPSV)
useEPSV
- The use EPSV valuepublic void setUseEPRT(boolean useEPRT)
useEPRT
- public void setAutoDetectIpv6(boolean autoDetect)
useIpv6
- public void setUseExtendedDirectoryListing(boolean useExtendedDirectoryListing)
useExtendedDirectoryListing
- The use extended directory listing indicator.public boolean getUseEPSV()
true
the passive mode will be sent EPSV commandpublic boolean getUseEPRT()
true
active mode will be sent EPRT commandpublic boolean getAutoDetectIpv6()
true
if auto-detect Ipv6 is set to truepublic void setConnectBeforeCommand(boolean before)
before
- indicates if the connection will be established before send
the command in passive modepublic void setWireEncoding(java.lang.String encoding)
setWireEncoding
in interface FileTransfer
encoding
- the character encoding to be usedpublic java.lang.String getWireEncoding()
getWireEncoding
in interface FileTransfer
public java.lang.String getRemoteFileChecksum(java.lang.String remoteFile) throws FtpException
remoteFile
- remote file
FtpException
- if an error occurspublic java.lang.String getLocalChecksum(java.io.File localFile) throws FtpException
localFile
- File which will be calculate the checksum
FtpException
- if an error occurspublic void upload(byte[] data, java.lang.String name) throws FileTransferException
upload
in interface FileTransfer
data
- 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 FileTransfer
data
- 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 FileTransfer
file
- 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 FileTransfer
file
- 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 FileTransfer
extension
- 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 FileTransfer
file
- 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 FileTransfer
file
- 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 FileTransfer
name
- 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 FileTransfer
name
- 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 FileTransfer
name
- 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 FileTransfer
name
- 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 java.lang.String uploadUnique(java.lang.String fileName) throws FileTransferException
uploadUnique
in interface FileTransfer
fileName
- 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 FileTransfer
file
- 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 FileTransfer
in
- 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 uploadDir(java.io.File localDir) throws FileTransferException
uploadDir
in interface FileTransfer
localDir
- 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 FileTransfer
localDir
- 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) throws FileTransferException
uploadDir
in interface FileTransfer
localDir
- the directory to uploadretryLimit
- Retry number when an error occursperformChecksum
- Checksum perform indicatorextension
- The extension which will be used to upload the files
FtpException
- if an I/O or FTP error occurs.
FileTransferException
- if an I/O or protocol related error occurs.public void addFileTransferListener(FileTransferListener listener)
addFileTransferListener
in interface FileTransfer
listener
- the listener to addFileTransfer.addFileTransferListener(FileTransferListener)
public void removeFileTransferListener(FileTransferListener listener)
removeFileTransferListener
in interface FileTransfer
listener
- the listener to removeFileTransfer.removeFileTransferListener(FileTransferListener)
public java.io.InputStream getInputStream(java.lang.String remoteFile, long pos) throws FileTransferException
FileTransfer
InputStream
for remote file for reading.
getInputStream
in interface FileTransfer
remoteFile
- the remote file to get InputStream
forpos
- 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 FileTransfer
Ftp
,
Ftps
public java.io.OutputStream getOutputStream(java.lang.String fileName, long off, boolean append) throws FileTransferException
FileTransfer
OutputStream
for writing to remote file.
getOutputStream
in interface FileTransfer
fileName
- the remote filenameoff
- 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 void setBlockTransferSize(int blocksize)
setBlockTransferSize
in interface FileTransfer
blocksize
- the blocksize in bytespublic int getBlockTransferSize()
getBlockTransferSize
in interface FileTransfer
public void setShutdownCCC(boolean shutdownCCC)
shutdownCCC
- true
to shutdown, false
otherwisepublic boolean getShutdownCCC()
true
to shutdown, false
otherwisepublic void setProxyAuthentication(java.lang.String proxyUsername, java.lang.String proxyPassword)
setProxyAuthentication
in interface FileTransfer
proxyUsername
- the proxy usernameproxyPassword
- the proxy passwordclearProxySettings()
public void setProxyHost(java.lang.String proxyHostname, int proxyPort)
setProxyHost
in interface FileTransfer
proxyHostname
- 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 FileTransfer
proxyType
- The proxy type. Values allowed: HTTP, SOCKS5public void clearProxySettings()
clearProxySettings
in interface FileTransfer
public boolean isFeatureSupported(java.lang.String command) throws FileTransferException
FileTransferException
public void checksum(java.io.File localFile, java.lang.String remoteFile) throws FileTransferException
FileTransferException
public void abortDownloadThreads()
abortDownloadThreads
in interface FileTransfer
public void abortUploadThreads()
abortUploadThreads
in interface FileTransfer
public void downloadDir(java.lang.String remoteDir, int retryLimit, boolean performChecksum, int threadCount) throws FileTransferException
downloadDir
in interface FileTransfer
remoteDir
- the directory to downloadretryLimit
- retry limit if download failsperformChecksum
- whether or not to perform checksum after download, only supported in FTP/S protocols and not by all FTP serversthreadCount
- the thread count
FileTransferException
- if an I/O or protocol error occurs.public java.util.Vector getRemoteFileList(java.lang.String directory) throws FileTransferException
getRemoteFileList
in interface FileTransfer
FileTransferException
public int getRecursiveDirectoryFileCount(java.lang.String directory)
getRecursiveDirectoryFileCount
in interface FileTransfer
public long getRecursiveDirectorySize(java.lang.String directory)
getRecursiveDirectorySize
in interface FileTransfer
public void uploadDir(java.io.File localDir, int retryLimit, boolean performChecksum, java.lang.String extension, int threadCount) throws FileTransferException
uploadDir
in interface FileTransfer
localDir
- the directory to uploadretryLimit
- retry number when an error occursperformChecksum
- whether or not to perform checksum verificationextension
- the temporary extension which will be used when uploading files or null
to use current extension
FileTransferException
- if an I/O or protocol related error occurs.
|
Secure FTP Factory | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |