| Home >> All >> org >> apache >> commons >> net >> [ ftp Javadoc ] |
| • | org.apache.commons.net.ftp.ftp2.* (17) | • | org.apache.commons.net.ftp.ftp2.parser.* (13) |
| • | org.apache.commons.net.ftp.parser.* (29) |
• org.apache.commons.net.ftp: Javadoc index of package org.apache.commons.net.ftp.
Package Samples:
• org.apache.commons.net.ftp.ftp2
• org.apache.commons.net.ftp.ftp2.parser
• org.apache.commons.net.ftp.parser
Classes:
• FTPClient: 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 55 before doing anything, and finally disconnect 55 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; ...
• FTPClientConfig: This class implements an alternate means of configuring the FTPClient object and also subordinate objects which it uses. Any class implementing the Configurable interface can be configured by this object. In particular this class was designed primarily to support configuration of FTP servers which express file timestamps in formats and languages other than those for the US locale, which although it is the most common is not universal. Unfortunately, nothing in the FTP spec allows this to be determined in an automated way, so manual configuration such as this is necessary. This functionality was ...
• FTP: FTP provides the basic the functionality necessary to implement your own FTP client. It extends org.apache.commons.net.TelnetClient simply because it saves the writing of extra code to handle the FTP control connection which always remains open during an FTP session and uses the Telnet protocol. Aggregation would require writing new wrapper methods and wouldn't leverage the functionality already present in org.apache.commons.net.SocketClient. To derive the full benefits of the FTP class requires some knowledge of the FTP protocol defined in RFC 959. However, there is no reason why you should have ...
• FTPFileEntryParser: FTPFileEntryParser defines the interface for parsing a single FTP file listing and converting that information into an 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 ...
• VMSFTPEntryParser: This Class uses the FTPEntryParser class to validate the input string. It also requires the NetComponents library version 1.3.7 or later and the OROMatcher library for the regualar expressions stuff. USAGE: Create an instance of VMSFTPEntryParser VMSFTPEntryParser parser = new VMSFTPEntryParser(boolean); True = returns all versions of a file with the respective ;# False = only the last version will return (Default) Create an instance of FTPClient FTPClient FTPClientObj = new FTPClient(); Connect to the NODE FTPClientObj.connect(); Login to the NODE FTPClientObj.login(username,password); Switch ...
• FTPListParseEngine: This class handles the entire process of parsing a listing of file entries from the server. This object defines a two-part parsing mechanism. The first part is comprised of reading the raw input into an internal list of strings. Every item in this list corresponds to an actual file. All extraneous matter emitted by the server will have been removed by the end of this phase. This is accomplished in conjunction with the FTPFileEntryParser associated with this engine, by calling its methods readNextEntry() - which handles the issue of what delimits one entry from another, usually but not always a ...
• OS2FTPEntryParser: This Class uses the ListParser class to validate the input string. It also requires the NetComponents library version 1.3.7 or later and the OROMatcher library for the regualar expressions stuff. USAGE: Create an instance of OS2FTPEntryParser OS2FTPEntryParser parser = new OS2FTPEntryParser(); Create an instance of FTPClient FTPClient FTPClientObj = new FTPClient(); Connect to the NODE FTPClientObj.connect(); Login to the NODE FTPClientObj.login(username,password); Switch directories if you have to FTPClientObj.changeWorkingDirectory(thePath); You might want to check if you are truly in a OS2 System ...
• NTFTPEntryParser: This Class uses the ListParser class to validate the input string. It also requires the NetComponents library version 1.3.7 or later and the OROMatcher library for the regualar expressions stuff. USAGE: Create an instance of NTListParser NTListParser parser = new NTListParser(); Create an instance of FTPClient FTPClient FTPClientObj = new FTPClient(); Connect to the NODE FTPClientObj.connect(); Login to the NODE FTPClientObj.login(username,password); Switch directories if you have to FTPClientObj.changeWorkingDirectory(thePath); You might want to check if you are truly in a NT System String am_I_NT ...
• FTPFile: The FTPFile class is used to represent information about files stored on an FTP server. Because there is no standard representation for file information on FTP servers, it may not always be possible to extract all the information that can be represented by FTPFile, or it may even be possible to extract more information. In cases where more information can be extracted, you will want to subclass FTPFile and implement your own FTPFileListParser to extract the information. However, most FTP servers return file information in a format that can be completely parsed by DefaultFTPFileListParser and stored ...
• FTPFileList: FTPFileList.java This class encapsulates a listing of files from an FTP server. It is initialized with an input stream which is read and the input split into lines, each of which (after some possible initial verbiage) represents a file on the FTP server. A parser is also supplied, which is used to iterate through the internal list of lines parsing each into an FTPFile object which is returned to the caller of the iteration methods. This parser may be replaced with another, allowing the same list to be parsed with different parsers. Parsing takes place on an as-needed basis, basically, the first ...
• FTPFileList: This class encapsulates a listing of files from an FTP server. It is initialized with an input stream which is read and the input split into lines, each of which (after some possible initial verbiage) represents a file on the FTP server. A parser is also supplied, which is used to iterate through the internal list of lines parsing each into an FTPFile object which is returned to the caller of the iteration methods. This parser may be replaced with another, allowing the same list to be parsed with different parsers. Parsing takes place on an as-needed basis, basically, the first time a position ...
• DefaultFTPFileListParser: DefaultFTPFileListParser is the default implementation of FTPFileListParser used by FTPClient to parse file listings. Sometimes you will want to parse unusual listing formats, in which case you would create your own implementation of FTPFileListParser and if necessary, subclass FTPFile. As of version 1.2, this class merely extends UnixFTPEntryParser. It will be removed in version 2.0.
• VMSFTPEntryParser: Implementation FTPFileEntryParser and FTPFileListParser for VMS Systems. This is a sample of VMS LIST output "1-JUN.LIS;1 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", "1-JUN.LIS;2 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", "DATA.DIR;1 1/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", Note: VMSFTPEntryParser can only be instantiated through the DefaultFTPParserFactory by classname. It will not be chosen by the autodetection scheme.
• VMSVersioningFTPEntryParser: Special implementation VMSFTPEntryParser with versioning turned on. This parser removes all duplicates and only leaves the version with the highest version number for each filename. This is a sample of VMS LIST output "1-JUN.LIS;1 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", "1-JUN.LIS;2 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", "DATA.DIR;1 1/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)",
• FTPClient2: FTPClient2.java This class is derived by design from Daniel Savarese's FTPClient. It is designed to have all the same functionality, but add support for a new alternative design for File List Parsing. There is no reason why this could not have been included in FTPClient, but it is a fairly sizable chunk of code and given that the community process for this project is still a work in progress I thought it would be better to keep a fairly clear line between the old and the new; it's less confusing that way.
• FTPCommand: FTPCommand stores a set of constants for FTP command codes. To interpret the meaning of the codes, familiarity with RFC 959 is assumed. The mnemonic constant names are transcriptions from the code descriptions of RFC 959. For those who think in terms of the actual FTP commands, a set of constants such as USER 55 are provided where the constant name is the same as the FTP command.
• FTPConnectionClosedException: FTPConnectionClosedException is used to indicate the premature or unexpected closing of an FTP connection resulting from a FTPReply.SERVICE_NOT_AVAILABLE 55 response (FTP reply code 421) to a failed FTP command. This exception is derived from IOException and therefore may be caught either as an IOException or specifically as an FTPConnectionClosedException.
• FTPFileListParser: FTPFileListParser defines the interface for parsing FTP file listings and converting that information into an array of FTPFile instances. Sometimes you will want to parse unusual listing formats, in which case you would create your own implementation of FTPFileListParser and if necessary, subclass FTPFile.
• FTPFileEntryParser: FTPFileEntryParser defines the interface for parsing a single FTP file listing and converting that information into an 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.
• EnterpriseUnixFTPEntryParser: Parser for the Connect Enterprise Unix FTP Server From Sterling Commerce. Here is a sample of the sort of output line this parser processes: "-C--E-----FTP B QUA1I1 18128 41 Aug 12 13:56 QUADTEST" Note: EnterpriseUnixFTPEntryParser can only be instantiated through the DefaultFTPParserFactory by classname. It will not be chosen by the autodetection scheme.
• FTPReply: FTPReply stores a set of constants for FTP reply codes. To interpret the meaning of the codes, familiarity with RFC 959 is assumed. The mnemonic constant names are transcriptions from the code descriptions of RFC 959. For those who think in terms of the actual reply code values, a set of CODE_NUM constants are provided where NUM is the numerical value of the code.
• FTPTimestampParserImpl: Default implementation of the FTPTimestampParser interface also implements the Configurable interface to allow the parsing to be configured from the outside.
• FTPConfigEntryParserTest: This is a simple TestCase that tests entry parsing using the new FTPClientConfig mechanism. The normal FTPClient cannot handle the different date formats in these entries, however using a configurable format, we can handle it easily. The original system presenting this issue was an AIX system - see bug #27437 for details.
• FTPFileIterator: FTPFileIterator.java This class implements a bidirectional iterator over an FTPFileList. Elements may be retrieved one at at time using the hasNext() - next() syntax familiar from Java 2 collections. Alternatively, entries may be receieved as an array of any requested number of entries or all of them.
• MatchApparatus: This class is based on the logic of Winston Ojeda's ListParser. It uses a similar approach to Regular Expressions but is designed to fit within FTPFileEntryParser design rather than the FTPFileListParser design. It is also designed to encapsulate access to the oro.text.regex classes in one place.
| Home | Contact Us | Privacy Policy | Terms of Service |