com.enterprisedt.net.ftp
Class FTPClient

java.lang.Object
  |
  +--com.enterprisedt.net.ftp.FTPClient

public class FTPClient
extends java.lang.Object

Supports client-side FTP. Most common FTP operations are present in this class.

Version:
$Revision: 1.3 $
Author:
Bruce Blackshaw

Constructor Summary
FTPClient(java.net.InetAddress remoteAddr)
          Constructor.
FTPClient(java.net.InetAddress remoteAddr, int controlPort)
          Constructor.
FTPClient(java.lang.String remoteHost)
          Constructor.
FTPClient(java.lang.String remoteHost, int controlPort)
          Constructor.
 
Method Summary
 void chdir(java.lang.String dir)
          Change the remote working directory to that supplied
 void debugResponses(boolean on)
          Switch debug of responses on or off
 void delete(java.lang.String remoteFile)
          Delete the specified remote file
 java.lang.String[] dir(java.lang.String mask)
          List a directory's contents as an array of strings of filenames.
 java.lang.String[] dir(java.lang.String mask, boolean full)
          List a directory's contents as an array of strings.
 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.
 FTPTransferType getType()
          Get the current transfer type
 void initSOCKS(java.lang.String port, java.lang.String host)
          Set up SOCKS v4 proxy settings.
 java.lang.String list(java.lang.String mask)
          Deprecated. As of FTP 1.1, replaced by dir(String)
 java.lang.String list(java.lang.String mask, 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
 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.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
 void quote(java.lang.String command, java.lang.String[] validCodes)
          Issue arbitrary ftp commands to the FTP server.
 void rename(java.lang.String from, java.lang.String to)
          Rename a file or directory
 void rmdir(java.lang.String dir)
          Delete the specified remote working directory
 void setConnectMode(FTPConnectMode mode)
          Set the connect mode
 void setTimeout(int millis)
          Set the TCP timeout on the underlying socket.
 void setType(FTPTransferType type)
          Set the transfer type
 boolean site(java.lang.String command)
          Run a site-specific command on the server.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FTPClient

public FTPClient(java.lang.String remoteHost)
          throws java.io.IOException,
                 FTPException
Constructor. Creates the control socket
Parameters:
remoteHost - the remote hostname

FTPClient

public FTPClient(java.lang.String remoteHost,
                 int controlPort)
          throws java.io.IOException,
                 FTPException
Constructor. Creates the control socket
Parameters:
remoteHost - the remote hostname
controlPort - port for control stream

FTPClient

public FTPClient(java.net.InetAddress remoteAddr)
          throws java.io.IOException,
                 FTPException
Constructor. Creates the control socket
Parameters:
remoteAddr - the address of the remote host

FTPClient

public FTPClient(java.net.InetAddress remoteAddr,
                 int controlPort)
          throws java.io.IOException,
                 FTPException
Constructor. Creates the control socket. Allows setting of control port (normally set by default to 21).
Parameters:
remoteAddr - the address of the remote host
controlPort - port for control stream
Method Detail

setTimeout

public void setTimeout(int millis)
                throws java.io.IOException
Set the TCP timeout on the underlying socket. If a timeout is set, then any operation which takes longer than the timeout value will be killed with a java.io.InterruptedException. We set both the control and data connections
Parameters:
millis - The length of the timeout, in milliseconds

setConnectMode

public void setConnectMode(FTPConnectMode mode)
Set the connect mode
Parameters:
mode - ACTIVE or PASV mode

login

public void login(java.lang.String user,
                  java.lang.String password)
           throws java.io.IOException,
                  FTPException
Login into an account on the FTP server. This call completes the entire login process
Parameters:
user - user name
password - user's password

user

public void user(java.lang.String user)
          throws java.io.IOException,
                 FTPException
Supply the user name to log into an account on the FTP server. Must be followed by the password() method - but we allow for
Parameters:
user - user name
password - user's password

password

public void password(java.lang.String password)
              throws java.io.IOException,
                     FTPException
Supplies the password for a previously supplied username to log into the FTP server. Must be preceeded by the user() method
Parameters:
user - user name
password - user's password

initSOCKS

public void initSOCKS(java.lang.String port,
                      java.lang.String host)
Set up SOCKS v4 proxy settings. This can be used if there is a SOCKS proxy server in place that must be connected thru.
Parameters:
port - SOCKS proxy port
host - SOCKS proxy hostname

quote

public void quote(java.lang.String command,
                  java.lang.String[] validCodes)
           throws java.io.IOException,
                  FTPException
Issue arbitrary ftp commands to the FTP server.
Parameters:
command - ftp command to be sent to server
validCodes - valid return codes for this command

put

public void put(java.lang.String localPath,
                java.lang.String remoteFile)
         throws java.io.IOException,
                FTPException
Put a local file onto the FTP server. It is placed in the current directory.
Parameters:
localPath - path of the local file
remoteFile - name of remote file in current directory

put

public void put(java.lang.String localPath,
                java.lang.String remoteFile,
                boolean append)
         throws java.io.IOException,
                FTPException
Put a local file onto the FTP server. It is placed in the current directory. Allows appending if current file exists
Parameters:
localPath - path of the local file
remoteFile - name of remote file in current directory
append - true if appending, false otherwise

put

public void put(byte[] bytes,
                java.lang.String remoteFile)
         throws java.io.IOException,
                FTPException
Put data onto the FTP server. It is placed in the current directory.
Parameters:
data - array of bytes
remoteFile - name of remote file in current directory

put

public void put(byte[] bytes,
                java.lang.String remoteFile,
                boolean append)
         throws java.io.IOException,
                FTPException
Put data onto the FTP server. It is placed in the current directory. Allows appending if current file exists
Parameters:
data - array of bytes
remoteFile - name of remote file in current directory
append - true if appending, false otherwise

get

public void get(java.lang.String localPath,
                java.lang.String remoteFile)
         throws java.io.IOException,
                FTPException
Get data from the FTP server. Uses the currently set transfer mode.
Parameters:
localPath - local file to put data in
remoteFile - name of remote file in current directory

get

public byte[] get(java.lang.String remoteFile)
           throws java.io.IOException,
                  FTPException
Get data from the FTP server. Transfers in whatever mode we are in. Retrieve as a byte array. Note that we may experience memory limitations as the entire file must be held in memory at one time.
Parameters:
remoteFile - name of remote file in current directory

site

public boolean site(java.lang.String command)
             throws java.io.IOException,
                    FTPException
Run a site-specific command on the server. Support for commands is dependent on the server
Parameters:
command - the site command to run
Returns:
true if command ok, false if command not implemented

list

public java.lang.String list(java.lang.String mask)
                      throws java.io.IOException,
                             FTPException
Deprecated. As of FTP 1.1, replaced by dir(String)

List a directory's contents
Parameters:
mask - the file mask to use
Returns:
a string containing the line separated directory listing

list

public java.lang.String list(java.lang.String mask,
                             boolean full)
                      throws java.io.IOException,
                             FTPException
Deprecated. As of FTP 1.1, replaced by dir(String,boolean)

List a directory's contents as one string. A detailed listing is available, otherwise just filenames are provided. The detailed listing varies in details depending on OS and FTP server.
Parameters:
mask - the file mask to use
full - true if detailed listing required false otherwise
Returns:
a string containing the line separated directory listing

dir

public java.lang.String[] dir(java.lang.String mask)
                       throws java.io.IOException,
                              FTPException
List a directory's contents as an array of strings of filenames.
Parameters:
mask - the file mask to use
Returns:
an array of directory listing strings

dir

public java.lang.String[] dir(java.lang.String mask,
                              boolean full)
                       throws java.io.IOException,
                              FTPException
List a directory's contents as an array of strings. A detailed listing is available, otherwise just filenames are provided. The detailed listing varies in details depending on OS and FTP server.
Parameters:
mask - the file mask to use
full - true if detailed listing required false otherwise
Returns:
an array of directory listing strings

debugResponses

public void debugResponses(boolean on)
Switch debug of responses on or off
Parameters:
on - true if you wish to have responses to stdout, false otherwise

getType

public FTPTransferType getType()
Get the current transfer type
Returns:
the current type of the transfer, i.e. BINARY or ASCII

setType

public void setType(FTPTransferType type)
             throws java.io.IOException,
                    FTPException
Set the transfer type
Parameters:
type - the transfer type to set the server to

delete

public void delete(java.lang.String remoteFile)
            throws java.io.IOException,
                   FTPException
Delete the specified remote file
Parameters:
remoteFile - name of remote file to delete

rename

public void rename(java.lang.String from,
                   java.lang.String to)
            throws java.io.IOException,
                   FTPException
Rename a file or directory
Parameters:
from - name of file or directory to rename
to - intended name

rmdir

public void rmdir(java.lang.String dir)
           throws java.io.IOException,
                  FTPException
Delete the specified remote working directory
Parameters:
dir - name of remote directory to delete

mkdir

public void mkdir(java.lang.String dir)
           throws java.io.IOException,
                  FTPException
Create the specified remote working directory
Parameters:
dir - name of remote directory to create

chdir

public void chdir(java.lang.String dir)
           throws java.io.IOException,
                  FTPException
Change the remote working directory to that supplied
Parameters:
dir - name of remote directory to change to

pwd

public java.lang.String pwd()
                     throws java.io.IOException,
                            FTPException
Get the current remote working directory
Returns:
the current working directory

system

public java.lang.String system()
                        throws java.io.IOException,
                               FTPException
Get the type of the OS at the server
Returns:
the type of server OS

quit

public void quit()
          throws java.io.IOException,
                 FTPException
Quit the FTP session


Copyright (c) 2001 Enterprise Distributed Technologies Ltd. All Rights Reserved.