FileDocCategorySizeDatePackage
FTPFileEntryParser.javaAPI DocApache Commons NET 1.4.1 API5741Sat Dec 03 10:05:48 GMT 2005org.apache.commons.net.ftp

FTPFileEntryParser

public interface FTPFileEntryParser
FTPFileEntryParser defines the interface for parsing a single FTP file listing and converting that information into an {@link org.apache.commons.net.ftp.FTPFile} instance. Sometimes you will want to parse unusual listing formats, in which case you would create your own implementation of FTPFileEntryParser and if necessary, subclass FTPFile.

Here are some examples showing how to use one of the classes that implement this interface.

The first example shows how to get an iterable list of files in which the more expensive FTPFile objects are not created until needed. This is suitable for paged displays. It requires that a parser object be created beforehand: parser is an object (in the package org.apache.commons.net.ftp.parser) implementing this inteface.

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.
}
The second example uses the revised FTPClient.listFiles() API to pull the whole list from the subfolder subfolder in one call, attempting to automatically detect the parser type. This method, without a parserKey parameter, indicates that autodection should be used.
FTPClient f=FTPClient();
f.connect(server);
f.login(username, password);
FTPFile[] files = f.listFiles("subfolder");
The third example uses the revised FTPClient.listFiles()> API to pull the whole list from the current working directory in one call, but specifying by classname the parser to be used. For this particular parser class, this approach is necessary since there is no way to autodetect this server type.
FTPClient f=FTPClient();
f.connect(server);
f.login(username, password);
FTPFile[] files = f.listFiles(
"org.apache.commons.net.ftp.parser.EnterpriseUnixFTPFileEntryParser",
".");
The fourth example uses the revised FTPClient.listFiles() API to pull a single file listing in an arbitrary directory in one call, specifying by KEY the parser to be used, in this case, VMS.
FTPClient f=FTPClient();
f.connect(server);
f.login(username, password);
FTPFile[] files = f.listFiles("VMS", "subfolder/foo.java");
author
Steve Cohen
version
$Id: FTPFileEntryParser.java 165675 2005-05-02 20:09:55Z rwinston $
see
org.apache.commons.net.ftp.FTPFile
see
org.apache.commons.net.ftp.FTPClient#createFileList

Fields Summary
Constructors Summary
Methods Summary
public FTPFileparseFTPEntry(java.lang.String listEntry)
Parses a line of an FTP server file listing and converts it into a usable format in the form of an FTPFile instance. If the file listing line doesn't describe a file, null should be returned, otherwise a FTPFile instance representing the files in the directory is returned.

param
listEntry A line of text from the file listing
return
An FTPFile instance corresponding to the supplied entry

public java.util.ListpreParse(java.util.List original)
This method is a hook for those implementors (such as VMSVersioningFTPEntryParser, and possibly others) which need to perform some action upon the FTPFileList after it has been created from the server stream, but before any clients see the list. The default implementation can be a no-op.

param
original Original list after it has been created from the server stream
return
Original list as processed by this method.

public java.lang.StringreadNextEntry(java.io.BufferedReader reader)
Reads the next entry using the supplied BufferedReader object up to whatever delemits one entry from the next. Implementors must define this for the particular ftp system being parsed. In many but not all cases, this can be defined simply by calling BufferedReader.readLine().

param
reader The BufferedReader object from which entries are to be read.
return
A string representing the next ftp entry or null if none found.
exception
IOException thrown on any IO Error reading from the reader.