Home » commons-net-2.0-src » org.apache.commons.net.ftp » [javadoc | source]
org.apache.commons.net.ftp
public class: FTPClient [javadoc | source]
java.lang.Object
   org.apache.commons.net.SocketClient
      org.apache.commons.net.ftp.FTP
         org.apache.commons.net.ftp.FTPClient

All Implemented Interfaces:
    Configurable

Direct Known Subclasses:
    FTPClient2, FTPSClient

FTPClient encapsulates all the functionality necessary to store and retrieve files from an FTP server. This class takes care of all low level details of interacting with an FTP server and provides a convenient higher level interface. As with all classes derived from org.apache.commons.net.SocketClient , you must first connect to the server with connect before doing anything, and finally disconnect after you're completely finished interacting with the server. Then you need to check the FTP reply code to see if the connection was successful. For example:
   boolean error = false;
   try {
     int reply;
     ftp.connect("ftp.foobar.com");
     System.out.println("Connected to " + server + ".");
     System.out.print(ftp.getReplyString());

     // After connection attempt, you should check the reply code to verify
     // success.
     reply = ftp.getReplyCode();

     if(!FTPReply.isPositiveCompletion(reply)) {
       ftp.disconnect();
       System.err.println("FTP server refused connection.");
       System.exit(1);
     }
     ... // transfer files
     ftp.logout();
   } catch(IOException e) {
     error = true;
     e.printStackTrace();
   } finally {
     if(ftp.isConnected()) {
       try {
         ftp.disconnect();
       } catch(IOException ioe) {
         // do nothing
       }
     }
     System.exit(error ? 1 : 0);
   }

Immediately after connecting is the only real time you need to check the reply code (because connect is of type void). The convention for all the FTP command methods in FTPClient is such that they either return a boolean value or some other value. The boolean methods return true on a successful completion reply from the FTP server and false on a reply resulting in an error condition or failure. The methods returning a value other than boolean return a value containing the higher level data produced by the FTP command, or null if a reply resulted in an error condition or failure. If you want to access the exact FTP reply code causing a success or failure, you must call getReplyCode after a success or failure.

The default settings for FTPClient are for it to use FTP.ASCII_FILE_TYPE , FTP.NON_PRINT_TEXT_FORMAT , FTP.STREAM_TRANSFER_MODE , and FTP.FILE_STRUCTURE . The only file types directly supported are FTP.ASCII_FILE_TYPE and FTP.BINARY_FILE_TYPE . Because there are at least 4 different EBCDIC encodings, we have opted not to provide direct support for EBCDIC. To transfer EBCDIC and other unsupported file types you must create your own filter InputStreams and OutputStreams and wrap them around the streams returned or required by the FTPClient methods. FTPClient uses the NetASCII filter streams to provide transparent handling of ASCII files. We will consider incorporating EBCDIC support if there is enough demand.

FTP.NON_PRINT_TEXT_FORMAT , FTP.STREAM_TRANSFER_MODE , and FTP.FILE_STRUCTURE are the only supported formats, transfer modes, and file structures.

Because the handling of sockets on different platforms can differ significantly, the FTPClient automatically issues a new PORT command prior to every transfer requiring that the server connect to the client's data port. This ensures identical problem-free behavior on Windows, Unix, and Macintosh platforms. Additionally, it relieves programmers from having to issue the PORT command themselves and dealing with platform dependent issues.

Additionally, for security purposes, all data connections to the client are verified to ensure that they originated from the intended party (host and port). If a data connection is initiated by an unexpected party, the command will close the socket and throw an IOException. You may disable this behavior with setRemoteVerificationEnabled() .

You should keep in mind that the FTP server may choose to prematurely close a connection if the client has been idle for longer than a given time period (usually 900 seconds). The FTPClient class will detect a premature FTP server connection closing when it receives a FTPReply.SERVICE_NOT_AVAILABLE response to a command. When that occurs, the FTP class method encountering that reply will throw an org.apache.commons.net.ftp.FTPConnectionClosedException . FTPConnectionClosedException is a subclass of IOException and therefore need not be caught separately, but if you are going to catch it separately, its catch block must appear before the more general IOException catch block. When you encounter an org.apache.commons.net.ftp.FTPConnectionClosedException , you must disconnect the connection with disconnect() to properly clean up the system resources used by FTPClient. Before disconnecting, you may check the last reply code and text with getReplyCode , getReplyString , and getReplyStrings . You may avoid server disconnections while the client is idle by periodicaly sending NOOP commands to the server.

