Java Doc for FTPClient.java in  » Net » Apache-commons-net-1.4.1 » org » apache » commons » net » ftp » Java Source Code / Java DocumentationJava Source Code and Java Documentation

 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 org.apache.commons.net.ftp.FTP.getReplyCode 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.IMAGE_FILE_TYPE (which is the same as FTP.BINARY_FILE_TYPE ). Because there are at lest 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 ToNetASCIIOutputStream 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 FTPClient.setRemoteVerificationEnabled 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 org.apache.commons.net.ftp.FTPReply.SERVICE_NOT_AVAILABLE 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 FTPClient.disconnect disconnect() to properly clean up the system resources used by FTPClient. Before disconnecting, you may check the last reply code and text with org.apache.commons.net.ftp.FTP.getReplyCode getReplyCode , org.apache.commons.net.ftp.FTP.getReplyString getReplyString , and org.apache.commons.net.ftp.FTP.getReplyStrings 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

• use languages other than English
• use date formats other than the American English "standard" MM d yyyy
• are in different timezones and you need accurate timestamps for dependency checking as in Ant

NOTE: If you experience problems with unwanted firing of

setSoTimeout()

setReaderThread(false)

author:
   Daniel F. Savarese
See Also:   FTP
See Also:   FTPConnectionClosedException
See Also:   FTPFileEntryParser
See Also:   FTPFileEntryParserFactory
See Also:   DefaultFTPFileEntryParserFactory
See Also:   FTPClientConfig
See Also:   org.apache.commons.net.MalformedServerReplyException

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421.

Parameters:
  bytes - The number of bytes which the server should allocate.

Parameters:
  bytes - The number of bytes which the server should allocate.
Parameters:
  recordSize - The size of a file record.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421.

Parameters:
  pathname - The new current working directory.

Parameters:
  pathname - The pathname of the file to be deleted.

The data port of the passive server.

The status information returned by the server.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421.

If key is null, this object will try to autodetect the system-type/parser-type by calling the SYST command.

Under the DefaultFTPFileEntryParserFactory, which is used unless a different factory has been specified, the key can be either a recognized System type for which a parser has been defined, or the fully qualified class name of a class that implements org.apache.commons.net.ftp.FTPFileEntryParser.

This information is obtained through the LIST command.

This information is obtained through the LIST command.

This information is obtained through the LIST command.

Parameters:
  parser - The FTPFileListParser that should beused to parse the server file listing.

The system help string obtained from the server.

Parameters:
  username - The username to login under.
Parameters:
  password - The password to use.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421.

Parameters:
  pathname - The pathname of the directory to create.

The pathname of the current working directory.

Parameters:
  pathname - The pathname of the directory to remove.

Parameters:
  from - The name of the remote file to rename.
Parameters:
  to - The new name of the remote file.

Parameters:
  pathname - The pathname to mount.

Parameters:
  command - The text representation of the FTP command to send.
Parameters:
  arg - The arguments to the FTP command. If this parameter isset to null, then the command is sent with no argument. A Socket corresponding to the established data connection.Null is returned if an FTP protocol error is reported atany point during the establishment and initialization ofthe connection.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  bytes - The number of bytes which the server should allocate. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  bytes - The number of bytes which the server should allocate.
Parameters:
  recordSize - The size of a file record. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  remote - The name of the remote file.
Parameters:
  local - The local InputStream from which to read the data tobe appended to the remote file. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  CopyStreamException - If an I/O error occurs while actuallytransferring the file. The CopyStreamException allows you todetermine the number of bytes transferred and the IOExceptioncausing the error. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  remote - The name of the remote file. An OutputStream through which the remote file can be appended.If the data connection cannot be opened (e.g., the file does notexist), null is returned (in which case you may check the replycode to determine the exact reason for failure).
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  pathname - The new current working directory. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

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);
 }
 

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

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.
Parameters:
  parser - The FTPFileEntryParser that should beused to parse each server file listing. An iteratable object that holds the raw information and iscapable of providing parsed FTPFile objects, one for each file containinginformation contained in the given path in the format determined by the parser parameter. Null will be returned if adata connection cannot be opened. If the current working directorycontains no files, an empty array will be the return.

