Class FTP
- Direct Known Subclasses:
FTPClient
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 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
FTPReply.SERVICE_NOT_AVAILABLE response to a command.
When that occurs, the FTP class method encountering that reply will throw
an
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
FTPConnectionClosedException , you must disconnect the connection with
disconnect() to properly clean up the
system resources used by FTP. Before disconnecting, you may check the
last reply code and text with
getReplyCode ,
getReplyString ,
and 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 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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ProtocolCommandSupport
A ProtocolCommandSupport object used to manage the registering of ProtocolCommandListeners and te firing of ProtocolCommandEvents.static final int
A constant used to indicate the file(s) being transfered should be treated as ASCII.static final int
A constant used to indicate the file(s) being transfered should be treated as a binary image, i.e., no translations should be performed.static final int
A constant used to indicate a file is to be transfered as a series of blocks.static final int
A constant used to indicate a text file contains ASA vertical format control characters.static final int
A constant used to indicate a file is to be transfered as FTP compressed data.static final int
The default FTP data port (20).static final int
The default FTP control port (21).static final int
A constant used to indicate the file(s) being transfered should be treated as EBCDIC.static final int
A constant used to indicate a file is to be treated as a continuous sequence of bytes.static final int
A constant used to indicate the file(s) being transfered should be treated as a binary image, i.e., no translations should be performed.static final int
A constant used to indicate the file(s) being transfered should be treated as a local type.static final int
A constant used for text files to indicate a non-print text format.static final int
A constant used to indicate a file is to be treated as a set of independent indexed pages.static final int
A constant used to indicate a file is to be treated as a sequence of records.static final int
A constant used to indicate a file is to be transfered as a stream of bytes.static final int
A constant used to indicate a text file contains format vertical format control characters.Fields inherited from class com.oroinc.net.SocketClient
_defaultPort_, _input_, _isConnected_, _output_, _socket_, _socketFactory_, _timeout_, NETASCII_EOL
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Handles special connection requirements.int
abor()
A convenience method to send the FTP ABOR command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP ACCT command to the server, receive the reply, and return the reply code.void
Adds a ProtocolCommandListener.int
allo
(int bytes) A convenience method to send the FTP ALLO command to the server, receive the reply, and return the reply code.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.int
A convenience method to send the FTP APPE command to the server, receive the reply, and return the reply code.int
cdup()
A convenience method to send the FTP CDUP command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP CWD command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP DELE command to the server, receive the reply, and return the reply code.void
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.int
getReply()
Fetches a reply from the FTP server and returns the integer reply code.int
Returns the integer value of the reply code of the last FTP reply.Returns the entire text of the last FTP server response exactly as it was received, including all end of line markers in NETASCII format.String[]
Returns the lines of text from the last FTP server response as an array of strings, one entry per line.int
help()
A convenience method to send the FTP HELP command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP HELP command to the server, receive the reply, and return the reply code.int
list()
A convenience method to send the FTP LIST command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP LIST command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP MKD command to the server, receive the reply, and return the reply code.int
mode
(int mode) A convenience method to send the FTP MODE command to the server, receive the reply, and return the reply code.int
nlst()
A convenience method to send the FTP NLST command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP NLST command to the server, receive the reply, and return the reply code.int
noop()
A convenience method to send the FTP NOOP command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP PASS command to the server, receive the reply, and return the reply code.int
pasv()
A convenience method to send the FTP PASV command to the server, receive the reply, and return the reply code.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.int
pwd()
A convenience method to send the FTP PWD command to the server, receive the reply, and return the reply code.int
quit()
A convenience method to send the FTP QUIT command to the server, receive the reply, and return the reply code.int
rein()
A convenience method to send the FTP REIN command to the server, receive the reply, and return the reply code.void
Removes a ProtocolCommandListener.int
A convenience method to send the FTP REST command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP RETR command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP RMD command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP RNFR command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP RNTO command to the server, receive the reply, and return the reply code.int
sendCommand
(int command) Sends an FTP command with no arguments to the server, waits for a reply and returns the numerical response code.int
sendCommand
(int command, String args) Sends an FTP command to the server, waits for a reply and returns the numerical response code.int
sendCommand
(String command) Sends an FTP command with no arguments to the server, waits for a reply and returns the numerical response code.int
sendCommand
(String command, String args) Sends an FTP command to the server, waits for a reply and returns the numerical response code.int
A convenience method to send the FTP SITE command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP SMNT command to the server, receive the reply, and return the reply code.int
stat()
A convenience method to send the FTP STAT command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP STAT command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP STOR command to the server, receive the reply, and return the reply code.int
stou()
A convenience method to send the FTP STOU command to the server, receive the reply, and return the reply code.int
A convenience method to send the FTP STOU command to the server, receive the reply, and return the reply code.int
stru
(int structure) A convenience method to send the FTP STRU command to the server, receive the reply, and return the reply code.int
syst()
A convenience method to send the FTP SYST command to the server, receive the reply, and return the reply code.int
type
(int fileType) A convenience method to send the FTP TYPE command to the server, receive the reply, and return the reply code.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.int
A convenience method to send the FTP USER command to the server, receive the reply, and return the reply code.Methods inherited from class com.oroinc.net.telnet.TelnetClient
getInputStream, getOutputStream
Methods inherited from class com.oroinc.net.SocketClient
connect, connect, connect, connect, connect, connect, getDefaultPort, getDefaultTimeout, getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort, getSoLinger, getSoTimeout, getTcpNoDelay, isConnected, setDefaultPort, setDefaultTimeout, setSocketFactory, setSoLinger, setSoTimeout, setTcpNoDelay, verifyRemote
-
Field Details
-
DEFAULT_DATA_PORT
public static final int DEFAULT_DATA_PORTThe default FTP data port (20).- See Also:
-
DEFAULT_PORT
public static final int DEFAULT_PORTThe default FTP control port (21).- See Also:
-
ASCII_FILE_TYPE
public static final int ASCII_FILE_TYPEA constant used to indicate the file(s) being transfered should be treated as ASCII. This is the default file type. All constants ending inFILE_TYPE
are used to indicate file types.- See Also:
-
EBCDIC_FILE_TYPE
public static final int EBCDIC_FILE_TYPEA 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 inFILE_TYPE
are used to indicate file types.- See Also:
-
IMAGE_FILE_TYPE
public static final int IMAGE_FILE_TYPEA 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 inFILE_TYPE
are used to indicate file types.- See Also:
-
BINARY_FILE_TYPE
public static final int BINARY_FILE_TYPEA 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 inFILE_TYPE
are used to indicate file types.- See Also:
-
LOCAL_FILE_TYPE
public static final int LOCAL_FILE_TYPEA constant used to indicate the file(s) being transfered should be treated as a local type. All constants ending inFILE_TYPE
are used to indicate file types.- See Also:
-
NON_PRINT_TEXT_FORMAT
public static final int NON_PRINT_TEXT_FORMATA constant used for text files to indicate a non-print text format. This is the default format. All constants ending inTEXT_FORMAT
are used to indicate text formatting for text transfers (both ASCII and EBCDIC).- See Also:
-
TELNET_TEXT_FORMAT
public static final int TELNET_TEXT_FORMATA constant used to indicate a text file contains format vertical format control characters. All constants ending inTEXT_FORMAT
are used to indicate text formatting for text transfers (both ASCII and EBCDIC).- See Also:
-
CARRIAGE_CONTROL_TEXT_FORMAT
public static final int CARRIAGE_CONTROL_TEXT_FORMATA constant used to indicate a text file contains ASA vertical format control characters. All constants ending inTEXT_FORMAT
are used to indicate text formatting for text transfers (both ASCII and EBCDIC).- See Also:
-
FILE_STRUCTURE
public static final int FILE_STRUCTUREA 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.- See Also:
-
RECORD_STRUCTURE
public static final int RECORD_STRUCTUREA 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.- See Also:
-
PAGE_STRUCTURE
public static final int PAGE_STRUCTUREA 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.- See Also:
-
STREAM_TRANSFER_MODE
public static final int STREAM_TRANSFER_MODEA constant used to indicate a file is to be transfered as a stream of bytes. This is the default transfer mode. All constants ending inTRANSFER_MODE
are used to indicate file transfer modes.- See Also:
-
BLOCK_TRANSFER_MODE
public static final int BLOCK_TRANSFER_MODEA constant used to indicate a file is to be transfered as a series of blocks. All constants ending inTRANSFER_MODE
are used to indicate file transfer modes.- See Also:
-
COMPRESSED_TRANSFER_MODE
public static final int COMPRESSED_TRANSFER_MODEA constant used to indicate a file is to be transfered as FTP compressed data. All constants ending inTRANSFER_MODE
are used to indicate file transfer modes.- See Also:
-
_commandSupport_
A ProtocolCommandSupport object used to manage the registering of ProtocolCommandListeners and te firing of ProtocolCommandEvents.
-
-
Constructor Details
-
FTP
public FTP()The default FTP constructor. Sets the default port toDEFAULT_PORT
and initializes internal data structures for saving FTP reply information.
-
-
Method Details
-
_connectAction_
Description copied from class:TelnetClient
Handles special connection requirements.- Overrides:
_connectAction_
in classTelnetClient
- Throws:
IOException
- If an error occurs during connection setup.
-
addProtocolCommandListener
Adds a ProtocolCommandListener. Delegates this task to _commandSupport_ .- Parameters:
listener
- The ProtocolCommandListener to add.
-
removeProtocolCommandistener
Removes a ProtocolCommandListener. Delegates this task to _commandSupport_ .- Parameters:
listener
- The ProtocolCommandListener to remove.
-
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. The reply text and code information from the last command is voided so that the memory it used may be reclaimed.- Overrides:
disconnect
in classTelnetClient
- Throws:
IOException
- If an error occurs while disconnecting.
-
sendCommand
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 getReplyString or getReplyStrings .- Parameters:
command
- The text representation of the FTP command to send.args
- The arguments to the FTP command. If this parameter is set to null, then the command is sent with no argument.- Returns:
- The integer value of the FTP reply code returned by the server in response to the command.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
sendCommand
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 getReplyString or getReplyStrings .- Parameters:
command
- The FTPCommand constant corresponding to the FTP command to send.args
- The arguments to the FTP command. If this parameter is set to null, then the command is sent with no argument.- Returns:
- The integer value of the FTP reply code returned by the server in response to the command.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
sendCommand
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 getReplyString or getReplyStrings .- Parameters:
command
- The text representation of the FTP command to send.- Returns:
- The integer value of the FTP reply code returned by the server in response to the command.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
sendCommand
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 getReplyString or getReplyStrings .- Parameters:
command
- The FTPCommand constant corresponding to the FTP command to send.- Returns:
- The integer value of the FTP reply code returned by the server in response to the command.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
getReplyCode
public int getReplyCode()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 sinceconnect
is of type void.- Returns:
- The integer value of the reply code of the last FTP reply.
-
getReply
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 getReplyString or 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.- Returns:
- The integer value of the reply code of the fetched FTP reply.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while receiving the server reply.
-
getReplyStrings
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.- Returns:
- The lines of text from the last FTP response as an array.
-
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.- Returns:
- The entire text from the last FTP response as a String.
-
user
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
pass
A convenience method to send the FTP PASS command to the server, receive the reply, and return the reply code.- Parameters:
pass
- The plain text password of the username being logged into.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
acct
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
abor
A convenience method to send the FTP ABOR command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
cwd
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
cdup
A convenience method to send the FTP CDUP command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
quit
A convenience method to send the FTP QUIT command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
rein
A convenience method to send the FTP REIN command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
smnt
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
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.port
- The new port.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
pasv
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
type
A convenience method to send the FTP TYPE command for text files to the server, receive the reply, and return the reply code.- Parameters:
formatOrByteSize
- The format of the file (one of the_FORMAT
constants. In the case ofLOCAL_FILE_TYPE
, the byte size.type
- The type of the file (one of theFILE_TYPE
constants).- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
type
A convenience method to send the FTP TYPE command to the server, receive the reply, and return the reply code.- Parameters:
type
- The type of the file (one of theFILE_TYPE
constants).- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
stru
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).- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
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).- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
retr
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 FTPClient, which will handle all low level details for you.- Parameters:
pathname
- The pathname of the file to retrieve.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
stor
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 FTPClient, which will handle all low level details for you.- Parameters:
pathname
- The pathname to use for the file when stored at the remote end of the transfer.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
stou
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 FTPClient, which will handle all low level details for you.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
stou
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 FTPClient, which will handle all low level details for you.- Parameters:
pathname
- The base pathname to use for the file when stored at the remote end of the transfer. Some FTP servers require this.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
appe
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 FTPClient, which will handle all low level details for you.- Parameters:
pathname
- The pathname to use for the file when stored at the remote end of the transfer.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
allo
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
allo
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.recordSize
- The size of a record.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
rest
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
rnfr
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
rnto
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- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
dele
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
rmd
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
mkd
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
pwd
A convenience method to send the FTP PWD command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
list
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 FTPClient, which will handle all low level details for you.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
list
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 FTPClient, which will handle all low level details for you.- Parameters:
pathname
- The pathname to list.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
nlst
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 FTPClient, which will handle all low level details for you.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
nlst
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 FTPClient, which will handle all low level details for you.- Parameters:
pathname
- The pathname to list.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
site
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
syst
A convenience method to send the FTP SYST command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
stat
A convenience method to send the FTP STAT command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
stat
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
help
A convenience method to send the FTP HELP command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
help
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.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
noop
A convenience method to send the FTP NOOP command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
FTPConnectionClosedException
- If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-