|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.enterprisedt.net.ftp.FTPClient
Supports client-side FTP. Most common FTP operations are present in this class.
Field Summary | |
protected FTPControlSocket |
control
Socket responsible for controlling the connection |
static java.lang.String |
cvsId
Revision control id |
protected FTPDataSocket |
data
Socket responsible for transferring the data |
protected FTPReply |
lastValidReply
Holds the last valid reply from the server on the control socket |
protected FTPMessageListener |
messageListener
Message listener |
Constructor Summary | |
protected |
FTPClient()
Default constructor for use by subclasses |
|
FTPClient(java.net.InetAddress remoteAddr)
Constructor. |
|
FTPClient(java.net.InetAddress remoteAddr,
int controlPort)
Constructor. |
|
FTPClient(java.net.InetAddress remoteAddr,
int controlPort,
int timeout)
Constructor. |
|
FTPClient(java.net.InetAddress remoteAddr,
int controlPort,
int timeout,
java.lang.String encoding)
Constructor. |
|
FTPClient(java.lang.String remoteHost)
Constructor. |
|
FTPClient(java.lang.String remoteHost,
int controlPort)
Constructor. |
|
FTPClient(java.lang.String remoteHost,
int controlPort,
int timeout)
Constructor. |
|
FTPClient(java.lang.String remoteHost,
int controlPort,
int timeout,
java.lang.String encoding)
Constructor. |
Method Summary | |
void |
cancelResume()
Cancel the resume. |
void |
cancelTransfer()
Cancels the current transfer. |
void |
chdir(java.lang.String dir)
Change the remote working directory to that supplied |
protected void |
checkConnection(boolean shouldBeConnected)
Checks if the client has connected to the server and throws an exception if it hasn't. |
static void |
clearSOCKS()
Clear SOCKS settings. |
void |
debugResponses(boolean on)
Deprecated. use the Logger class to switch debugging on and off |
void |
delete(java.lang.String remoteFile)
Delete the specified remote file |
java.lang.String[] |
dir()
List current directory's contents as an array of strings of filenames. |
java.lang.String[] |
dir(java.lang.String dirname)
List a directory's contents as an array of strings of filenames. |
java.lang.String[] |
dir(java.lang.String dirname,
boolean full)
List a directory's contents as an array of strings. |
FTPFile[] |
dirDetails(java.lang.String dirname)
List a directory's contents as an array of FTPFile objects. |
java.lang.String[] |
features()
Get the server supplied features |
void |
get(java.io.OutputStream destStream,
java.lang.String remoteFile)
Get data from the FTP server. |
byte[] |
get(java.lang.String remoteFile)
Get data from the FTP server. |
void |
get(java.lang.String localPath,
java.lang.String remoteFile)
Get data from the FTP server. |
static java.lang.String |
getBuildTimestamp()
Get the build timestamp |
FTPReply |
getLastValidReply()
Gets the latest valid reply from the server |
long |
getMonitorInterval()
Get the bytes transferred between each callback on the progress monitor |
int |
getTransferBufferSize()
Get the size of the buffers used in writing to and reading from the data sockets |
FTPTransferType |
getType()
Get the current transfer type |
static int[] |
getVersion()
Get the version of edtFTPj |
java.lang.String |
help(java.lang.String command)
Get the help text for the specified command |
protected void |
initialize(FTPControlSocket control)
Set the control socket explicitly |
static void |
initSOCKS(java.lang.String port,
java.lang.String host)
Set up SOCKS v4/v5 proxy settings. |
static void |
initSOCKSAuthentication(java.lang.String username,
java.lang.String password)
Set up SOCKS username and password for SOCKS username/password authentication. |
boolean |
isStrictReturnCodes()
Determine if strict checking of return codes is switched on. |
java.lang.String |
list(java.lang.String dirname)
Deprecated. As of FTP 1.1, replaced by dir(String) |
java.lang.String |
list(java.lang.String dirname,
boolean full)
Deprecated. As of FTP 1.1, replaced by dir(String,boolean) |
void |
login(java.lang.String user,
java.lang.String password)
Login into an account on the FTP server. |
void |
mkdir(java.lang.String dir)
Create the specified remote working directory |
java.util.Date |
modtime(java.lang.String remoteFile)
Get modification time for a remote file |
void |
password(java.lang.String password)
Supplies the password for a previously supplied username to log into the FTP server. |
void |
put(byte[] bytes,
java.lang.String remoteFile)
Put data onto the FTP server. |
void |
put(byte[] bytes,
java.lang.String remoteFile,
boolean append)
Put data onto the FTP server. |
void |
put(java.io.InputStream srcStream,
java.lang.String remoteFile)
Put a stream of data onto the FTP server. |
void |
put(java.io.InputStream srcStream,
java.lang.String remoteFile,
boolean append)
Put a stream of data onto the FTP server. |
void |
put(java.lang.String localPath,
java.lang.String remoteFile)
Put a local file onto the FTP server. |
void |
put(java.lang.String localPath,
java.lang.String remoteFile,
boolean append)
Put a local file onto the FTP server. |
java.lang.String |
pwd()
Get the current remote working directory |
void |
quit()
Quit the FTP session |
java.lang.String |
quote(java.lang.String command,
java.lang.String[] validCodes)
Issue arbitrary ftp commands to the FTP server. |
protected int |
readChar(java.io.LineNumberReader in)
Attempts to read a single character from the given InputStream . |
protected int |
readChunk(java.io.BufferedInputStream in,
byte[] chunk,
int chunksize)
Attempts to read a specified number of bytes from the given InputStream and place it in the given byte-array. |
protected java.lang.String |
readLine(java.io.LineNumberReader in)
Attempts to read a single line from the given InputStream . |
void |
rename(java.lang.String from,
java.lang.String to)
Rename a file or directory |
void |
resume()
Make the next file transfer (put or get) resume. |
void |
rmdir(java.lang.String dir)
Delete the specified remote working directory |
void |
setConnectMode(FTPConnectMode mode)
Set the connect mode |
void |
setFTPFileFactory(FTPFileFactory fileFactory)
Override the chosen file factory with a user created one - meaning that a specific parser has been selected |
void |
setMessageListener(FTPMessageListener listener)
Set a listener that handles all FTP messages |
void |
setParserLocale(java.util.Locale locale)
Set the locale for date parsing of dir listings |
void |
setProgressMonitor(FTPProgressMonitor monitor)
Set a progress monitor for callbacks. |
void |
setProgressMonitor(FTPProgressMonitor monitor,
long interval)
Set a progress monitor for callbacks. |
void |
setStrictReturnCodes(boolean strict)
Set strict checking of FTP return codes. |
void |
setTimeout(int millis)
Set the TCP timeout on the underlying socket. |
void |
setTransferBufferSize(int size)
Set the size of the buffers used in writing to and reading from the data sockets |
void |
setType(FTPTransferType type)
Set the transfer type |
boolean |
site(java.lang.String command)
Run a site-specific command on the server. |
long |
size(java.lang.String remoteFile)
Get the size of a remote file. |
java.lang.String |
system()
Get the type of the OS at the server |
void |
user(java.lang.String user)
Supply the user name to log into an account on the FTP server. |
void |
validateTransfer()
Validate that the put() or get() was successful. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static java.lang.String cvsId
protected FTPControlSocket control
protected FTPDataSocket data
protected FTPMessageListener messageListener
protected FTPReply lastValidReply
Constructor Detail |
public FTPClient(java.lang.String remoteHost) throws java.io.IOException, FTPException
remoteHost
- the remote hostnamepublic FTPClient(java.lang.String remoteHost, int controlPort) throws java.io.IOException, FTPException
remoteHost
- the remote hostnamecontrolPort
- port for control stream (-1 for default port)public FTPClient(java.lang.String remoteHost, int controlPort, int timeout) throws java.io.IOException, FTPException
remoteHost
- the remote hostnamecontrolPort
- port for control stream (use -1 for the default port)timeout
- the length of the timeout, in milliseconds
(pass in 0 for no timeout)public FTPClient(java.lang.String remoteHost, int controlPort, int timeout, java.lang.String encoding) throws java.io.IOException, FTPException
remoteHost
- the remote hostnamecontrolPort
- port for control stream (use -1 for the default port)timeout
- the length of the timeout, in milliseconds
(pass in 0 for no timeout)encoding
- character encoding used for datapublic FTPClient(java.net.InetAddress remoteAddr) throws java.io.IOException, FTPException
remoteAddr
- the address of the
remote hostpublic FTPClient(java.net.InetAddress remoteAddr, int controlPort) throws java.io.IOException, FTPException
remoteAddr
- the address of the
remote hostcontrolPort
- port for control streampublic FTPClient(java.net.InetAddress remoteAddr, int controlPort, int timeout) throws java.io.IOException, FTPException
remoteAddr
- the address of the
remote hostcontrolPort
- port for control stream (-1 for default port)timeout
- the length of the timeout, in milliseconds
(pass in 0 for no timeout)public FTPClient(java.net.InetAddress remoteAddr, int controlPort, int timeout, java.lang.String encoding) throws java.io.IOException, FTPException
remoteAddr
- the address of the
remote hostcontrolPort
- port for control stream (-1 for default port)timeout
- the length of the timeout, in milliseconds
(pass in 0 for no timeout)encoding
- character encoding used for dataprotected FTPClient()
Method Detail |
public static int[] getVersion()
public static java.lang.String getBuildTimestamp()
protected void checkConnection(boolean shouldBeConnected) throws FTPException
FTPException
- Thrown if the client has not connected to the server.protected void initialize(FTPControlSocket control)
control
- control socket referencepublic void debugResponses(boolean on)
on
- true if you wish to have responses to
the log stream, false otherwisepublic void setStrictReturnCodes(boolean strict)
strict
- true for strict checking, false for loose checkingpublic boolean isStrictReturnCodes()
public void setTimeout(int millis) throws java.io.IOException
millis
- The length of the timeout, in milliseconds
java.io.IOException
public void setConnectMode(FTPConnectMode mode)
mode
- ACTIVE or PASV modepublic void setMessageListener(FTPMessageListener listener)
listener
- message listenerpublic void setProgressMonitor(FTPProgressMonitor monitor, long interval)
monitor
- the monitor objectinterval
- bytes transferred in between callbackspublic void setProgressMonitor(FTPProgressMonitor monitor)
monitor
- the monitor objectpublic long getMonitorInterval()
public void setTransferBufferSize(int size)
size
- new size of bufferpublic int getTransferBufferSize()
public void cancelTransfer()
public void login(java.lang.String user, java.lang.String password) throws java.io.IOException, FTPException
user
- user namepassword
- user's password
java.io.IOException
FTPException
public void user(java.lang.String user) throws java.io.IOException, FTPException
user
- user name
java.io.IOException
FTPException
public void password(java.lang.String password) throws java.io.IOException, FTPException
password
- The password.
java.io.IOException
FTPException
public static void initSOCKS(java.lang.String port, java.lang.String host)
port
- SOCKS proxy porthost
- SOCKS proxy hostnamepublic static void initSOCKSAuthentication(java.lang.String username, java.lang.String password)
username
- the SOCKS usernamepassword
- the SOCKS passwordpublic static void clearSOCKS()
public java.lang.String quote(java.lang.String command, java.lang.String[] validCodes) throws java.io.IOException, FTPException
command
- ftp command to be sent to servervalidCodes
- valid return codes for this command
java.io.IOException
FTPException
public long size(java.lang.String remoteFile) throws java.io.IOException, FTPException
remoteFile
- name or path of remote file in current directory
java.io.IOException
FTPException
public void resume() throws FTPException
FTPException
public void cancelResume() throws java.io.IOException, FTPException
java.io.IOException
FTPException
public void put(java.lang.String localPath, java.lang.String remoteFile) throws java.io.IOException, FTPException
localPath
- path of the local fileremoteFile
- name of remote file in
current directory
java.io.IOException
FTPException
public void put(java.io.InputStream srcStream, java.lang.String remoteFile) throws java.io.IOException, FTPException
srcStream
- input stream of data to putremoteFile
- name of remote file in
current directory
java.io.IOException
FTPException
public void put(java.lang.String localPath, java.lang.String remoteFile, boolean append) throws java.io.IOException, FTPException
localPath
- path of the local fileremoteFile
- name of remote file in
current directoryappend
- true if appending, false otherwise
java.io.IOException
FTPException
public void put(java.io.InputStream srcStream, java.lang.String remoteFile, boolean append) throws java.io.IOException, FTPException
srcStream
- input stream of data to putremoteFile
- name of remote file in
current directoryappend
- true if appending, false otherwise
java.io.IOException
FTPException
public void validateTransfer() throws java.io.IOException, FTPException
java.io.IOException
FTPException
public void put(byte[] bytes, java.lang.String remoteFile) throws java.io.IOException, FTPException
bytes
- array of bytesremoteFile
- name of remote file in
current directory
java.io.IOException
FTPException
public void put(byte[] bytes, java.lang.String remoteFile, boolean append) throws java.io.IOException, FTPException
bytes
- array of bytesremoteFile
- name of remote file in
current directoryappend
- true if appending, false otherwise
java.io.IOException
FTPException
public void get(java.lang.String localPath, java.lang.String remoteFile) throws java.io.IOException, FTPException
localPath
- local file to put data inremoteFile
- name of remote file in
current directory
java.io.IOException
FTPException
public void get(java.io.OutputStream destStream, java.lang.String remoteFile) throws java.io.IOException, FTPException
destStream
- data stream to write data toremoteFile
- name of remote file in
current directory
java.io.IOException
FTPException
public byte[] get(java.lang.String remoteFile) throws java.io.IOException, FTPException
remoteFile
- name of remote file in
current directory
java.io.IOException
FTPException
public boolean site(java.lang.String command) throws java.io.IOException, FTPException
command
- the site command to run
java.io.IOException
FTPException
public java.lang.String list(java.lang.String dirname) throws java.io.IOException, FTPException
dir(String)
dirname
- the name of the directory (not a file mask)
java.io.IOException
FTPException
public java.lang.String list(java.lang.String dirname, boolean full) throws java.io.IOException, FTPException
dir(String,boolean)
dirname
- the name of the directory(not a file mask)full
- true if detailed listing required
false otherwise
java.io.IOException
FTPException
public void setFTPFileFactory(FTPFileFactory fileFactory)
fileFactory
- public void setParserLocale(java.util.Locale locale)
locale
- new locale to usepublic FTPFile[] dirDetails(java.lang.String dirname) throws java.io.IOException, FTPException, java.text.ParseException
dirname
- name of directory OR filemask
java.io.IOException
FTPException
java.text.ParseException
public java.lang.String[] dir() throws java.io.IOException, FTPException
java.io.IOException
FTPException
public java.lang.String[] dir(java.lang.String dirname) throws java.io.IOException, FTPException
dirname
- name of directory OR filemask
java.io.IOException
FTPException
public java.lang.String[] dir(java.lang.String dirname, boolean full) throws java.io.IOException, FTPException
dirname
- name of directory OR filemaskfull
- true if detailed listing required
false otherwise
java.io.IOException
FTPException
protected int readChunk(java.io.BufferedInputStream in, byte[] chunk, int chunksize) throws java.io.IOException
InputStream
and place it in the given byte-array.
The purpose of this method is to permit subclasses to execute
any additional code necessary when performing this operation.
in
- The InputStream
to read from.chunk
- The byte-array to place read bytes in.chunksize
- Number of bytes to read.
java.io.IOException
- Thrown if there was an error while reading.protected int readChar(java.io.LineNumberReader in) throws java.io.IOException
InputStream
.
The purpose of this method is to permit subclasses to execute
any additional code necessary when performing this operation.
in
- The LineNumberReader
to read from.
java.io.IOException
- Thrown if there was an error while reading.protected java.lang.String readLine(java.io.LineNumberReader in) throws java.io.IOException
InputStream
.
The purpose of this method is to permit subclasses to execute
any additional code necessary when performing this operation.
in
- The LineNumberReader
to read from.
java.io.IOException
- Thrown if there was an error while reading.public FTPReply getLastValidReply()
public FTPTransferType getType()
public void setType(FTPTransferType type) throws java.io.IOException, FTPException
type
- the transfer type to
set the server to
java.io.IOException
FTPException
public void delete(java.lang.String remoteFile) throws java.io.IOException, FTPException
remoteFile
- name of remote file to
delete
java.io.IOException
FTPException
public void rename(java.lang.String from, java.lang.String to) throws java.io.IOException, FTPException
from
- name of file or directory to renameto
- intended name
java.io.IOException
FTPException
public void rmdir(java.lang.String dir) throws java.io.IOException, FTPException
dir
- name of remote directory to
delete
java.io.IOException
FTPException
public void mkdir(java.lang.String dir) throws java.io.IOException, FTPException
dir
- name of remote directory to
create
java.io.IOException
FTPException
public void chdir(java.lang.String dir) throws java.io.IOException, FTPException
dir
- name of remote directory to
change to
java.io.IOException
FTPException
public java.util.Date modtime(java.lang.String remoteFile) throws java.io.IOException, FTPException
remoteFile
- name of remote file
java.io.IOException
FTPException
public java.lang.String pwd() throws java.io.IOException, FTPException
java.io.IOException
FTPException
public java.lang.String[] features() throws java.io.IOException, FTPException
java.io.IOException
FTPException
public java.lang.String system() throws java.io.IOException, FTPException
java.io.IOException
FTPException
public java.lang.String help(java.lang.String command) throws java.io.IOException, FTPException
command
- name of the command to get help on
java.io.IOException
FTPException
public void quit() throws java.io.IOException, FTPException
java.io.IOException
FTPException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |