All Packages Class Hierarchy This Package Previous Next Index
Class com.oroinc.net.ftp.FTP
java.lang.Object
|
+----com.oroinc.net.SocketClient
|
+----com.oroinc.net.telnet.Telnet
|
+----com.oroinc.net.telnet.TelnetClient
|
+----com.oroinc.net.ftp.FTP
- public class FTP
- extends TelnetClient
FTP provides the basic the functionality necessary to implement your
own FTP client. It extends com.oroinc.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 com.oroinc.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
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.
Copyright © 1997-1998 Original Reusable Objects, Inc.
All rights reserved.
- See Also:
- FTPClient, FTPConnectionClosedException, MalformedServerReplyException
-
_commandSupport_
- A ProtocolCommandSupport object used to manage the registering of
ProtocolCommandListeners and te firing of ProtocolCommandEvents.
-
ASCII_FILE_TYPE
- A constant used to indicate the file(s) being transfered should
be treated as ASCII.
-
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.
-
BLOCK_TRANSFER_MODE
- A constant used to indicate a file is to be transfered as a series
of blocks.
-
CARRIAGE_CONTROL_TEXT_FORMAT
- A constant used to indicate a text file contains ASA vertical format
control characters.
-
COMPRESSED_TRANSFER_MODE
- A constant used to indicate a file is to be transfered as FTP
compressed data.
-
DEFAULT_DATA_PORT
- The default FTP data port (20).
-
DEFAULT_PORT
- The default FTP control port (21).
-
EBCDIC_FILE_TYPE
- A constant used to indicate the file(s) being transfered should
be treated as EBCDIC.
-
FILE_STRUCTURE
- A constant used to indicate a file is to be treated as a continuous
sequence of bytes.
-
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.
-
LOCAL_FILE_TYPE
- A constant used to indicate the file(s) being transfered should
be treated as a local type.
-
NON_PRINT_TEXT_FORMAT
- A constant used for text files to indicate a non-print text format.
-
PAGE_STRUCTURE
- A constant used to indicate a file is to be treated as a set of
independent indexed pages.
-
RECORD_STRUCTURE
- A constant used to indicate a file is to be treated as a sequence
of records.
-
STREAM_TRANSFER_MODE
- A constant used to indicate a file is to be transfered as a stream
of bytes.
-
TELNET_TEXT_FORMAT
- A constant used to indicate a text file contains format vertical format
control characters.
-
FTP()
- The default FTP constructor.
-
_connectAction_()
- Handles special connection requirements.
-
abor()
- A convenience method to send the FTP ABOR command to the server,
receive the reply, and return the reply code.
-
acct(String)
- A convenience method to send the FTP ACCT command to the server,
receive the reply, and return the reply code.
-
addProtocolCommandListener(ProtocolCommandListener)
- Adds a ProtocolCommandListener.
-
allo(int)
- A convenience method to send the FTP ALLO command to the server,
receive the reply, and return the reply code.
-
allo(int, int)
- A convenience method to send the FTP ALLO command to the server,
receive the reply, and return the reply code.
-
appe(String)
- A convenience method to send the FTP APPE command to the server,
receive the reply, and return the reply code.
-
cdup()
- A convenience method to send the FTP CDUP command to the server,
receive the reply, and return the reply code.
-
cwd(String)
- A convenience method to send the FTP CWD command to the server,
receive the reply, and return the reply code.
-
dele(String)
- A convenience method to send the FTP DELE command to the server,
receive the reply, and return the reply code.
-
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.
-
getReply()
- Fetches a reply from the FTP server and returns the integer reply
code.
-
getReplyCode()
- Returns the integer value of the reply code of the last FTP reply.
-
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.
-
getReplyStrings()
- Returns the lines of text from the last FTP server response as an array
of strings, one entry per line.
-
help()
- A convenience method to send the FTP HELP command to the server,
receive the reply, and return the reply code.
-
help(String)
- A convenience method to send the FTP HELP command to the server,
receive the reply, and return the reply code.
-
list()
- A convenience method to send the FTP LIST command to the server,
receive the reply, and return the reply code.
-
list(String)
- A convenience method to send the FTP LIST command to the server,
receive the reply, and return the reply code.
-
mkd(String)
- A convenience method to send the FTP MKD command to the server,
receive the reply, and return the reply code.
-
mode(int)
- A convenience method to send the FTP MODE command to the server,
receive the reply, and return the reply code.
-
nlst()
- A convenience method to send the FTP NLST command to the server,
receive the reply, and return the reply code.
-
nlst(String)
- A convenience method to send the FTP NLST command to the server,
receive the reply, and return the reply code.
-
noop()
- A convenience method to send the FTP NOOP command to the server,
receive the reply, and return the reply code.
-
pass(String)
- A convenience method to send the FTP PASS command to the server,
receive the reply, and return the reply code.
-
pasv()
- A convenience method to send the FTP PASV command to the server,
receive the reply, and return the reply code.
-
port(InetAddress, int)
- A convenience method to send the FTP PORT command to the server,
receive the reply, and return the reply code.
-
pwd()
- A convenience method to send the FTP PWD command to the server,
receive the reply, and return the reply code.
-
quit()
- A convenience method to send the FTP QUIT command to the server,
receive the reply, and return the reply code.
-
rein()
- A convenience method to send the FTP REIN command to the server,
receive the reply, and return the reply code.
-
removeProtocolCommandistener(ProtocolCommandListener)
- Removes a ProtocolCommandListener.
-
rest(String)
- A convenience method to send the FTP REST command to the server,
receive the reply, and return the reply code.
-
retr(String)
- A convenience method to send the FTP RETR command to the server,
receive the reply, and return the reply code.
-
rmd(String)
- A convenience method to send the FTP RMD command to the server,
receive the reply, and return the reply code.
-
rnfr(String)
- A convenience method to send the FTP RNFR command to the server,
receive the reply, and return the reply code.
-
rnto(String)
- A convenience method to send the FTP RNTO command to the server,
receive the reply, and return the reply code.
-
sendCommand(int)
- Sends an FTP command with no arguments to the server, waits for a
reply and returns the numerical response code.
-
sendCommand(int, String)
- Sends an FTP command to the server, waits for a reply and returns the
numerical response code.
-
sendCommand(String)
- Sends an FTP command with no arguments to the server, waits for a
reply and returns the numerical response code.
-
sendCommand(String, String)
- Sends an FTP command to the server, waits for a reply and returns the
numerical response code.
-
site(String)
- A convenience method to send the FTP SITE command to the server,
receive the reply, and return the reply code.
-
smnt(String)
- A convenience method to send the FTP SMNT command to the server,
receive the reply, and return the reply code.
-
stat()
- A convenience method to send the FTP STAT command to the server,
receive the reply, and return the reply code.
-
stat(String)
- A convenience method to send the FTP STAT command to the server,
receive the reply, and return the reply code.
-
stor(String)
- A convenience method to send the FTP STOR command to the server,
receive the reply, and return the reply code.
-
stou()
- A convenience method to send the FTP STOU command to the server,
receive the reply, and return the reply code.
-
stou(String)
- A convenience method to send the FTP STOU command to the server,
receive the reply, and return the reply code.
-
stru(int)
- A convenience method to send the FTP STRU command to the server,
receive the reply, and return the reply code.
-
syst()
- A convenience method to send the FTP SYST command to the server,
receive the reply, and return the reply code.
-
type(int)
- A convenience method to send the FTP TYPE command to the server,
receive the reply, and return the reply code.
-
type(int, int)
- A convenience method to send the FTP TYPE command for text files
to the server, receive the reply, and return the reply code.
-
user(String)
- A convenience method to send the FTP USER command to the server,
receive the reply, and return the reply code.
DEFAULT_DATA_PORT
public static final int DEFAULT_DATA_PORT
- The default FTP data port (20).
DEFAULT_PORT
public static final int DEFAULT_PORT
- The default FTP control port (21).
ASCII_FILE_TYPE
public static final int ASCII_FILE_TYPE
- 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.
EBCDIC_FILE_TYPE
public static final int EBCDIC_FILE_TYPE
- 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.
IMAGE_FILE_TYPE
public static final 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. All constants ending in
FILE_TYPE
are used to
indicate file types.
BINARY_FILE_TYPE
public static final 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. All constants ending in
FILE_TYPE
are used to
indicate file types.
LOCAL_FILE_TYPE
public static final int LOCAL_FILE_TYPE
- 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
public static final int NON_PRINT_TEXT_FORMAT
- 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).
TELNET_TEXT_FORMAT
public static final int TELNET_TEXT_FORMAT
- 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).
CARRIAGE_CONTROL_TEXT_FORMAT
public static final int CARRIAGE_CONTROL_TEXT_FORMAT
- 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).
FILE_STRUCTURE
public static final int FILE_STRUCTURE
- 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.
RECORD_STRUCTURE
public static final int RECORD_STRUCTURE
- 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.
PAGE_STRUCTURE
public static final int PAGE_STRUCTURE
- 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.
STREAM_TRANSFER_MODE
public static final int STREAM_TRANSFER_MODE
- 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.
BLOCK_TRANSFER_MODE
public static final int BLOCK_TRANSFER_MODE
- 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.
COMPRESSED_TRANSFER_MODE
public static final int COMPRESSED_TRANSFER_MODE
- 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.
_commandSupport_
protected ProtocolCommandSupport _commandSupport_
- A ProtocolCommandSupport object used to manage the registering of
ProtocolCommandListeners and te firing of ProtocolCommandEvents.
FTP
public FTP()
- The default FTP constructor. Sets the default port to
DEFAULT_PORT
and initializes internal data structures
for saving FTP reply information.
_connectAction_
protected void _connectAction_() throws IOException
- Handles special connection requirements.
- Overrides:
- _connectAction_ in class TelnetClient
addProtocolCommandListener
public void addProtocolCommandListener(ProtocolCommandListener listener)
- Adds a ProtocolCommandListener. Delegates this task to
_commandSupport_ .
- Parameters:
- listener - The ProtocolCommandListener to add.
removeProtocolCommandistener
public void removeProtocolCommandistener(ProtocolCommandListener listener)
- Removes a ProtocolCommandListener. Delegates this task to
_commandSupport_ .
- Parameters:
- listener - The ProtocolCommandListener to remove.
disconnect
public void disconnect() throws IOException
- 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.
- Throws: IOException
- If an error occurs while disconnecting.
- Overrides:
- disconnect in class TelnetClient
sendCommand
public int sendCommand(String command,
String args) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
sendCommand
public int sendCommand(int command,
String args) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
sendCommand
public int sendCommand(String command) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
sendCommand
public int sendCommand(int command) throws IOException
- 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.
- Throws: 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 since
connect
is of type void.
- Returns:
- The integer value of the reply code of the last FTP reply.
getReply
public int getReply() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while receiving the
server reply.
getReplyStrings
public String[] 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
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.
- Returns:
- The entire text from the last FTP response as a String.
user
public int user(String username) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
pass
public int pass(String password) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
acct
public int acct(String account) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
abor
public int abor() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
cwd
public int cwd(String directory) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
cdup
public int cdup() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
quit
public int quit() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
rein
public int rein() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
smnt
public int smnt(String dir) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
port
public int port(InetAddress host,
int port) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
pasv
public int pasv() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
type
public int type(int fileType,
int formatOrByteSize) throws IOException
- A convenience method to send the FTP TYPE command for text files
to the server, receive the reply, and return the reply code.
- Parameters:
- type - The type of the file (one of the
FILE_TYPE
constants).
- formatOrByteSize - The format of the file (one of the
_FORMAT
constants. In the case of
LOCAL_FILE_TYPE
, the byte size.
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
type
public int type(int fileType) throws IOException
- 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 the
FILE_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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
stru
public int stru(int structure) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
mode
public int mode(int mode) throws IOException
- 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 the
TRANSFER_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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
retr
public int retr(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
stor
public int stor(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
stou
public int stou() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
stou
public int stou(String filename) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
appe
public int appe(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
allo
public int allo(int bytes) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
allo
public int allo(int bytes,
int recordSize) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
rest
public int rest(String marker) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
rnfr
public int rnfr(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
rnto
public int rnto(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
dele
public int dele(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
rmd
public int rmd(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
mkd
public int mkd(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
pwd
public int pwd() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
list
public int list() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
list
public int list(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
nlst
public int nlst() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
nlst
public int nlst(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
site
public int site(String parameters) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
syst
public int syst() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
stat
public int stat() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
stat
public int stat(String pathname) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
help
public int help() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
help
public int help(String command) throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
noop
public int noop() throws IOException
- 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.
- Throws: IOException
- If an I/O error occurs while either sending the
command or receiving the server reply.
All Packages Class Hierarchy This Package Previous Next Index