Rather than list it separately for each method, we mention here that every method communicating with the server and throwing an IOException can also throw a org.apache.commons.net.MalformedServerReplyException , which is a subclass of IOException. A MalformedServerReplyException will be thrown when the reply received from the server deviates enough from the protocol specification that it cannot be interpreted in a useful manner despite attempts to be as lenient as possible.

Listing API Examples Both paged and unpaged examples of directory listings are available, as follows:

Unpaged (whole list) access, using a parser accessible by auto-detect:

   FTPClient f=FTPClient();
   f.connect(server);
   f.login(username, password);
   FTPFile[] files = listFiles(directory);

Paged access, using a parser not accessible by auto-detect. The class defined in the first parameter of initateListParsing should be derived from org.apache.commons.net.FTPFileEntryParser:

   FTPClient f=FTPClient();
   f.connect(server);
   f.login(username, password);
   FTPListParseEngine engine =
      f.initiateListParsing("com.whatever.YourOwnParser", directory);

   while (engine.hasNext()) {
      FTPFile[] files = engine.getNext(25);  // "page size" you want
      //do whatever you want with these files, display them, etc.
      //expensive FTPFile objects not created until needed.
   }

Paged access, using a parser accessible by auto-detect:

   FTPClient f=FTPClient();
   f.connect(server);
   f.login(username, password);
   FTPListParseEngine engine = f.initiateListParsing(directory);

   while (engine.hasNext()) {
      FTPFile[] files = engine.getNext(25);  // "page size" you want
      //do whatever you want with these files, display them, etc.
      //expensive FTPFile objects not created until needed.
   }

For examples of using FTPClient on servers whose directory listings

see FTPClientConfig .

Field Summary
public static final  int ACTIVE_LOCAL_DATA_CONNECTION_MODE    A constant indicating the FTP session is expecting all transfers to occur between the client (local) and server and that the server should connect to the client's data port to initiate a data transfer. This is the default data connection mode when and FTPClient instance is created. 
public static final  int ACTIVE_REMOTE_DATA_CONNECTION_MODE    A constant indicating the FTP session is expecting all transfers to occur between two remote servers and that the server the client is connected to should connect to the other server's data port to initiate a data transfer. 
public static final  int PASSIVE_LOCAL_DATA_CONNECTION_MODE    A constant indicating the FTP session is expecting all transfers to occur between the client (local) and server and that the server is in passive mode, requiring the client to connect to the server's data port to initiate a transfer. 
public static final  int PASSIVE_REMOTE_DATA_CONNECTION_MODE    A constant indicating the FTP session is expecting all transfers to occur between two remote servers and that the server the client is connected to is in passive mode, requiring the other server to connect to the first server's data port to initiate a data transfer. ** 
Fields inherited from org.apache.commons.net.ftp.FTP:
DEFAULT_DATA_PORT,  DEFAULT_PORT,  ASCII_FILE_TYPE,  EBCDIC_FILE_TYPE,  BINARY_FILE_TYPE,  LOCAL_FILE_TYPE,  NON_PRINT_TEXT_FORMAT,  TELNET_TEXT_FORMAT,  CARRIAGE_CONTROL_TEXT_FORMAT,  FILE_STRUCTURE,  RECORD_STRUCTURE,  PAGE_STRUCTURE,  STREAM_TRANSFER_MODE,  BLOCK_TRANSFER_MODE,  COMPRESSED_TRANSFER_MODE,  DEFAULT_CONTROL_ENCODING,  _replyCode,  _replyLines,  _newReplyString,  _replyString,  _controlEncoding,  strictMultilineParsing,  _controlInput_,  _controlOutput_,  _commandSupport_
Fields inherited from org.apache.commons.net.SocketClient:
NETASCII_EOL,  _timeout_,  _socket_,  _defaultPort_,  _input_,  _output_,  _socketFactory_,  _serverSocketFactory_,  connectTimeout
Constructor:
 public FTPClient() 