FTPClient f=FTPClient();f.connect(server);f.login(username, password);FTPFileList list = f.createFileList(directory, parser);FTPFileIterator iter = list.iterator();while (iter.hasNext()) {FTPFile[] files = iter.getNext(25);  // "page size" you want//do whatever you want with these files, display them, etc.//expensive FTPFile objects not created until needed.}

Parameters:
  parser - The FTPFileEntryParser that should beused to parse each server file listing.
Parameters:
  pathname - The file or directory to list. An iteratable object that holds the raw information and iscapable of providing parsed FTPFile objects, one for each file containinginformation contained in the given path in the format determined by the parser parameter. Null will be returned if adata connection cannot be opened. If the supplied path containsno files, an empty array will be the return.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.
See Also:   FTPFileList

Parameters:
  pathname - The pathname of the file to be deleted. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

exception:
  IOException - If an error occurs while disconnecting.

Parameters:
  host - The passive mode server accepting connections for datatransfers.
Parameters:
  port - The passive mode server's data port. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

The current data connection mode (one of the _DATA_CONNECTION_MODE constants.

The passive host name if in passive mode, otherwise null.

The data port of the passive server. If not in passivemode, undefined.

offset The offset into the remote file at which to start thenext file transfer.

The status information returned by the server.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

The status information returned by the server.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

The system type name obtained from the server. null if theinformation could not be obtained.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

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. A FTPListParseEngine object that holds the raw information andis capable of providing parsed FTPFile objects, one for each filecontaining information contained in the given path in the formatdetermined by the parser parameter. Null will bereturned if a data connection cannot be opened. If the current workingdirectory contains no files, an empty array will be the return.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.
exception:
  ParserInitializationException - Thrown if the autodetect mechanism cannotresolve the type of system we are connected with.
See Also:   FTPListParseEngine

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.
 }
 

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.
Parameters:
  parserKey - A string representing a designated code or fully-qualifiedclass name of an FTPFileEntryParser that should beused to parse each server file listing. A FTPListParseEngine object that holds the raw information andis capable of providing parsed FTPFile objects, one for each filecontaining information contained in the given path in the formatdetermined by the parser parameter. Null will bereturned if a data connection cannot be opened. If the current workingdirectory contains no files, an empty array will be the return.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.
exception:
  ParserInitializationException - Thrown if the parserKey parameter cannot beresolved by the selected parser factory.In the DefaultFTPEntryParserFactory, this willhappen when parserKey is neitherthe fully qualified class name of a classimplementing the interfaceorg.apache.commons.net.ftp.FTPFileEntryParsernor a string containing one of the recognized keysmapping to such a parser or if class loadersecurity issues prevent its being loaded.
See Also:   FTPListParseEngine

True if verification is enabled, false if not.

If key is null, this object will try to autodetect the system-type/parser-type by calling the SYST command.

Under the DefaultFTPFileEntryParserFactory, which is used unless a different factory has been specified, the key can be either a recognized System type for which a parser has been defined, or the fully qualified class name of a class that implements org.apache.commons.net.ftp.FTPFileEntryParser.

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

Parameters:
  parserKey - This is a "handle" which the parser factory usedmust be able to resolve into a class implementingFTPFileEntryParser.

In the DefaultFTPFileEntryParserFactory, thismay either be a specific key identifying a server type,which is used to identify a parser type,or the fully qualified class name of the parser. SeeDefaultFTPFileEntryParserFactory.createFileEntryParserfor full details.

If this parameter is null, will attempt to generate a keyby running the SYST command. This should cause no problemwith the functionality implemented in theDefaultFTPFileEntryParserFactory, but may not map so wellto an alternative user-created factory. If that is thecase, calling this routine with a null parameter and acustom parser factory may not be advisable.

Parameters:
  pathname - The file or directory to list. Since the server mayor may not expand glob expressions, using them hereis not recommended and may well cause this method tofail. The list of file information contained in the given path inthe format determined by the parser represented by the parserKey parameter.

NOTE: This array may contain null members if any of the individual file listings failed to parse. The caller should check each entry for null before referencing it.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connectionas a result of the client being idle or some otherreason causing the server to send FTP reply code 421.This exception may be caught either as an IOExceptionor independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a replyfrom the server.
exception:
  ParserInitializationException - Thrown if the parserKey parameter cannot beresolved by the selected parser factory.In the DefaultFTPEntryParserFactory, this willhappen when parserKey is neitherthe fully qualified class name of a classimplementing the interfaceorg.apache.commons.net.ftp.FTPFileEntryParsernor a string containing one of the recognized keysmapping to such a parser or if class loadersecurity issues prevent its being loaded.
See Also:   org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
See Also:   org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory
See Also:   org.apache.commons.net.ftp.FTPFileEntryParserFTPClient.listFiles() listFiles()FTPClient.listFiles(String) listFiles(String)FTPClient.FTPClientConfig FTPClientConfig

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

Parameters:
  pathname - The file or directory to list. Since the server mayor may not expand glob expressions, using them hereis not recommended and may well cause this method tofail. The list of file information contained in the given path inthe format determined by the autodetection mechanism
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connectionas a result of the client being idle or some otherreason causing the server to send FTP reply code 421.This exception may be caught either as an IOExceptionor independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a replyfrom the server.
exception:
  ParserInitializationException - Thrown if the parserKey parameter cannot beresolved by the selected parser factory.In the DefaultFTPEntryParserFactory, this willhappen when parserKey is neitherthe fully qualified class name of a classimplementing the interfaceorg.apache.commons.net.ftp.FTPFileEntryParsernor a string containing one of the recognized keysmapping to such a parser or if class loadersecurity issues prevent its being loaded.
See Also:   org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
See Also:   org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory
See Also:   org.apache.commons.net.ftp.FTPFileEntryParser

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

The list of file information contained in the current directoryin the format determined by the autodetection mechanism.

NOTE: This array may contain null members if any of the individual file listings failed to parse. The caller should check each entry for null before referencing it.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connectionas a result of the client being idle or some otherreason causing the server to send FTP reply code 421.This exception may be caught either as an IOExceptionor independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a replyfrom the server.
exception:
  ParserInitializationException - Thrown if the parserKey parameter cannot beresolved by the selected parser factory.In the DefaultFTPEntryParserFactory, this willhappen when parserKey is neitherthe fully qualified class name of a classimplementing the interfaceorg.apache.commons.net.ftp.FTPFileEntryParsernor a string containing one of the recognized keysmapping to such a parser or if class loadersecurity issues prevent its being loaded.
See Also:   org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
See Also:   org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory
See Also:   org.apache.commons.net.ftp.FTPFileEntryParser

Parameters:
  parser - The FTPFileListParser that should beused to parse the server file listing.
Parameters:
  pathname - The file or directory to list. The list of file information contained in the given path inthe format determined by the parser parameter.

NOTE: This array may contain null members if any of the individual file listings failed to parse. The caller should check each entry for null before referencing it.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server. The list of file information contained in the given path inthe format determined by parserKey parameter.

NOTE: This array may contain null members if any of the individual file listings failed to parse. The caller should check each entry for null before referencing it.
exception:
  IOException -
since:
   5 Jan 2004

Parameters:
  parser - The FTPFileListParser that should beused to parse the server file listing. The list of file information contained in the given path inthe format determined by the parser parameter.

NOTE: This array may contain null members if any of the individual file listings failed to parse. The caller should check each entry for null before referencing it.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.
exception:
  IOException -
since:
   5 Jan 2004

The system help string obtained from the server. null if theinformation could not be obtained.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  pathname - The file or directory to list. The list of filenames contained in the given path. null ifthe list could not be obtained. If there are no filenames inthe directory, a zero-length array is returned.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

The list of filenames contained in the current workingdirectory. null if the list could not be obtained.If there are no filenames in the directory, a zero-length arrayis returned.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  username - The username to login under.
Parameters:
  password - The password to use. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  username - The username to login under.
Parameters:
  password - The password to use.
Parameters:
  account - The account to use. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  pathname - The pathname of the directory to create. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

The pathname of the current working directory. If it cannotbe obtained, returns null.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  filename - The name of the file to be appended to, or if thefile does not exist, the name to call the file being stored.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  filename - The name of the file to retrieve. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  filename - The name to call the file that is to be stored. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  filename - The name on which to base the filename of the filethat is to be stored. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  pathname - The pathname of the directory to remove. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  from - The name of the remote file to rename.
Parameters:
  to - The new name of the remote file. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  remote - The name of the remote file.
Parameters:
  local - The local OutputStream to which to write the file. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  CopyStreamException - If an I/O error occurs while actuallytransferring the file. The CopyStreamException allows you todetermine the number of bytes transferred and the IOExceptioncausing the error. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  remote - The name of the remote file. An InputStream from which the remote file can be read. Ifthe data connection cannot be opened (e.g., the file does notexist), null is returned (in which case you may check the replycode to determine the exact reason for failure).
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  timeout - The default timeout in milliseconds that is used whenopening a data connection socket.

Parameters:
  structure - The structure of the file (one of the FTP class_STRUCTURE constants). True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  mode - The new transfer mode to use (one of the FTP class_TRANSFER_MODE constants). True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  fileType - The _FILE_TYPE constant indcating thetype of file. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  fileType - The _FILE_TYPE constant indcating thetype of file.
Parameters:
  formatOrByteSize - The format of the file (one of the_FORMAT constants. In the case ofLOCAL_FILE_TYPE, the byte size.

True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  enable - True to enable verification, false to disable verification.

Parameters:
  offset - The offset into the remote file at which to start thenext file transfer. This must be a value greater than orequal to zero.

Parameters:
  remote - The name to give the remote file.
Parameters:
  local - The local InputStream from which to read the file. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  CopyStreamException - If an I/O error occurs while actuallytransferring the file. The CopyStreamException allows you todetermine the number of bytes transferred and the IOExceptioncausing the error. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  remote - The name to give the remote file. An OutputStream through which the remote file can be written. Ifthe data connection cannot be opened (e.g., the file does notexist), null is returned (in which case you may check the replycode to determine the exact reason for failure).
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  remote - The name on which to base the unique name given tothe remote file.
Parameters:
  local - The local InputStream from which to read the file. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  CopyStreamException - If an I/O error occurs while actuallytransferring the file. The CopyStreamException allows you todetermine the number of bytes transferred and the IOExceptioncausing the error. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  local - The local InputStream from which to read the file. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  CopyStreamException - If an I/O error occurs while actuallytransferring the file. The CopyStreamException allows you todetermine the number of bytes transferred and the IOExceptioncausing the error. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  remote - The name on which to base the unique name given tothe remote file. An OutputStream through which the remote file can be written. Ifthe data connection cannot be opened (e.g., the file does notexist), null is returned (in which case you may check the replycode to determine the exact reason for failure).
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

An OutputStream through which the remote file can be written. Ifthe data connection cannot be opened (e.g., the file does notexist), null is returned (in which case you may check the replycode to determine the exact reason for failure).
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.

Parameters:
  pathname - The pathname to mount. True if successfully completed, false if not.
exception:
  FTPConnectionClosedException - If the FTP server prematurely closes the connection as a resultof the client being idle or some other reason causing the serverto send FTP reply code 421. This exception may be caught eitheras an IOException or independently as itself.
exception:
  IOException - If an I/O error occurs while either sending acommand to the server or receiving a reply from the server.