| org.apache.commons.net.telnet.TelnetClient
 org.apache.commons.net.ftp.FTP
All known Subclasses: org.apache.commons.net.ftp.FTPClient,
| FTP | | public class FTP extends TelnetClient (Code) | | 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 to use the FTP class. The
org.apache.commons.net.ftp.FTPClient class,
derived from FTP,
implements all the functionality required of an FTP client. The
FTP class is made public to provide access to various FTP constants
and to make it easier for adventurous programmers (or those with
special needs) to interact with the FTP protocol and implement their
own clients. A set of methods with names corresponding to the FTP
command names are provided to facilitate this interaction.
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 FTP 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 . FTPConectionClosedException
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
FTP.disconnect disconnect() to properly clean up the
system resources used by FTP. Before disconnecting, you may check the
last reply code and text with
FTP.getReplyCode getReplyCode ,
FTP.getReplyString getReplyString ,
and
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.
author:
Daniel F. Savarese
See Also: FTPClient
See Also: FTPConnectionClosedException
See Also: org.apache.commons.net.MalformedServerReplyException |
| Field Summary | |
| final public static int | ASCII_FILE_TYPE
A constant used to indicate the file(s) being transfered should
be treated as ASCII. | | final public static int | BINARY_FILE_TYPE
A constant used to indicate the file(s) being transfered should
be treated as a binary image, i.e., no translations should be
performed. | | final public static int | BLOCK_TRANSFER_MODE
A constant used to indicate a file is to be transfered as a series
of blocks. | | final public static int | CARRIAGE_CONTROL_TEXT_FORMAT
A constant used to indicate a text file contains ASA vertical format
control characters. | | final public static int | COMPRESSED_TRANSFER_MODE
A constant used to indicate a file is to be transfered as FTP
compressed data. | | final public static String | DEFAULT_CONTROL_ENCODING
The default character encoding used for communicating over an
FTP control connection. | | final public static int | DEFAULT_DATA_PORT
The default FTP data port (20). | | final public static int | DEFAULT_PORT
The default FTP control port (21). | | final public static int | EBCDIC_FILE_TYPE
A constant used to indicate the file(s) being transfered should
be treated as EBCDIC. | | final public static int | FILE_STRUCTURE
A constant used to indicate a file is to be treated as a continuous
sequence of bytes. | | final public static int | IMAGE_FILE_TYPE
A constant used to indicate the file(s) being transfered should
be treated as a binary image, i.e., no translations should be
performed. | | final public static int | LOCAL_FILE_TYPE
A constant used to indicate the file(s) being transfered should
be treated as a local type. | | final public static int | NON_PRINT_TEXT_FORMAT
A constant used for text files to indicate a non-print text format. | | final public static int | PAGE_STRUCTURE
A constant used to indicate a file is to be treated as a set of
independent indexed pages. | | final public static int | RECORD_STRUCTURE
A constant used to indicate a file is to be treated as a sequence
of records. | | final public static int | STREAM_TRANSFER_MODE
A constant used to indicate a file is to be transfered as a stream
of bytes. | | final public static int | TELNET_TEXT_FORMAT
A constant used to indicate a text file contains format vertical format
control characters. | | protected ProtocolCommandSupport | _commandSupport_
A ProtocolCommandSupport object used to manage the registering of
ProtocolCommandListeners and te firing of ProtocolCommandEvents. | | String | _controlEncoding
| | BufferedReader | _controlInput
| | BufferedWriter | _controlOutput
| | boolean | _newReplyString
| | int | _replyCode
| | Vector | _replyLines
| | String | _replyString
|
| Constructor Summary | |
| public | FTP()
The default FTP constructor. |
| Method Summary | |
| protected void | _connectAction_()
| | public int | abor()
A convenience method to send the FTP ABOR command to the server,
receive the reply, and return the reply code.
The reply code received from 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. | | public int | acct(String account)
A convenience method to send the FTP ACCT command to the server,
receive the reply, and return the reply code.
Parameters:
account - The account name to access. | | public void | addProtocolCommandListener(ProtocolCommandListener listener)
Adds a ProtocolCommandListener. | | public int | allo(int bytes)
A convenience method to send the FTP ALLO command to the server,
receive the reply, and return the reply code.
Parameters:
bytes - The number of bytes to allocate. | | public int | allo(int bytes, int recordSize)
A convenience method to send the FTP ALLO command to the server,
receive the reply, and return the reply code.
Parameters:
bytes - The number of bytes to allocate.
Parameters:
recordSize - The size of a record. | | public int | appe(String pathname)
A convenience method to send the FTP APPE command to the server,
receive the reply, and return the reply code. | | public int | cdup()
A convenience method to send the FTP CDUP command to the server,
receive the reply, and return the reply code.
The reply code received from 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. | | public int | cwd(String directory)
A convenience method to send the FTP CWD command to the server,
receive the reply, and return the reply code.
Parameters:
directory - The new working directory. | | public int | dele(String pathname)
A convenience method to send the FTP DELE command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname to delete. | | public void | disconnect()
Closes the control connection to the FTP server and sets to null
some internal data so that the memory may be reclaimed by the
garbage collector. | | public String | getControlEncoding()
| | public int | getReply()
Fetches a reply from the FTP server and returns the integer reply
code. | | public int | getReplyCode()
Returns the integer value of the reply code of the last FTP reply. | | public String | getReplyString()
Returns the entire text of the last FTP server response exactly
as it was received, including all end of line markers in NETASCII
format. | | public String[] | getReplyStrings()
Returns the lines of text from the last FTP server response as an array
of strings, one entry per line. | | public int | help()
A convenience method to send the FTP HELP command to the server,
receive the reply, and return the reply code.
The reply code received from 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. | | public int | help(String command)
A convenience method to send the FTP HELP command to the server,
receive the reply, and return the reply code.
Parameters:
command - The command name on which to request help. | | public int | list()
A convenience method to send the FTP LIST command to the server,
receive the reply, and return the reply code. | | public int | list(String pathname)
A convenience method to send the FTP LIST command to the server,
receive the reply, and return the reply code. | | public int | mkd(String pathname)
A convenience method to send the FTP MKD command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname of the new directory to create. | | public int | mode(int mode)
A convenience method to send the FTP MODE command to the server,
receive the reply, and return the reply code.
Parameters:
mode - The transfer mode to use (one of theTRANSFER_MODE constants). | | public int | nlst()
A convenience method to send the FTP NLST command to the server,
receive the reply, and return the reply code. | | public int | nlst(String pathname)
A convenience method to send the FTP NLST command to the server,
receive the reply, and return the reply code. | | public int | noop()
A convenience method to send the FTP NOOP command to the server,
receive the reply, and return the reply code.
The reply code received from 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. | | public int | pass(String password)
A convenience method to send the FTP PASS command to the server,
receive the reply, and return the reply code.
Parameters:
password - The plain text password of the username being logged into. | | public int | pasv()
A convenience method to send the FTP PASV command to the server,
receive the reply, and return the reply code. | | public int | port(InetAddress host, int port)
A convenience method to send the FTP PORT command to the server,
receive the reply, and return the reply code.
Parameters:
host - The host owning the port.
Parameters:
port - The new port. | | public int | pwd()
A convenience method to send the FTP PWD command to the server,
receive the reply, and return the reply code.
The reply code received from 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. | | public int | quit()
A convenience method to send the FTP QUIT command to the server,
receive the reply, and return the reply code.
The reply code received from 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. | | public int | rein()
A convenience method to send the FTP REIN command to the server,
receive the reply, and return the reply code.
The reply code received from 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. | | public void | removeProtocolCommandListener(ProtocolCommandListener listener)
Removes a ProtocolCommandListener. | | public int | rest(String marker)
A convenience method to send the FTP REST command to the server,
receive the reply, and return the reply code.
Parameters:
marker - The marker at which to restart a transfer. | | public int | retr(String pathname)
A convenience method to send the FTP RETR command to the server,
receive the reply, and return the reply code. | | public int | rmd(String pathname)
A convenience method to send the FTP RMD command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname of the directory to remove. | | public int | rnfr(String pathname)
A convenience method to send the FTP RNFR command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname to rename from. | | public int | rnto(String pathname)
A convenience method to send the FTP RNTO command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname to rename to The reply code received from 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. | | public int | sendCommand(String command, String args)
Sends an FTP command to the server, waits for a reply and returns the
numerical response code. | | public int | sendCommand(int command, String args)
Sends an FTP command to the server, waits for a reply and returns the
numerical response code. | | public int | sendCommand(String command)
Sends an FTP command with no arguments to the server, waits for a
reply and returns the numerical response code. | | public int | sendCommand(int command)
Sends an FTP command with no arguments to the server, waits for a
reply and returns the numerical response code. | | public void | setControlEncoding(String encoding)
Sets the character encoding used by the FTP control connection. | | public int | site(String parameters)
A convenience method to send the FTP SITE command to the server,
receive the reply, and return the reply code.
Parameters:
parameters - The site parameters to send. | | public int | smnt(String dir)
A convenience method to send the FTP SMNT command to the server,
receive the reply, and return the reply code.
Parameters:
dir - The directory name. | | public int | stat()
A convenience method to send the FTP STAT command to the server,
receive the reply, and return the reply code.
The reply code received from 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. | | public int | stat(String pathname)
A convenience method to send the FTP STAT command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - A pathname to list. | | public int | stor(String pathname)
A convenience method to send the FTP STOR command to the server,
receive the reply, and return the reply code. | | public int | stou()
A convenience method to send the FTP STOU command to the server,
receive the reply, and return the reply code. | | public int | stou(String pathname)
A convenience method to send the FTP STOU command to the server,
receive the reply, and return the reply code. | | public int | stru(int structure)
A convenience method to send the FTP STRU command to the server,
receive the reply, and return the reply code.
Parameters:
structure - The structure of the file (one of the_STRUCTURE constants). | | public int | syst()
A convenience method to send the FTP SYST command to the server,
receive the reply, and return the reply code.
The reply code received from 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. | | public int | type(int fileType, int formatOrByteSize)
A convenience method to send the FTP TYPE command for text files
to the server, receive the reply, and return the reply code.
Parameters:
fileType - The type of the file (one of the FILE_TYPEconstants).
Parameters:
formatOrByteSize - The format of the file (one of the_FORMAT constants. | | public int | type(int fileType)
A convenience method to send the FTP TYPE command to the server,
receive the reply, and return the reply code.
Parameters:
fileType - The type of the file (one of the FILE_TYPEconstants). | | public int | user(String username)
A convenience method to send the FTP USER command to the server,
receive the reply, and return the reply code.
Parameters:
username - The username to login under. |
| ASCII_FILE_TYPE | | final public static int ASCII_FILE_TYPE(Code) | | A constant used to indicate the file(s) being transfered should
be treated as ASCII. This is the default file type. All constants
ending in FILE_TYPE are used to indicate file types.
|
| BINARY_FILE_TYPE | | final public static int BINARY_FILE_TYPE(Code) | | A constant used to indicate the file(s) being transfered should
be treated as a binary image, i.e., no translations should be
performed. All constants ending in FILE_TYPE are used to
indicate file types.
|
| BLOCK_TRANSFER_MODE | | final public static int BLOCK_TRANSFER_MODE(Code) | | A constant used to indicate a file is to be transfered as a series
of blocks. All constants ending in TRANSFER_MODE are used
to indicate file transfer modes.
|
| CARRIAGE_CONTROL_TEXT_FORMAT | | final public static int CARRIAGE_CONTROL_TEXT_FORMAT(Code) | | A constant used to indicate a text file contains ASA vertical format
control characters.
All constants ending in TEXT_FORMAT are used to indicate
text formatting for text transfers (both ASCII and EBCDIC).
|
| COMPRESSED_TRANSFER_MODE | | final public static int COMPRESSED_TRANSFER_MODE(Code) | | A constant used to indicate a file is to be transfered as FTP
compressed data. All constants ending in TRANSFER_MODE
are used to indicate file transfer modes.
|
| DEFAULT_CONTROL_ENCODING | | final public static String DEFAULT_CONTROL_ENCODING(Code) | | The default character encoding used for communicating over an
FTP control connection. The default encoding is an
ASCII-compatible encoding. Some FTP servers expect other
encodings. You can change the encoding used by an FTP instance
with
FTP.setControlEncoding setControlEncoding .
|
| DEFAULT_DATA_PORT | | final public static int DEFAULT_DATA_PORT(Code) | | The default FTP data port (20). **
|
| DEFAULT_PORT | | final public static int DEFAULT_PORT(Code) | | The default FTP control port (21). **
|
| EBCDIC_FILE_TYPE | | final public static int EBCDIC_FILE_TYPE(Code) | | A constant used to indicate the file(s) being transfered should
be treated as EBCDIC. Note however that there are several different
EBCDIC formats. All constants ending in FILE_TYPE
are used to indicate file types.
|
| FILE_STRUCTURE | | final public static int FILE_STRUCTURE(Code) | | A constant used to indicate a file is to be treated as a continuous
sequence of bytes. This is the default structure. All constants ending
in _STRUCTURE are used to indicate file structure for
file transfers.
|
| IMAGE_FILE_TYPE | | final public static int IMAGE_FILE_TYPE(Code) | | A constant used to indicate the file(s) being transfered should
be treated as a binary image, i.e., no translations should be
performed. All constants ending in FILE_TYPE are used to
indicate file types.
|
| LOCAL_FILE_TYPE | | final public static int LOCAL_FILE_TYPE(Code) | | A constant used to indicate the file(s) being transfered should
be treated as a local type. All constants ending in
FILE_TYPE are used to indicate file types.
|
| NON_PRINT_TEXT_FORMAT | | final public static int NON_PRINT_TEXT_FORMAT(Code) | | A constant used for text files to indicate a non-print text format.
This is the default format.
All constants ending in TEXT_FORMAT are used to indicate
text formatting for text transfers (both ASCII and EBCDIC).
|
| PAGE_STRUCTURE | | final public static int PAGE_STRUCTURE(Code) | | A constant used to indicate a file is to be treated as a set of
independent indexed pages. All constants ending in
_STRUCTURE are used to indicate file structure for file
transfers.
|
| RECORD_STRUCTURE | | final public static int RECORD_STRUCTURE(Code) | | A constant used to indicate a file is to be treated as a sequence
of records. All constants ending in _STRUCTURE
are used to indicate file structure for file transfers.
|
| STREAM_TRANSFER_MODE | | final public static int STREAM_TRANSFER_MODE(Code) | | A constant used to indicate a file is to be transfered as a stream
of bytes. This is the default transfer mode. All constants ending
in TRANSFER_MODE are used to indicate file transfer
modes.
|
| TELNET_TEXT_FORMAT | | final public static int TELNET_TEXT_FORMAT(Code) | | A constant used to indicate a text file contains format vertical format
control characters.
All constants ending in TEXT_FORMAT are used to indicate
text formatting for text transfers (both ASCII and EBCDIC).
|
| _commandSupport_ | | protected ProtocolCommandSupport _commandSupport_(Code) | | A ProtocolCommandSupport object used to manage the registering of
ProtocolCommandListeners and te firing of ProtocolCommandEvents.
|
| _newReplyString | | boolean _newReplyString(Code) | | |
| _replyCode | | int _replyCode(Code) | | |
| FTP | | public FTP()(Code) | | The default FTP constructor. Sets the default port to
DEFAULT_PORT and initializes internal data structures
for saving FTP reply information.
|
| abor | | public int abor() throws IOException(Code) | | A convenience method to send the FTP ABOR command to the server,
receive the reply, and return the reply code.
The reply code received from 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 thecommand or receiving the server reply. |
| acct | | public int acct(String account) throws IOException(Code) | | A convenience method to send the FTP ACCT command to the server,
receive the reply, and return the reply code.
Parameters:
account - The account name to access. The reply code received from 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 thecommand or receiving the server reply. |
| addProtocolCommandListener | | public void addProtocolCommandListener(ProtocolCommandListener listener)(Code) | | Adds a ProtocolCommandListener. Delegates this task to
FTP._commandSupport_ _commandSupport_ .
Parameters:
listener - The ProtocolCommandListener to add. |
| allo | | public int allo(int bytes) throws IOException(Code) | | A convenience method to send the FTP ALLO command to the server,
receive the reply, and return the reply code.
Parameters:
bytes - The number of bytes to allocate. The reply code received from 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 thecommand or receiving the server reply. |
| allo | | public int allo(int bytes, int recordSize) throws IOException(Code) | | A convenience method to send the FTP ALLO command to the server,
receive the reply, and return the reply code.
Parameters:
bytes - The number of bytes to allocate.
Parameters:
recordSize - The size of a record. The reply code received from 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 thecommand or receiving the server reply. |
| appe | | public int appe(String pathname) throws IOException(Code) | | A convenience method to send the FTP APPE command to the server,
receive the reply, and return the reply code. Remember, it is up
to you to manage the data connection. If you don't need this low
level of access, use
org.apache.commons.net.ftp.FTPClient , which will handle all low level details for you.
Parameters:
pathname - The pathname to use for the file when stored atthe remote end of the transfer. The reply code received from 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 thecommand or receiving the server reply. |
| cdup | | public int cdup() throws IOException(Code) | | A convenience method to send the FTP CDUP command to the server,
receive the reply, and return the reply code.
The reply code received from 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 thecommand or receiving the server reply. |
| cwd | | public int cwd(String directory) throws IOException(Code) | | A convenience method to send the FTP CWD command to the server,
receive the reply, and return the reply code.
Parameters:
directory - The new working directory. The reply code received from 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 thecommand or receiving the server reply. |
| dele | | public int dele(String pathname) throws IOException(Code) | | A convenience method to send the FTP DELE command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname to delete. The reply code received from 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 thecommand or receiving the server reply. |
| disconnect | | public void disconnect() throws IOException(Code) | | Closes the control connection to the FTP server and sets to null
some internal data so that the memory may be reclaimed by the
garbage collector. The reply text and code information from the
last command is voided so that the memory it used may be reclaimed.
exception:
IOException - If an error occurs while disconnecting. |
| getControlEncoding | | public String getControlEncoding()(Code) | | The character encoding used to communicate over thecontrol connection. |
| getReply | | public int getReply() throws IOException(Code) | | Fetches a reply from the FTP server and returns the integer reply
code. After calling this method, the actual reply text can be accessed
from either calling
FTP.getReplyString getReplyString or
FTP.getReplyStrings getReplyStrings . Only use this
method if you are implementing your own FTP client or if you need to
fetch a secondary response from the FTP server.
The integer value of the reply code of the fetched FTP reply.
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 receiving theserver reply. |
| getReplyCode | | public int getReplyCode()(Code) | | Returns the integer value of the reply code of the last FTP reply.
You will usually only use this method after you connect to the
FTP server to check that the connection was successful since
connect is of type void.
The integer value of the reply code of the last FTP reply. |
| getReplyString | | public String getReplyString()(Code) | | Returns the entire text of the last FTP server response exactly
as it was received, including all end of line markers in NETASCII
format.
The entire text from the last FTP response as a String. |
| getReplyStrings | | public String[] getReplyStrings()(Code) | | Returns the lines of text from the last FTP server response as an array
of strings, one entry per line. The end of line markers of each are
stripped from each line.
The lines of text from the last FTP response as an array. |
| help | | public int help() throws IOException(Code) | | A convenience method to send the FTP HELP command to the server,
receive the reply, and return the reply code.
The reply code received from 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 thecommand or receiving the server reply. |
| help | | public int help(String command) throws IOException(Code) | | A convenience method to send the FTP HELP command to the server,
receive the reply, and return the reply code.
Parameters:
command - The command name on which to request help. The reply code received from 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 thecommand or receiving the server reply. |
| list | | public int list() throws IOException(Code) | | A convenience method to send the FTP LIST command to the server,
receive the reply, and return the reply code. Remember, it is up
to you to manage the data connection. If you don't need this low
level of access, use
org.apache.commons.net.ftp.FTPClient , which will handle all low level details for you.
The reply code received from 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 thecommand or receiving the server reply. |
| list | | public int list(String pathname) throws IOException(Code) | | A convenience method to send the FTP LIST command to the server,
receive the reply, and return the reply code. Remember, it is up
to you to manage the data connection. If you don't need this low
level of access, use
org.apache.commons.net.ftp.FTPClient , which will handle all low level details for you.
Parameters:
pathname - The pathname to list. The reply code received from 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 thecommand or receiving the server reply. |
| mkd | | public int mkd(String pathname) throws IOException(Code) | | A convenience method to send the FTP MKD command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname of the new directory to create. The reply code received from 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 thecommand or receiving the server reply. |
| mode | | public int mode(int mode) throws IOException(Code) | | A convenience method to send the FTP MODE command to the server,
receive the reply, and return the reply code.
Parameters:
mode - The transfer mode to use (one of theTRANSFER_MODE constants). The reply code received from 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 thecommand or receiving the server reply. |
| nlst | | public int nlst() throws IOException(Code) | | A convenience method to send the FTP NLST command to the server,
receive the reply, and return the reply code. Remember, it is up
to you to manage the data connection. If you don't need this low
level of access, use
org.apache.commons.net.ftp.FTPClient , which will handle all low level details for you.
The reply code received from 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 thecommand or receiving the server reply. |
| nlst | | public int nlst(String pathname) throws IOException(Code) | | A convenience method to send the FTP NLST command to the server,
receive the reply, and return the reply code. Remember, it is up
to you to manage the data connection. If you don't need this low
level of access, use
org.apache.commons.net.ftp.FTPClient , which will handle all low level details for you.
Parameters:
pathname - The pathname to list. The reply code received from 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 thecommand or receiving the server reply. |
| noop | | public int noop() throws IOException(Code) | | A convenience method to send the FTP NOOP command to the server,
receive the reply, and return the reply code.
The reply code received from 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 thecommand or receiving the server reply. |
| pass | | public int pass(String password) throws IOException(Code) | | A convenience method to send the FTP PASS command to the server,
receive the reply, and return the reply code.
Parameters:
password - The plain text password of the username being logged into. The reply code received from 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 thecommand or receiving the server reply. |
| pasv | | public int pasv() throws IOException(Code) | | A convenience method to send the FTP PASV command to the server,
receive the reply, and return the reply code. Remember, it's up
to you to interpret the reply string containing the host/port
information.
The reply code received from 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 thecommand or receiving the server reply. |
| port | | public int port(InetAddress host, int port) throws IOException(Code) | | A convenience method to send the FTP PORT command to the server,
receive the reply, and return the reply code.
Parameters:
host - The host owning the port.
Parameters:
port - The new port. The reply code received from 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 thecommand or receiving the server reply. |
| pwd | | public int pwd() throws IOException(Code) | | A convenience method to send the FTP PWD command to the server,
receive the reply, and return the reply code.
The reply code received from 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 thecommand or receiving the server reply. |
| quit | | public int quit() throws IOException(Code) | | A convenience method to send the FTP QUIT command to the server,
receive the reply, and return the reply code.
The reply code received from 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 thecommand or receiving the server reply. |
| rein | | public int rein() throws IOException(Code) | | A convenience method to send the FTP REIN command to the server,
receive the reply, and return the reply code.
The reply code received from 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 thecommand or receiving the server reply. |
| removeProtocolCommandListener | | public void removeProtocolCommandListener(ProtocolCommandListener listener)(Code) | | Removes a ProtocolCommandListener. Delegates this task to
FTP._commandSupport_ _commandSupport_ .
Parameters:
listener - The ProtocolCommandListener to remove. |
| rest | | public int rest(String marker) throws IOException(Code) | | A convenience method to send the FTP REST command to the server,
receive the reply, and return the reply code.
Parameters:
marker - The marker at which to restart a transfer. The reply code received from 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 thecommand or receiving the server reply. |
| retr | | public int retr(String pathname) throws IOException(Code) | | A convenience method to send the FTP RETR command to the server,
receive the reply, and return the reply code. Remember, it is up
to you to manage the data connection. If you don't need this low
level of access, use
org.apache.commons.net.ftp.FTPClient , which will handle all low level details for you.
Parameters:
pathname - The pathname of the file to retrieve. The reply code received from 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 thecommand or receiving the server reply. |
| rmd | | public int rmd(String pathname) throws IOException(Code) | | A convenience method to send the FTP RMD command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname of the directory to remove. The reply code received from 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 thecommand or receiving the server reply. |
| rnfr | | public int rnfr(String pathname) throws IOException(Code) | | A convenience method to send the FTP RNFR command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname to rename from. The reply code received from 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 thecommand or receiving the server reply. |
| rnto | | public int rnto(String pathname) throws IOException(Code) | | A convenience method to send the FTP RNTO command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - The pathname to rename to The reply code received from 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 thecommand or receiving the server reply. |
| sendCommand | | public int sendCommand(String command, String args) throws IOException(Code) | | Sends an FTP command to the server, waits for a reply and returns the
numerical response code. After invocation, for more detailed
information, the actual reply text can be accessed by calling
FTP.getReplyString getReplyString or
FTP.getReplyStrings getReplyStrings .
Parameters:
command - The text representation of the FTP command to send.
Parameters:
args - The arguments to the FTP command. If this parameter isset to null, then the command is sent with no argument. The integer value of the FTP reply code returned by the serverin response to the command.
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 thecommand or receiving the server reply. |
| sendCommand | | public int sendCommand(int command, String args) throws IOException(Code) | | Sends an FTP command to the server, waits for a reply and returns the
numerical response code. After invocation, for more detailed
information, the actual reply text can be accessed by calling
FTP.getReplyString getReplyString or
FTP.getReplyStrings getReplyStrings .
Parameters:
command - The FTPCommand constant corresponding to the FTP commandto send.
Parameters:
args - The arguments to the FTP command. If this parameter isset to null, then the command is sent with no argument. The integer value of the FTP reply code returned by the serverin response to the command.
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 thecommand or receiving the server reply. |
| sendCommand | | public int sendCommand(String command) throws IOException(Code) | | Sends an FTP command with no arguments to the server, waits for a
reply and returns the numerical response code. After invocation, for
more detailed information, the actual reply text can be accessed by
calling
FTP.getReplyString getReplyString or
FTP.getReplyStrings getReplyStrings .
Parameters:
command - The text representation of the FTP command to send. The integer value of the FTP reply code returned by the serverin response to the command.
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 thecommand or receiving the server reply. |
| sendCommand | | public int sendCommand(int command) throws IOException(Code) | | Sends an FTP command with no arguments to the server, waits for a
reply and returns the numerical response code. After invocation, for
more detailed information, the actual reply text can be accessed by
calling
FTP.getReplyString getReplyString or
FTP.getReplyStrings getReplyStrings .
Parameters:
command - The FTPCommand constant corresponding to the FTP commandto send. The integer value of the FTP reply code returned by the serverin response to the command.
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 thecommand or receiving the server reply. |
| setControlEncoding | | public void setControlEncoding(String encoding)(Code) | | Sets the character encoding used by the FTP control connection.
Some FTP servers require that commands be issued in a non-ASCII
encoding like UTF-8 so that filenames with multi-byte character
representations (e.g, Big 8) can be specified.
Parameters:
encoding - The new character encoding for the control connection. |
| site | | public int site(String parameters) throws IOException(Code) | | A convenience method to send the FTP SITE command to the server,
receive the reply, and return the reply code.
Parameters:
parameters - The site parameters to send. The reply code received from 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 thecommand or receiving the server reply. |
| smnt | | public int smnt(String dir) throws IOException(Code) | | A convenience method to send the FTP SMNT command to the server,
receive the reply, and return the reply code.
Parameters:
dir - The directory name. The reply code received from 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 thecommand or receiving the server reply. |
| stat | | public int stat() throws IOException(Code) | | A convenience method to send the FTP STAT command to the server,
receive the reply, and return the reply code.
The reply code received from 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 thecommand or receiving the server reply. |
| stat | | public int stat(String pathname) throws IOException(Code) | | A convenience method to send the FTP STAT command to the server,
receive the reply, and return the reply code.
Parameters:
pathname - A pathname to list. The reply code received from 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 thecommand or receiving the server reply. |
| stor | | public int stor(String pathname) throws IOException(Code) | | A convenience method to send the FTP STOR command to the server,
receive the reply, and return the reply code. Remember, it is up
to you to manage the data connection. If you don't need this low
level of access, use
org.apache.commons.net.ftp.FTPClient , which will handle all low level details for you.
Parameters:
pathname - The pathname to use for the file when stored atthe remote end of the transfer. The reply code received from 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 thecommand or receiving the server reply. |
| stou | | public int stou() throws IOException(Code) | | A convenience method to send the FTP STOU command to the server,
receive the reply, and return the reply code. Remember, it is up
to you to manage the data connection. If you don't need this low
level of access, use
org.apache.commons.net.ftp.FTPClient , which will handle all low level details for you.
The reply code received from 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 thecommand or receiving the server reply. |
| stou | | public int stou(String pathname) throws IOException(Code) | | A convenience method to send the FTP STOU command to the server,
receive the reply, and return the reply code. Remember, it is up
to you to manage the data connection. If you don't need this low
level of access, use
org.apache.commons.net.ftp.FTPClient , which will handle all low level details for you.
Parameters:
pathname - The base pathname to use for the file when stored atthe remote end of the transfer. Some FTP serversrequire this. The reply code received from 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 thecommand or receiving the server reply. |
| stru | | public int stru(int structure) throws IOException(Code) | | A convenience method to send the FTP STRU command to the server,
receive the reply, and return the reply code.
Parameters:
structure - The structure of the file (one of the_STRUCTURE constants). The reply code received from 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 thecommand or receiving the server reply. |
| syst | | public int syst() throws IOException(Code) | | A convenience method to send the FTP SYST command to the server,
receive the reply, and return the reply code.
The reply code received from 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 thecommand or receiving the server reply. |
| type | | public int type(int fileType, int formatOrByteSize) throws IOException(Code) | | A convenience method to send the FTP TYPE command for text files
to the server, receive the reply, and return the reply code.
Parameters:
fileType - The type of the file (one of the FILE_TYPEconstants).
Parameters:
formatOrByteSize - The format of the file (one of the_FORMAT constants. In the case ofLOCAL_FILE_TYPE, the byte size. The reply code received from 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 thecommand or receiving the server reply. |
| type | | public int type(int fileType) throws IOException(Code) | | A convenience method to send the FTP TYPE command to the server,
receive the reply, and return the reply code.
Parameters:
fileType - The type of the file (one of the FILE_TYPEconstants). The reply code received from 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 thecommand or receiving the server reply. |
| user | | public int user(String username) throws IOException(Code) | | A convenience method to send the FTP USER command to the server,
receive the reply, and return the reply code.
Parameters:
username - The username to login under. The reply code received from 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 thecommand or receiving the server reply. |
| Fields inherited from org.apache.commons.net.telnet.TelnetClient | protected boolean readerThread(Code)(Java Doc)
|
|
|