Method from org.apache.commons.net.ftp.FTPClient Summary:
_connectAction_,   _openDataConnection_,   abort,   allocate,   allocate,   appendFile,   appendFileStream,   changeToParentDirectory,   changeWorkingDirectory,   completePendingCommand,   configure,   deleteFile,   disconnect,   enterLocalActiveMode,   enterLocalPassiveMode,   enterRemoteActiveMode,   enterRemotePassiveMode,   getBufferSize,   getDataConnectionMode,   getListArguments,   getListHiddenFiles,   getModificationTime,   getPassiveHost,   getPassivePort,   getRestartOffset,   getStatus,   getStatus,   getSystemName,   initiateListParsing,   initiateListParsing,   initiateListParsing,   isRemoteVerificationEnabled,   listFiles,   listFiles,   listHelp,   listHelp,   listNames,   listNames,   login,   login,   logout,   makeDirectory,   printWorkingDirectory,   reinitialize,   remoteAppend,   remoteRetrieve,   remoteStore,   remoteStoreUnique,   remoteStoreUnique,   removeDirectory,   rename,   retrieveFile,   retrieveFileStream,   sendNoOp,   sendSiteCommand,   setBufferSize,   setDataTimeout,   setFileStructure,   setFileTransferMode,   setFileType,   setFileType,   setListHiddenFiles,   setParserFactory,   setRemoteVerificationEnabled,   setRestartOffset,   storeFile,   storeFileStream,   storeUniqueFile,   storeUniqueFile,   storeUniqueFileStream,   storeUniqueFileStream,   structureMount
Methods from org.apache.commons.net.ftp.FTP:
_connectAction_,   abor,   acct,   addProtocolCommandListener,   allo,   allo,   appe,   cdup,   cwd,   dele,   disconnect,   getControlEncoding,   getReply,   getReplyCode,   getReplyString,   getReplyStrings,   help,   help,   isStrictMultilineParsing,   list,   list,   mdtm,   mkd,   mode,   nlst,   nlst,   noop,   pass,   pasv,   port,   pwd,   quit,   rein,   removeProtocolCommandListener,   rest,   retr,   rmd,   rnfr,   rnto,   sendCommand,   sendCommand,   sendCommand,   sendCommand,   setControlEncoding,   setStrictMultilineParsing,   site,   smnt,   stat,   stat,   stor,   stou,   stou,   stru,   syst,   type,   type,   user
Methods from org.apache.commons.net.SocketClient:
_connectAction_,   connect,   connect,   connect,   connect,   connect,   connect,   disconnect,   getConnectTimeout,   getDefaultPort,   getDefaultTimeout,   getLocalAddress,   getLocalPort,   getRemoteAddress,   getRemotePort,   getSoLinger,   getSoTimeout,   getTcpNoDelay,   isConnected,   setConnectTimeout,   setDefaultPort,   setDefaultTimeout,   setReceiveBufferSize,   setSendBufferSize,   setServerSocketFactory,   setSoLinger,   setSoTimeout,   setSocketFactory,   setTcpNoDelay,   verifyRemote
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.net.ftp.FTPClient Detail:
 protected  void _connectAction_() throws IOException 
 protected Socket _openDataConnection_(int command,
    String arg) throws IOException 
    Establishes a data connection with the FTP server, returning a Socket for the connection if successful. If a restart offset has been set with #setRestartOffset(long) , a REST command is issued to the server with the offset as an argument before establishing the data connection. Active mode connections also cause a local PORT command to be issued.

 public boolean abort() throws IOException 
    Abort a transfer in progress.

 public boolean allocate(int bytes) throws IOException 
    Reserve a number of bytes on the server for the next file transfer.

 public boolean allocate(int bytes,
    int recordSize) throws IOException 
    Reserve space on the server for the next file transfer.

 public boolean appendFile(String remote,
    InputStream local) throws IOException 
    Appends to a file on the server with the given name, taking input from the given InputStream. This method does NOT close the given InputStream. If the current file type is ASCII, line separators in the file are transparently converted to the NETASCII format (i.e., you should not attempt to create a special InputStream to do this).

 public OutputStream appendFileStream(String remote) throws IOException 
    Returns an OutputStream through which data can be written to append to a file on the server with the given name. If the current file type is ASCII, the returned OutputStream will convert line separators in the file to the NETASCII format (i.e., you should not attempt to create a special OutputStream to do this). You must close the OutputStream when you finish writing to it. The OutputStream itself will take care of closing the parent data connection socket upon being closed. To finalize the file transfer you must call completePendingCommand and check its return value to verify success.

 public boolean changeToParentDirectory() throws IOException 
    Change to the parent directory of the current working directory.

 public boolean changeWorkingDirectory(String pathname) throws IOException 
    Change the current working directory of the FTP session.

 public boolean completePendingCommand() throws IOException 
    There are a few FTPClient methods that do not complete the entire sequence of FTP commands to complete a transaction. These commands require some action by the programmer after the reception of a positive intermediate command. After the programmer's code completes its actions, it must call this method to receive the completion reply from the server and verify the success of the entire transaction.

    For example,

    InputStream input;
    OutputStream output;
    input  = new FileInputStream("foobaz.txt");
    output = ftp.storeFileStream("foobar.txt")
    if(!FTPReply.isPositiveIntermediate(ftp.getReplyCode())) {
        input.close();
        output.close();
        ftp.logout();
        ftp.disconnect();
        System.err.println("File transfer failed.");
        System.exit(1);
    }
    Util.copyStream(input, output);
    input.close();
    output.close();
    // Must call completePendingCommand() to finish command.
    if(!ftp.completePendingCommand()) {
        ftp.logout();
        ftp.disconnect();
        System.err.println("File transfer failed.");
        System.exit(1);
    }
    

 public  void configure(FTPClientConfig config) 
    Implementation of the Configurable interface. In the case of this class, configuring merely makes the config object available for the factory methods that construct parsers.
 public boolean deleteFile(String pathname) throws IOException 
    Deletes a file on the FTP server.

 public  void disconnect() throws IOException 
    Closes the connection to the FTP server and restores connection parameters to the default values.

 public  void enterLocalActiveMode() 
    Set the current data connection mode to ACTIVE_LOCAL_DATA_CONNECTION_MODE. No communication with the FTP server is conducted, but this causes all future data transfers to require the FTP server to connect to the client's data port. Additionally, to accommodate differences between socket implementations on different platforms, this method causes the client to issue a PORT command before every data transfer.
 public  void enterLocalPassiveMode() 
    Set the current data connection mode to PASSIVE_LOCAL_DATA_CONNECTION_MODE . Use this method only for data transfers between the client and server. This method causes a PASV command to be issued to the server before the opening of every data connection, telling the server to open a data port to which the client will connect to conduct data transfers. The FTPClient will stay in PASSIVE_LOCAL_DATA_CONNECTION_MODE until the mode is changed by calling some other method such as enterLocalActiveMode() **
 public boolean enterRemoteActiveMode(InetAddress host,
    int port) throws IOException 
    Set the current data connection mode to ACTIVE_REMOTE_DATA_CONNECTION . Use this method only for server to server data transfers. This method issues a PORT command to the server, indicating the other server and port to which it should connect for data transfers. You must call this method before EVERY server to server transfer attempt. The FTPClient will NOT automatically continue to issue PORT commands. You also must remember to call enterLocalActiveMode() if you wish to return to the normal data connection mode.

 public boolean enterRemotePassiveMode() throws IOException 
    Set the current data connection mode to PASSIVE_REMOTE_DATA_CONNECTION_MODE . Use this method only for server to server data transfers. This method issues a PASV command to the server, telling it to open a data port to which the active server will connect to conduct data transfers. You must call this method before EVERY server to server transfer attempt. The FTPClient will NOT automatically continue to issue PASV commands. You also must remember to call enterLocalActiveMode() if you wish to return to the normal data connection mode.

 public int getBufferSize() 
    Retrieve the current internal buffer size.
 public int getDataConnectionMode() 
    Returns the current data connection mode (one of the _DATA_CONNECTION_MODE constants.

 protected String getListArguments(String pathname) 
 public boolean getListHiddenFiles() 
 public String getModificationTime(String pathname) throws IOException 
    Issue the FTP MDTM command (not supported by all servers to retrieve the last modification time of a file. The modification string should be in the ISO 3077 form "YYYYMMDDhhmmss(.xxx)?". The timestamp represented should also be in GMT, but not all FTP servers honour this.
 public String getPassiveHost() 
    Returns the hostname or IP address (in the form of a string) returned by the server when entering passive mode. If not in passive mode, returns null. This method only returns a valid value AFTER a data connection has been opened after a call to enterLocalPassiveMode() . This is because FTPClient sends a PASV command to the server only just before opening a data connection, and not when you call enterLocalPassiveMode() .

 public int getPassivePort() 
    If in passive mode, returns the data port of the passive host. This method only returns a valid value AFTER a data connection has been opened after a call to enterLocalPassiveMode() . This is because FTPClient sends a PASV command to the server only just before opening a data connection, and not when you call enterLocalPassiveMode() .

 public long getRestartOffset() 
    Fetches the restart offset.

 public String getStatus() throws IOException 
    Issue the FTP STAT command to the server.

 public String getStatus(String pathname) throws IOException 
    Issue the FTP STAT command to the server for a given pathname. This should produce a listing of the file or directory.

 public String getSystemName() throws IOException 
    Fetches the system type name from the server and returns the string. This value is cached for the duration of the connection after the first call to this method. In other words, only the first time that you invoke this method will it issue a SYST command to the FTP server. FTPClient will remember the value and return the cached value until a call to disconnect.

 public FTPListParseEngine initiateListParsing() throws IOException 
    Using the default autodetect mechanism, initialize an FTPListParseEngine object containing a raw file information for the current working directory on the server This information is obtained through the LIST command. This object is then capable of being iterated to return a sequence of FTPFile objects with information filled in by the FTPFileEntryParser used.

    This method differs from using the listFiles() methods in that expensive FTPFile objects are not created until needed which may be an advantage on large lists.

 public FTPListParseEngine initiateListParsing(String pathname) throws IOException 
    Using the default autodetect mechanism, initialize an FTPListParseEngine object containing a raw file information for the supplied directory. This information is obtained through the LIST command. This object is then capable of being iterated to return a sequence of FTPFile objects with information filled in by the FTPFileEntryParser used.

    The server may or may not expand glob expressions. You should avoid using glob expressions because the return format for glob listings differs from server to server and will likely cause this method to fail.

    This method differs from using the listFiles() methods in that expensive FTPFile objects are not created until needed which may be an advantage on large lists.

       FTPClient f=FTPClient();
       f.connect(server);
       f.login(username, password);
       FTPListParseEngine engine = f.initiateListParsing(directory);
    
       while (engine.hasNext()) {
          FTPFile[] files = engine.getNext(25);  // "page size" you want
          //do whatever you want with these files, display them, etc.
          //expensive FTPFile objects not created until needed.
       }
    
 public FTPListParseEngine initiateListParsing(String parserKey,
    String pathname) throws IOException 
    Using the supplied parser key, initialize an FTPListParseEngine object containing a raw file information for the supplied directory. This information is obtained through the LIST command. This object is then capable of being iterated to return a sequence of FTPFile objects with information filled in by the FTPFileEntryParser used.

    The server may or may not expand glob expressions. You should avoid using glob expressions because the return format for glob listings differs from server to server and will likely cause this method to fail.

    This method differs from using the listFiles() methods in that expensive FTPFile objects are not created until needed which may be an advantage on large lists.

 public boolean isRemoteVerificationEnabled() 
    Return whether or not verification of the remote host participating in data connections is enabled. The default behavior is for verification to be enabled.

 public FTPFile[] listFiles() throws IOException 
    Using the default system autodetect mechanism, obtain a list of file information for the current working directory.

    This information is obtained through the LIST command. The contents of the returned array is determined by the FTPFileEntryParser used.

 public FTPFile[] listFiles(String pathname) throws IOException 
    Using the default system autodetect mechanism, obtain a list of file information for the current working directory or for just a single file.

    This information is obtained through the LIST command. The contents of the returned array is determined by the FTPFileEntryParser used.

 public String listHelp() throws IOException 
    Fetches the system help information from the server and returns the full string.

 public String listHelp(String command) throws IOException 
    Fetches the help information for a given command from the server and returns the full string.
 public String[] listNames() throws IOException 
    Obtain a list of filenames in the current working directory This information is obtained through the NLST command. If the current directory contains no files, a zero length array is returned only if the FTP server returned a positive completion code, otherwise, null is returned (the FTP server returned a 550 error No files found.). If the directory is not empty, an array of filenames in the directory is returned.

 public String[] listNames(String pathname) throws IOException 
    Obtain a list of filenames in a directory (or just the name of a given file, which is not particularly useful). This information is obtained through the NLST command. If the given pathname is a directory and contains no files, a zero length array is returned only if the FTP server returned a positive completion code, otherwise null is returned (the FTP server returned a 550 error No files found.). If the directory is not empty, an array of filenames in the directory is returned. If the pathname corresponds to a file, only that file will be listed. The server may or may not expand glob expressions.

 public boolean login(String username,
    String password) throws IOException 
    Login to the FTP server using the provided username and password.

 public boolean login(String username,
    String password,
    String account) throws IOException 
    Login to the FTP server using the provided username, password, and account. If no account is required by the server, only the username and password, the account information is not used.

 public boolean logout() throws IOException 
    Logout of the FTP server by sending the QUIT command.

 public boolean makeDirectory(String pathname) throws IOException 
    Creates a new subdirectory on the FTP server in the current directory (if a relative pathname is given) or where specified (if an absolute pathname is given).

 public String printWorkingDirectory() throws IOException 
    Returns the pathname of the current working directory.

 boolean reinitialize() throws IOException 
    Reinitialize the FTP session. Not all FTP servers support this command, which issues the FTP REIN command.

 public boolean remoteAppend(String filename) throws IOException 
    Initiate a server to server file transfer. This method tells the server to which the client is connected to append to a given file on the other server. The other server must have had a remoteRetrieve issued to it by another FTPClient.

 public boolean remoteRetrieve(String filename) throws IOException 
    Initiate a server to server file transfer. This method tells the server to which the client is connected to retrieve a given file from the other server.

 public boolean remoteStore(String filename) throws IOException 
    Initiate a server to server file transfer. This method tells the server to which the client is connected to store a file on the other server using the given filename. The other server must have had a remoteRetrieve issued to it by another FTPClient.

 public boolean remoteStoreUnique() throws IOException 
    Initiate a server to server file transfer. This method tells the server to which the client is connected to store a file on the other server using a unique filename. The other server must have had a remoteRetrieve issued to it by another FTPClient. Many FTP servers require that a base filename be given from which the unique filename can be derived. For those servers use the other version of remoteStoreUnique

 public boolean remoteStoreUnique(String filename) throws IOException 
    Initiate a server to server file transfer. This method tells the server to which the client is connected to store a file on the other server using a unique filename based on the given filename. The other server must have had a remoteRetrieve issued to it by another FTPClient.

 public boolean removeDirectory(String pathname) throws IOException 
    Removes a directory on the FTP server (if empty).

 public boolean rename(String from,
    String to) throws IOException 
    Renames a remote file.

 public boolean retrieveFile(String remote,
    OutputStream local) throws IOException 
    Retrieves a named file from the server and writes it to the given OutputStream. This method does NOT close the given OutputStream. If the current file type is ASCII, line separators in the file are converted to the local representation.

 public InputStream retrieveFileStream(String remote) throws IOException 
    Returns an InputStream from which a named file from the server can be read. If the current file type is ASCII, the returned InputStream will convert line separators in the file to the local representation. You must close the InputStream when you finish reading from it. The InputStream itself will take care of closing the parent data connection socket upon being closed. To finalize the file transfer you must call completePendingCommand and check its return value to verify success.

 public boolean sendNoOp() throws IOException 
    Sends a NOOP command to the FTP server. This is useful for preventing server timeouts.

 public boolean sendSiteCommand(String arguments) throws IOException 
    Send a site specific command.
 public  void setBufferSize(int bufSize) 
    Set the internal buffer size.
 public  void setDataTimeout(int timeout) 
    Sets the timeout in milliseconds to use when reading from the data connection. This timeout will be set immediately after opening the data connection.

 public boolean setFileStructure(int structure) throws IOException 
    Sets the file structure. The default structure is FTP.FILE_STRUCTURE if this method is never called.

 public boolean setFileTransferMode(int mode) throws IOException 
    Sets the transfer mode. The default transfer mode FTP.STREAM_TRANSFER_MODE if this method is never called.

 public boolean setFileType(int fileType) throws IOException 
    Sets the file type to be transferred. This should be one of FTP.ASCII_FILE_TYPE , FTP.BINARY_FILE_TYPE, etc. The file type only needs to be set when you want to change the type. After changing it, the new type stays in effect until you change it again. The default file type is FTP.ASCII_FILE_TYPE if this method is never called.

 public boolean setFileType(int fileType,
    int formatOrByteSize) throws IOException 
    Sets the file type to be transferred and the format. The type should be one of FTP.ASCII_FILE_TYPE , FTP.BINARY_FILE_TYPE , etc. The file type only needs to be set when you want to change the type. After changing it, the new type stays in effect until you change it again. The default file type is FTP.ASCII_FILE_TYPE if this method is never called. The format should be one of the FTP class TEXT_FORMAT constants, or if the type is FTP.LOCAL_FILE_TYPE , the format should be the byte size for that type. The default format is FTP.NON_PRINT_TEXT_FORMAT if this method is never called.

 public  void setListHiddenFiles(boolean listHiddenFiles) 
    You can set this to true if you would like to get hidden files when #listFiles too. A LIST -a will be issued to the ftp server. It depends on your ftp server if you need to call this method, also dont expect to get rid of hidden files if you call this method with "false".
 public  void setParserFactory(FTPFileEntryParserFactory parserFactory) 
    set the factory used for parser creation to the supplied factory object.
 public  void setRemoteVerificationEnabled(boolean enable) 
    Enable or disable verification that the remote host taking part of a data connection is the same as the host to which the control connection is attached. The default is for verification to be enabled. You may set this value at any time, whether the FTPClient is currently connected or not.

 public  void setRestartOffset(long offset) 
    Sets the restart offset. The restart command is sent to the server only before sending the file transfer command. When this is done, the restart marker is reset to zero.

 public boolean storeFile(String remote,
    InputStream local) throws IOException 
    Stores a file on the server using the given name and taking input from the given InputStream. This method does NOT close the given InputStream. If the current file type is ASCII, line separators in the file are transparently converted to the NETASCII format (i.e., you should not attempt to create a special InputStream to do this).

 public OutputStream storeFileStream(String remote) throws IOException 
    Returns an OutputStream through which data can be written to store a file on the server using the given name. If the current file type is ASCII, the returned OutputStream will convert line separators in the file to the NETASCII format (i.e., you should not attempt to create a special OutputStream to do this). You must close the OutputStream when you finish writing to it. The OutputStream itself will take care of closing the parent data connection socket upon being closed. To finalize the file transfer you must call completePendingCommand and check its return value to verify success.

 public boolean storeUniqueFile(InputStream local) throws IOException 
    Stores a file on the server using a unique name assigned by the server and taking input from the given InputStream. This method does NOT close the given InputStream. If the current file type is ASCII, line separators in the file are transparently converted to the NETASCII format (i.e., you should not attempt to create a special InputStream to do this).

 public boolean storeUniqueFile(String remote,
    InputStream local) throws IOException 
    Stores a file on the server using a unique name derived from the given name and taking input from the given InputStream. This method does NOT close the given InputStream. If the current file type is ASCII, line separators in the file are transparently converted to the NETASCII format (i.e., you should not attempt to create a special InputStream to do this).

 public OutputStream storeUniqueFileStream() throws IOException 
    Returns an OutputStream through which data can be written to store a file on the server using a unique name assigned by the server. If the current file type is ASCII, the returned OutputStream will convert line separators in the file to the NETASCII format (i.e., you should not attempt to create a special OutputStream to do this). You must close the OutputStream when you finish writing to it. The OutputStream itself will take care of closing the parent data connection socket upon being closed. To finalize the file transfer you must call completePendingCommand and check its return value to verify success.

 public OutputStream storeUniqueFileStream(String remote) throws IOException 
    Returns an OutputStream through which data can be written to store a file on the server using a unique name derived from the given name. If the current file type is ASCII, the returned OutputStream will convert line separators in the file to the NETASCII format (i.e., you should not attempt to create a special OutputStream to do this). You must close the OutputStream when you finish writing to it. The OutputStream itself will take care of closing the parent data connection socket upon being closed. To finalize the file transfer you must call completePendingCommand and check its return value to verify success.

 public boolean structureMount(String pathname) throws IOException 
    Issue the FTP SMNT command.