# All Classes and Interfaces

Class
Description
Article
Basic state needed for message retrieval and threading.
ArticleInfo
Class contains details about an article.
ArticlePointer
Deprecated.
3.0 use `ArticleInfo` instead
AuthenticatingIMAPClient
An IMAP Client class with authentication support.
AuthenticatingIMAPClient.AUTH_METHOD
The enumeration of currently-supported authentication methods.
AuthenticatingSMTPClient
An SMTP Client class with authentication support (RFC4954).
AuthenticatingSMTPClient.AUTH_METHOD
The enumeration of currently-supported authentication methods.
Base64
Deprecated.
Use `Base64`.
CharGenTCPClient
The CharGenTCPClient class is a TCP implementation of a client for the character generator protocol described in RFC 864.
CharGenUDPClient
The CharGenUDPClient class is a UDP implementation of a client for the character generator protocol described in RFC 864.
Charsets
Deprecated.
Use `Charsets`.
CompositeFileEntryParser
This implementation allows to pack some FileEntryParsers together and handle the case where the returned dir style isn't clearly defined.
Configurable
This interface adds the aspect of configurability by means of a supplied FTPClientConfig object to other classes in the system, especially listing parsers.
ConfigurableFTPFileEntryParserImpl
This abstract class implements the common timestamp parsing algorithm for all the concrete parsers.
CopyStreamAdapter
The CopyStreamAdapter will relay CopyStreamEvents to a list of listeners when either of its bytesTransferred() methods are called.
CopyStreamEvent
A CopyStreamEvent is triggered after every write performed by a stream copying operation.
CopyStreamException
The CopyStreamException class is thrown by the org.apache.commons.io.Util copyStream() methods.
CopyStreamListener
Accepts `CopyStreamEvent`s to track the progress of a stream copying operation.
CRLFLineReader
CRLFLineReader implements a readLine() method that requires exactly CRLF to terminate an input line.
DatagramSocketClient
The DatagramSocketClient provides the basic operations that are required of client objects accessing datagram sockets.
DatagramSocketFactory
The DatagramSocketFactory interface provides a means for the programmer to control the creation of datagram sockets and provide his own DatagramSocket implementations for use by all classes derived from `DatagramSocketClient` .
DaytimeTCPClient
The DaytimeTCPClient class is a TCP implementation of a client for the Daytime protocol described in RFC 867.
DaytimeUDPClient
The DaytimeUDPClient class is a UDP implementation of a client for the Daytime protocol described in RFC 867.
DefaultDatagramSocketFactory
Implements the DatagramSocketFactory interface by simply wrapping the `DatagramSocket` constructors.
DefaultFTPFileEntryParserFactory
This is the default implementation of the FTPFileEntryParserFactory interface.
DefaultSocketFactory
DefaultSocketFactory implements the SocketFactory interface by simply wrapping the java.net.Socket and java.net.ServerSocket constructors.
DiscardTCPClient
The DiscardTCPClient class is a TCP implementation of a client for the Discard protocol described in RFC 863.
DiscardUDPClient
The DiscardUDPClient class is a UDP implementation of a client for the Discard protocol described in RFC 863.
DotTerminatedMessageReader
DotTerminatedMessageReader is a class used to read messages from a server that are terminated by a single dot followed by a <CR><LF> sequence and with double dots appearing at the beginning of lines which do not signal end of message yet start with a dot.
DotTerminatedMessageWriter
DotTerminatedMessageWriter is a class used to write messages to a server that are terminated by a single dot followed by a <CR><LF> sequence and with double dots appearing at the beginning of lines which do not signal end of message yet start with a dot.
EchoOptionHandler
Implements the Telnet echo option RFC 857.
EchoTCPClient
The EchoTCPClient class is a TCP implementation of a client for the Echo protocol described in RFC 862.
EchoUDPClient
The EchoUDPClient class is a UDP implementation of a client for the Echo protocol described in RFC 862.
EnterpriseUnixFTPEntryParser
Parser for the Connect Enterprise Unix FTP Server From Sterling Commerce.
ExtendedPOP3Client
A POP3 Client class with protocol and authentication extensions support (RFC2449 and RFC2195).
ExtendedPOP3Client.AUTH_METHOD
The enumeration of currently-supported authentication methods.
FingerClient
The FingerClient class implements the client side of the Internet Finger Protocol defined in RFC 1288.
FromNetASCIIInputStream
This class wraps an input stream, replacing all occurrences of <CR><LF> (carriage return followed by a linefeed), which is the NETASCII standard for representing a newline, with the local line separator representation.
FromNetASCIIOutputStream
This class wraps an output stream, replacing all occurrences of <CR><LF> (carriage return followed by a linefeed), which is the NETASCII standard for representing a newline, with the local line separator representation.
FTP
FTP provides the basic the functionality necessary to implement your own FTP client.
FTPClient
FTPClient encapsulates all the functionality necessary to store and retrieve files from an FTP server.
FTPClient.HostnameResolver
Strategy interface for updating host names received from FTP server for passive NAT workaround.
FTPClient.NatServerResolverImpl
Default strategy for passive NAT workaround (site-local replies are replaced.)
FTPClientConfig
This class implements an alternate means of configuring the `FTPClient` object and also subordinate objects which it uses.
FTPCmd
Enumerates FTP commands.
FTPCommand
Deprecated.
Use `FTPCmd` instead
FTPConnectionClosedException
FTPConnectionClosedException is used to indicate the premature or unexpected closing of an FTP connection resulting from a `FTPReply.SERVICE_NOT_AVAILABLE` response (FTP reply code 421) to a failed FTP command.
FTPFile
The FTPFile class is used to represent information about files stored on an FTP server.
FTPFileEntryParser
FTPFileEntryParser defines the interface for parsing a single FTP file listing and converting that information into an `FTPFile` instance.
FTPFileEntryParserFactory
The interface describes a factory for creating FTPFileEntryParsers.
FTPFileEntryParserImpl
This abstract class implements both the older FTPFileListParser and newer FTPFileEntryParser interfaces with default functionality.
FTPFileFilter
Performs filtering on `FTPFile` instances.
FTPFileFilters
Implements some simple FTPFileFilter classes.
FTPHTTPClient
Experimental attempt at FTP client that tunnels over an HTTP proxy connection.
FTPListParseEngine
This class handles the entire process of parsing a listing of file entries from the server.
FTPReply
FTPReply stores a set of constants for FTP reply codes.
FTPSClient
FTP over SSL processing.
FTPSCommand
Deprecated.
3.0 DO NOT USE
FTPSServerSocketFactory
Server socket factory for FTPS connections.
FTPSSocketFactory
Socket factory for FTPS connections.
FTPSTrustManager
Deprecated.
3.0 use `TrustManagerUtils#getValidateServerCertificateTrustManager()` instead
FTPTimestampParser
This interface specifies the concept of parsing an FTP server's timestamp.
FTPTimestampParserImpl
Default implementation of the `FTPTimestampParser` interface also implements the `Configurable` interface to allow the parsing to be configured from the outside.
IMAP
The IMAP class provides the basic the functionality necessary to implement your own IMAP client.
IMAP.IMAPChunkListener
Implement this interface and register it via `IMAP.setChunkListener(IMAPChunkListener)` in order to get access to multi-line partial command responses.
IMAP.IMAPState
Enumerates IMAP states.
IMAPClient
The IMAPClient class provides the basic functionalities found in an IMAP client.
IMAPClient.FETCH_ITEM_NAMES
The message data item names for the FETCH command defined in RFC 3501.
IMAPClient.SEARCH_CRITERIA
The search criteria defined in RFC 3501.
IMAPClient.STATUS_DATA_ITEMS
The status data items defined in RFC 3501.
IMAPCommand
IMAPCommand stores IMAP command codes.
IMAPReply
Stores IMAP reply code constants.
IMAPSClient
The IMAPSClient class provides SSL/TLS connection encryption to IMAPClient.
InvalidTelnetOptionException
The InvalidTelnetOptionException is the exception that is thrown whenever a TelnetOptionHandler with an invlaid option code is registered in TelnetClient with addOptionHandler.
KeyManagerUtils
General KeyManager utilities
ListenerList<T>
A list of event listeners.
MacOsPeterFTPEntryParser
Implementation FTPFileEntryParser and FTPFileListParser for pre MacOS-X Systems.
MalformedServerReplyException
This exception is used to indicate that the reply from a server could not be interpreted.
MLSxEntryParser
Parses `MSLT` and `MLSD` replies.
MVSFTPEntryParser
Implements `FTPFileEntryParser` and `Configurable` for IBM zOS/MVS Systems.
NetConstants
Constants provided as public only for our own implementation, you can consider this private for now.
NetwareFTPEntryParser
Implements `FTPFileEntryParser` and `Configurable` for Netware Systems.
NewGroupsOrNewsQuery
The NewGroupsOrNewsQuery class.
NewsgroupInfo
NewsgroupInfo stores information pertaining to a newsgroup returned by the NNTP GROUP, LIST, and NEWGROUPS commands, implemented by `selectNewsgroup` , `listNewsgroups` , and `listNewNewsgroups` respectively.
NNTP
The NNTP class is not meant to be used by itself and is provided only so that you may easily implement your own NNTP client if you so desire.
NNTPClient
NNTPClient encapsulates all the functionality necessary to post and retrieve articles from an NNTP server.
NNTPCommand
NNTPCommand stores a set of constants for NNTP command codes.
NNTPConnectionClosedException
NNTPConnectionClosedException is used to indicate the premature or unexpected closing of an NNTP connection resulting from a `NNTPReply.SERVICE_DISCONTINUED` response (NNTP reply code 400) to a failed NNTP command.
NNTPReply
NNTPReply stores a set of constants for NNTP reply codes.
NTFTPEntryParser
Implements `FTPFileEntryParser` and `Configurable` for NT Systems.
NTPUDPClient
The NTPUDPClient class is a UDP implementation of a client for the Network Time Protocol (NTP) described in RFC 1305 as well as the Simple Network Time Protocol (SNTP) in RFC-2030.
NtpUtils
Common NtpUtils Helper class.
NtpV3Impl
Implements `NtpV3Packet` to convert Java objects to and from the Network Time Protocol (NTP) data message header format described in RFC-1305.
NtpV3Packet
Interface for a NtpV3Packet with get/set methods corresponding to the fields in the NTP Data Message Header described in RFC 1305.
OS2FTPEntryParser
Implements `FTPFileEntryParser` and `Configurable` for OS/2 Systems.
OS400FTPEntryParser
OS400 (IBM i) FTP entry parser.
ParserInitializationException
This class encapsulates all errors that may be thrown by the process of an FTPFileEntryParserFactory creating and instantiating an FTPFileEntryParser.
POP3
The POP3 class is not meant to be used by itself and is provided only so that you may easily implement your own POP3 client if you so desire.
POP3Client
The POP3Client class implements the client side of the Internet POP3 Protocol defined in RFC 1939.
POP3Command
POP3Command stores POP3 command code constants.
POP3MessageInfo
POP3MessageInfo is used to return information about messages stored on a POP3 server.
POP3Reply
POP3Reply stores POP3 reply code constants.
POP3SClient
POP3 over SSL processing.
PrintCommandListener
This is a support class for some example programs.
ProtocolCommandEvent
There exists a large class of IETF protocols that work by sending an ASCII text command and arguments to a server, and then receiving an ASCII text reply.
ProtocolCommandListener
There exists a large class of IETF protocols that work by sending an ASCII text command and arguments to a server, and then receiving an ASCII text reply.
ProtocolCommandSupport
ProtocolCommandSupport is a convenience class for managing a list of ProtocolCommandListeners and firing ProtocolCommandEvents.
RCommandClient
RCommandClient is very similar to `RExecClient`, from which it is derived, and implements the rcmd() facility that first appeared in 4.2BSD Unix. rcmd() is the facility used by the rsh (rshell) and other commands to execute a command on another machine from a trusted host without issuing a password.
RegexFTPFileEntryParserImpl
This abstract class implements both the older FTPFileListParser and newer FTPFileEntryParser interfaces with default functionality.
RelayPath
A class used to represent forward and reverse relay paths.
RExecClient
RExecClient implements the rexec() facility that first appeared in 4.2BSD Unix.
RLoginClient
RLoginClient is very similar to `RCommandClient`, from which it is derived, and uses the rcmd() facility implemented in RCommandClient to implement the functionality of the rlogin command that first appeared in 4.2BSD Unix. rlogin is a command used to log in to a remote machine from a trusted host, sometimes without issuing a password.
SimpleNNTPHeader
This class is used to construct the bare minimum acceptable header for most newsreaders.
SimpleOptionHandler
Simple option handler that can be used for options that don't require subnegotiation.
SimpleSMTPHeader
This class is used to construct a bare minimum acceptable header for an email message.
SMTP
SMTP provides the basic the functionality necessary to implement your own SMTP client.
SMTPClient
SMTPClient encapsulates all the functionality necessary to send files through an SMTP server.
SMTPCommand
SMTPCommand stores a set of constants for SMTP command codes.
SMTPConnectionClosedException
SMTPConnectionClosedException is used to indicate the premature or unexpected closing of an SMTP connection resulting from a `SMTPReply.SERVICE_NOT_AVAILABLE` response (SMTP reply code 421) to a failed SMTP command.
SMTPReply
SMTPReply stores a set of constants for SMTP reply codes.
SMTPSClient
SMTP over SSL processing.
SocketClient
The SocketClient provides the basic operations that are required of client objects accessing sockets.
SocketInputStream
This class wraps an input stream, storing a reference to its originating socket.
SocketOutputStream
This class wraps an output stream, storing a reference to its originating socket.
SSLContextUtils
General utilities for SSLContext.
SSLSocketUtils
General utilities for SSLSocket.
SubnetUtils
Performs subnet calculations given a network address and a subnet mask.
SubnetUtils6
Performs subnet calculations given an IPv6 network address and a prefix length.
SuppressGAOptionHandler
Implements the Telnet suppress go ahead option RFC 858.
TelnetClient
The TelnetClient class implements the simple network virtual terminal (NVT) for the Telnet protocol according to RFC 854.
TelnetCommand
The TelnetCommand class cannot be instantiated and only serves as a storehouse for Telnet command constants.
TelnetInputListener
Listener interface used for notification that incoming data is available to be read.
TelnetNotificationHandler
The TelnetNotificationHandler interface can be used to handle notification of options negotiation commands received on a Telnet session.
TelnetOption
The TelnetOption class cannot be instantiated and only serves as a storehouse for Telnet option constants.
TelnetOptionHandler
The TelnetOptionHandler class is the base class to be used for implementing handlers for Telnet options.
TerminalTypeOptionHandler
Implements the Telnet terminal type option RFC 1091.
TFTP
The TFTP class exposes a set of methods to allow you to deal with the TFTP protocol directly, in case you want to write your own TFTP client or server.
TFTPAckPacket
A final class derived from TFTPPacket defining the TFTP Acknowledgement packet type.
TFTPClient
The TFTPClient class encapsulates all the aspects of the TFTP protocol necessary to receive and send files through TFTP.
TFTPDataPacket
A final class derived from TFTPPacket defining the TFTP Data packet type.
TFTPErrorPacket
A final class derived from TFTPPacket defining the TFTP Error packet type.
TFTPPacket
TFTPPacket is an abstract class encapsulating the functionality common to the 5 types of TFTP packets.
TFTPPacketException
A class used to signify the occurrence of an error in the creation of a TFTP packet.
TFTPReadRequestPacket
A class derived from TFTPRequestPacket defining a TFTP read request packet type.
TFTPRequestPacket
An abstract class derived from TFTPPacket definiing a TFTP Request packet type.
TFTPWriteRequestPacket
A class derived from TFTPRequestPacket defining a TFTP write request packet type.
Threadable<T>
A placeholder interface for threadable message objects.
Threader
This is an implementation of a message threading algorithm, as originally devised by Zamie Zawinski.
TimeInfo
Wrapper class to network time packet messages (NTP, etc.) that computes related timing info and stats.
TimeStamp
TimeStamp class represents the Network Time Protocol (NTP) timestamp as defined in RFC-1305 and SNTP (RFC-2030).
TimeTCPClient
The TimeTCPClient class is a TCP implementation of a client for the Time protocol described in RFC 868.
TimeUDPClient
The TimeUDPClient class is a UDP implementation of a client for the Time protocol described in RFC 868.
ToNetASCIIInputStream
This class wraps an input stream, replacing all singly occurring <LF> (linefeed) characters with <CR><LF> (carriage return followed by linefeed), which is the NETASCII standard for representing a newline.
ToNetASCIIOutputStream
This class wraps an output stream, replacing all singly occurring <LF> (linefeed) characters with <CR><LF> (carriage return followed by linefeed), which is the NETASCII standard for representing a newline.
TrustManagerUtils
TrustManager utilities for generating TrustManagers.
UnixFTPEntryParser
Implementation FTPFileEntryParser and FTPFileListParser for standard Unix Systems.
Util
The Util class cannot be instantiated and stores short static convenience methods that are often quite useful.
VMSFTPEntryParser
Implementation FTPFileEntryParser and FTPFileListParser for VMS Systems.
VMSVersioningFTPEntryParser
Special implementation VMSFTPEntryParser with versioning turned on.
WhoisClient
The WhoisClient class implements the client side of the Internet Whois Protocol defined in RFC 954.
WindowSizeOptionHandler
Implements the Telnet window size option RFC 1073.