All Packages Class Hierarchy This Package Previous Next Index
Class com.oroinc.net.ftp.FTPClient
java.lang.Object
|
+----com.oroinc.net.SocketClient
|
+----com.oroinc.net.telnet.Telnet
|
+----com.oroinc.net.telnet.TelnetClient
|
+----com.oroinc.net.ftp.FTP
|
+----com.oroinc.net.ftp.FTPClient
- public class FTPClient
- extends FTP
FTPClient encapsulates all the functionality necessary to store and
retrieve files from an FTP server. This class takes care of all
low level details of interacting with an FTP server and provides
a convenient higher level interface. As with all classes derived
from SocketClient ,
you must first connect to the server with
connect
before doing anything, and finally
disconnect
after you're completely finished interacting with the server.
Then you need to check the FTP reply code to see if the connection
was successful. For example:
try {
int reply;
ftp.connect("ftp.foobar.com");
System.out.println("Connected to " + server + ".");
System.out.print(ftp.getReplyString());
// After connection attempt, you should check the reply code to verify
// success.
reply = ftp.getReplyCode();
if(!FTPReply.isPositiveCompletion(reply)) {
ftp.disconnect();
System.err.println("FTP server refused connection.");
System.exit(1);
}
} catch(IOException e) {
if(ftp.isConnected()) {
try {
ftp.disconnect();
} catch(IOException f) {
// do nothing
}
}
System.err.println("Could not connect to server.");
e.printStackTrace();
System.exit(1);
}
Immediately after connecting is the only real time you need to check the
reply code (because connect is of type void). The convention for all the
FTP command methods in FTPClient is such that they either return a
boolean value or some other value.
The boolean methods return true on a successful completion reply from
the FTP server and false on a reply resulting in an error condition or
failure. The methods returning a value other than boolean return a value
containing the higher level data produced by the FTP command, or null if a
reply resulted in an error condition or failure. If you want to access
the exact FTP reply code causing a success or failure, you must call
getReplyCode after
a success or failure.
The default settings for FTPClient are for it to use
FTP.ASCII_FILE_TYPE
,
FTP.NON_PRINT_TEXT_FORMAT
,
FTP.STREAM_TRANSFER_MODE
, and
FTP.FILE_STRUCTURE
. The only file types directly supported
are FTP.ASCII_FILE_TYPE
and
FTP.IMAGE_FILE_TYPE
(which is the same as
FTP.BINARY_FILE_TYPE
). Because there are at lest 4
different EBCDIC encodings, we have opted not to provide direct support
for EBCDIC. To transfer EBCDIC and other unsupported file types you
must create your own filter InputStreams and OutputStreams and wrap
them around the streams returned or required by the FTPClient methods.
FTPClient uses the NetASCII filter streams in
com.oroinc.io to provide
transparent handling of ASCII files. We will consider incorporating
EBCDIC support if there is enough demand.
FTP.NON_PRINT_TEXT_FORMAT
,
FTP.STREAM_TRANSFER_MODE
, and
FTP.FILE_STRUCTURE
are the only supported formats,
transfer modes, and file structures.
Because the handling of sockets on different platforms can differ
significantly, the FTPClient automatically issues a new PORT command
prior to every transfer requiring that the server connect to the client's
data port. This ensures identical problem-free behavior on Windows, Unix,
and Macintosh platforms. Additionally, it relieves programmers from
having to issue the PORT command themselves and dealing with platform
dependent issues.
Additionally, for security purposes, all data connections to the
client are verified to ensure that they originated from the intended
party (host and port). If a data connection is initiated by an unexpected
party, the command will close the socket and throw an IOException. You
may disable this behavior with
setRemoteVerificationEnabled().
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 FTPClient 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 .
FTPConnectionClosedException
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 FTPClient. 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:
- FTP, FTPConnectionClosedException, DefaultFTPFileListParser, MalformedServerReplyException
-
ACTIVE_LOCAL_DATA_CONNECTION_MODE
- A constant indicating the FTP session is expecting all transfers
to occur between the client (local) and server and that the server
should connect to the client's data port to initiate a data transfer.
-
ACTIVE_REMOTE_DATA_CONNECTION_MODE
- A constant indicating the FTP session is expecting all transfers
to occur between two remote servers and that the server
the client is connected to should connect to the other server's
data port to initiate a data transfer.
-
PASSIVE_LOCAL_DATA_CONNECTION_MODE
- A constant indicating the FTP session is expecting all transfers
to occur between the client (local) and server and that the server
is in passive mode, requiring the client to connect to the
server's data port to initiate a transfer.
-
PASSIVE_REMOTE_DATA_CONNECTION_MODE
- A constant indicating the FTP session is expecting all transfers
to occur between two remote servers and that the server
the client is connected to is in passive mode, requiring the other
server to connect to the first server's data port to initiate a data
transfer.
-
FTPClient()
- Default FTPClient constructor.
-
_connectAction_()
- Handles special connection requirements.
-
abort()
- Abort a transfer in progress.
-
allocate(int)
- Reserve a number of bytes on the server for the next file transfer.
-
allocate(int, int)
- Reserve space on the server for the next file transfer.
-
appendFile(String, InputStream)
- Appends to a file on the server with the given name, taking input
from the given InputStream.
-
appendFileStream(String)
- Returns an OutputStream through which data can be written to append
to a file on the server with the given name.
-
changeToParentDirectory()
- Change to the parent directory of the current working directory.
-
changeWorkingDirectory(String)
- Change the current working directory of the FTP session.
-
completePendingCommand()
- There are a few FTPClient methods that do not complete the
entire sequence of FTP commands to complete a transaction.
-
deleteFile(String)
- Deletes a file on the FTP server.
-
disconnect()
- Closes the connection to the FTP server and restores
connection parameters to the default values.
-
enterLocalActiveMode()
- Set the current data connection mode to
ACTIVE_LOCAL_DATA_CONNECTION_MODE
.
-
enterLocalPassiveMode()
- Set the current data connection mode to
PASSIVE_LOCAL_DATA_CONNECTION_MODE
.
-
enterRemoteActiveMode(InetAddress, int)
- Set the current data connection mode to
ACTIVE_REMOTE_DATA_CONNECTION
.
-
enterRemotePassiveMode()
- Set the current data connection mode to
PASSIVE_REMOTE_DATA_CONNECTION_MODE
.
-
getDataConnectionMode()
- Returns the current data connection mode (one of the
_DATA_CONNECTION_MODE
constants.
-
getPassiveHost()
- Returns the hostname or IP address (in the form of a string) returned
by the server when entering passive mode.
-
getPassivePort()
- If in passive mode, returns the data port of the passive host.
-
getStatus()
- Issue the FTP STAT command to the server.
-
getStatus(String)
- Issue the FTP STAT command to the server for a given pathname.
-
getSystemName()
- Fetches the system type name from the server and returns the string.
-
isRemoteVerificationEnabled()
- Return whether or not verification of the remote host participating
in data connections is enabled.
-
listFiles()
- Using the
DefaultFTPFileListParser
, obtain a list of
file information for the current working directory.
-
listFiles(FTPFileListParser)
- Using a programmer specified
FTPFileListParser
,
obtain a list of file information for the current working directory.
-
listFiles(FTPFileListParser, String)
- Using a programmer specified
FTPFileListParser
, obtain a
list of file information for a directory or information for
just a single file.
-
listFiles(String)
- Using the
DefaultFTPFileListParser
, obtain a list of
file information
for a directory or information for just a single file.
-
listHelp()
- Fetches the system help information from the server and returns the
full string.
-
listHelp(String)
- Fetches the help information for a given command from the server and
returns the full string.
-
listNames()
- Obtain a list of filenames in the current working directory
This information is obtained through the NLST command.
-
listNames(String)
- Obtain a list of filenames in a directory (or just the name of a given
file, which is not particularly useful).
-
login(String, String)
- Login to the FTP server using the provided username and password.
-
login(String, String, String)
- Login to the FTP server using the provided username, password,
and account.
-
logout()
- Logout of the FTP server by sending the QUIT command.
-
makeDirectory(String)
- Creates a new subdirectory on the FTP server in the current directory
(if a relative pathname is given) or where specified (if an absolute
pathname is given).
-
printWorkingDirectory()
- Returns the pathname of the current working directory.
-
remoteAppend(String)
- Initiate a server to server file transfer.
-
remoteRetrieve(String)
- Initiate a server to server file transfer.
-
remoteStore(String)
- Initiate a server to server file transfer.
-
remoteStoreUnique()
- Initiate a server to server file transfer.
-
remoteStoreUnique(String)
- Initiate a server to server file transfer.
-
removeDirectory(String)
- Removes a directory on the FTP server (if empty).
-
rename(String, String)
- Renames a remote file.
-
restart(long)
- Restart a
STREAM_TRANSFER_MODE
file transfer starting
from the given offset.
-
retrieveFile(String, OutputStream)
- Retrieves a named file from the server and writes it to the given
OutputStream.
-
retrieveFileStream(String)
- Returns an InputStream from which a named file from the server
can be read.
-
sendNoOp()
- Sends a NOOP command to the FTP server.
-
sendSiteCommand(String)
- Send a site specific command.
-
setDataTimeout(int)
- Sets the timeout in milliseconds to use when reading from the
data connection.
-
setFileStructure(int)
- Sets the file structure.
-
setFileTransferMode(int)
- Sets the transfer mode.
-
setFileType(int)
- Sets the file type to be transferred.
-
setFileType(int, int)
- Sets the file type to be transferred and the format.
-
setRemoteVerificationEnabled(boolean)
- Enable or disable verification that the remote host taking part
of a data connection is the same as the host to which the control
connection is attached.
-
storeFile(String, InputStream)
- Stores a file on the server using the given name and taking input
from the given InputStream.
-
storeFileStream(String)
- Returns an OutputStream through which data can be written to store
a file on the server using the given name.
-
storeUniqueFile(InputStream)
- Stores a file on the server using a unique name assigned by the
server and taking input from the given InputStream.
-
storeUniqueFile(String, InputStream)
- Stores a file on the server using a unique name derived from the
given name and taking input
from the given InputStream.
-
storeUniqueFileStream()
- Returns an OutputStream through which data can be written to store
a file on the server using a unique name assigned by the server.
-
storeUniqueFileStream(String)
- Returns an OutputStream through which data can be written to store
a file on the server using a unique name derived from the given name.
-
structureMount(String)
- Issue the FTP SMNT command.
ACTIVE_LOCAL_DATA_CONNECTION_MODE
public static final int ACTIVE_LOCAL_DATA_CONNECTION_MODE
- A constant indicating the FTP session is expecting all transfers
to occur between the client (local) and server and that the server
should connect to the client's data port to initiate a data transfer.
This is the default data connection mode when and FTPClient instance
is created.
ACTIVE_REMOTE_DATA_CONNECTION_MODE
public static final int ACTIVE_REMOTE_DATA_CONNECTION_MODE
- A constant indicating the FTP session is expecting all transfers
to occur between two remote servers and that the server
the client is connected to should connect to the other server's
data port to initiate a data transfer.
PASSIVE_LOCAL_DATA_CONNECTION_MODE
public static final int PASSIVE_LOCAL_DATA_CONNECTION_MODE
- A constant indicating the FTP session is expecting all transfers
to occur between the client (local) and server and that the server
is in passive mode, requiring the client to connect to the
server's data port to initiate a transfer.
PASSIVE_REMOTE_DATA_CONNECTION_MODE
public static final int PASSIVE_REMOTE_DATA_CONNECTION_MODE
- A constant indicating the FTP session is expecting all transfers
to occur between two remote servers and that the server
the client is connected to is in passive mode, requiring the other
server to connect to the first server's data port to initiate a data
transfer.
FTPClient
public FTPClient()
- Default FTPClient constructor. Creates a new FTPClient instance
with the data connection mode set to
ACTIVE_LOCAL_DATA_CONNECTION_MODE
, the file type
set to FTP.ASCII_FILE_TYPE
, the
file format set to FTP.NON_PRINT_TEXT_FORMAT
,
the file structure set to FTP.FILE_STRUCTURE
, and
the transfer mode set to FTP.STREAM_TRANSFER_MODE
.
_connectAction_
protected void _connectAction_() throws IOException
- Handles special connection requirements.
- Overrides:
- _connectAction_ in class FTP
setDataTimeout
public void setDataTimeout(int timeout)
- Sets the timeout in milliseconds to use when reading from the
data connection. This timeout will be set immediately after
opening the data connection.
- Parameters:
- timeout - The default timeout in milliseconds that is used when
opening a data connection socket.
disconnect
public void disconnect() throws IOException
- Closes the connection to the FTP server and restores
connection parameters to the default values.
- Throws: IOException
- If an error occurs while disconnecting.
- Overrides:
- disconnect in class FTP
setRemoteVerificationEnabled
public void setRemoteVerificationEnabled(boolean enable)
- Enable or disable verification that the remote host taking part
of a data connection is the same as the host to which the control
connection is attached. The default is for verification to be
enabled. You may set this value at any time, whether the
FTPClient is currently connected or not.
- Parameters:
- enable - True to enable verification, false to disable verification.
isRemoteVerificationEnabled
public boolean isRemoteVerificationEnabled()
- Return whether or not verification of the remote host participating
in data connections is enabled. The default behavior is for
verification to be enabled.
- Returns:
- True if verification is enabled, false if not.
login
public boolean login(String username,
String password) throws IOException
- Login to the FTP server using the provided username and password.
- Parameters:
- username - The username to login under.
- password - The password to use.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
login
public boolean login(String username,
String password,
String account) throws IOException
- Login to the FTP server using the provided username, password,
and account. If no account is required by the server, only
the username and password, the account information is not used.
- Parameters:
- username - The username to login under.
- password - The password to use.
- account - The account to use.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
logout
public boolean logout() throws IOException
- Logout of the FTP server by sending the QUIT command.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
changeWorkingDirectory
public boolean changeWorkingDirectory(String pathname) throws IOException
- Change the current working directory of the FTP session.
- Parameters:
- pathname - The new current working directory.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
changeToParentDirectory
public boolean changeToParentDirectory() throws IOException
- Change to the parent directory of the current working directory.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
structureMount
public boolean structureMount(String pathname) throws IOException
- Issue the FTP SMNT command.
- Parameters:
- pathname - The pathname to mount.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
enterLocalActiveMode
public void enterLocalActiveMode()
- Set the current data connection mode to
ACTIVE_LOCAL_DATA_CONNECTION_MODE
. No communication
with the FTP server is conducted, but this causes all future data
transfers to require the FTP server to connect to the client's
data port. Additionally, to accommodate differences between socket
implementations on different platforms, this method causes the
client to issue a PORT command before every data transfer.
enterLocalPassiveMode
public void enterLocalPassiveMode()
- Set the current data connection mode to
PASSIVE_LOCAL_DATA_CONNECTION_MODE
. Use this
method only for data transfers between the client and server.
This method causes a PASV command to be issued to the server
before the opening of every data connection, telling the server to
open a data port to which the client will connect to conduct
data transfers. The FTPClient will stay in
PASSIVE_LOCAL_DATA_CONNECTION_MODE
until the
mode is changed by calling some other method such as
enterLocalActiveMode()
enterRemoteActiveMode
public boolean enterRemoteActiveMode(InetAddress host,
int port) throws IOException
- Set the current data connection mode to
ACTIVE_REMOTE_DATA_CONNECTION
. Use this method only
for server to server data transfers. This method issues a PORT
command to the server, indicating the other server and port to which
it should connect for data transfers. You must call this method
before EVERY server to server transfer attempt. The FTPClient will
NOT automatically continue to issue PORT commands. You also
must remember to call
enterLocalActiveMode() if you
wish to return to the normal data connection mode.
- Parameters:
- host - The passive mode server accepting connections for data
transfers.
- port - The passive mode server's data port.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
enterRemotePassiveMode
public boolean enterRemotePassiveMode() throws IOException
- Set the current data connection mode to
PASSIVE_REMOTE_DATA_CONNECTION_MODE
. Use this
method only for server to server data transfers.
This method issues a PASV command to the server, telling it to
open a data port to which the active server will connect to conduct
data transfers. You must call this method
before EVERY server to server transfer attempt. The FTPClient will
NOT automatically continue to issue PASV commands. You also
must remember to call
enterLocalActiveMode() if you
wish to return to the normal data connection mode.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
getPassiveHost
public String getPassiveHost()
- Returns the hostname or IP address (in the form of a string) returned
by the server when entering passive mode. If not in passive mode,
returns null. This method only returns a valid value AFTER a
data connection has been opened after a call to
enterLocalPassiveMode().
This is because FTPClient sends a PASV command to the server only
just before opening a data connection, and not when you call
enterLocalPassiveMode().
- Returns:
- The passive host name if in passive mode, otherwise null.
getPassivePort
public int getPassivePort()
- If in passive mode, returns the data port of the passive host.
This method only returns a valid value AFTER a
data connection has been opened after a call to
enterLocalPassiveMode().
This is because FTPClient sends a PASV command to the server only
just before opening a data connection, and not when you call
enterLocalPassiveMode().
- Returns:
- The data port of the passive server. If not in passive
mode, undefined.
getDataConnectionMode
public int getDataConnectionMode()
- Returns the current data connection mode (one of the
_DATA_CONNECTION_MODE
constants.
- Returns:
- The current data connection mode (one of the
_DATA_CONNECTION_MODE
constants.
setFileType
public boolean setFileType(int fileType) throws IOException
- Sets the file type to be transferred. This should be one of
FTP.ASCII_FILE_TYPE
, FTP.IMAGE_FILE_TYPE
,
etc. The file type only needs to be set when you want to change the
type. After changing it, the new type stays in effect until you change
it again. The default file type is FTP.ASCII_FILE_TYPE
if this method is never called.
- Parameters:
- fileType - The
_FILE_TYPE
constant indcating the
type of file.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
setFileType
public boolean setFileType(int fileType,
int formatOrByteSize) throws IOException
- Sets the file type to be transferred and the format. The type should be
one of
FTP.ASCII_FILE_TYPE
,
FTP.IMAGE_FILE_TYPE
, etc. The file type only needs to
be set when you want to change the type. After changing it, the new
type stays in effect until you change it again. The default file type
is FTP.ASCII_FILE_TYPE
if this method is never called.
The format should be one of the FTP class TEXT_FORMAT
constants, or if the type is FTP.LOCAL_FILE_TYPE
, the
format should be the byte size for that type. The default format
is FTP.NON_PRINT_TEXT_FORMAT
if this method is never
called.
- Parameters:
- fileType - The
_FILE_TYPE
constant indcating the
type of file.
- formatOrByteSize - The format of the file (one of the
_FORMAT
constants. In the case of
LOCAL_FILE_TYPE
, the byte size.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
setFileStructure
public boolean setFileStructure(int structure) throws IOException
- Sets the file structure. The default structure is
FTP.FILE_STRUCTURE
if this method is never called.
- Parameters:
- structure - The structure of the file (one of the FTP class
_STRUCTURE
constants).
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
setFileTransferMode
public boolean setFileTransferMode(int mode) throws IOException
- Sets the transfer mode. The default transfer mode
FTP.STREAM_TRANSFER_MODE
if this method is never called.
- Parameters:
- mode - The new transfer mode to use (one of the FTP class
_TRANSFER_MODE
constants).
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
remoteRetrieve
public boolean remoteRetrieve(String filename) throws IOException
- Initiate a server to server file transfer. This method tells the
server to which the client is connected to retrieve a given file from
the other server.
- Parameters:
- filename - The name of the file to retrieve.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
remoteStore
public boolean remoteStore(String filename) throws IOException
- Initiate a server to server file transfer. This method tells the
server to which the client is connected to store a file on
the other server using the given filename. The other server must
have had a
remoteRetrieve
issued to it by another
FTPClient.
- Parameters:
- filename - The name to call the file that is to be stored.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
remoteStoreUnique
public boolean remoteStoreUnique(String filename) throws IOException
- Initiate a server to server file transfer. This method tells the
server to which the client is connected to store a file on
the other server using a unique filename based on the given filename.
The other server must have had a
remoteRetrieve
issued
to it by another FTPClient.
- Parameters:
- filename - The name on which to base the filename of the file
that is to be stored.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
remoteStoreUnique
public boolean remoteStoreUnique() throws IOException
- Initiate a server to server file transfer. This method tells the
server to which the client is connected to store a file on
the other server using a unique filename.
The other server must have had a
remoteRetrieve
issued
to it by another FTPClient. Many FTP servers require that a base
filename be given from which the unique filename can be derived. For
those servers use the other version of remoteStoreUnique
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
remoteAppend
public boolean remoteAppend(String filename) throws IOException
- Initiate a server to server file transfer. This method tells the
server to which the client is connected to append to a given file on
the other server. The other server must have had a
remoteRetrieve
issued to it by another FTPClient.
- Parameters:
- filename - The name of the file to be appended to, or if the
file does not exist, the name to call the file being stored.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
completePendingCommand
public boolean completePendingCommand() throws IOException
- There are a few FTPClient methods that do not complete the
entire sequence of FTP commands to complete a transaction. These
commands require some action by the programmer after the reception
of a positive intermediate command. After the programmer's code
completes its actions, it must call this method to receive
the completion reply from the server and verify the success of the
entire transaction.
For example,
InputStream input;
OutputStream output;
input = new FileInputStream("foobaz.txt");
output = ftp.storeFileStream("foobar.txt")
if(!FTPReply.isPositiveIntermediate(ftp.getReplyCode())) {
input.close();
output.close();
ftp.logout();
ftp.disconnect();
System.err.println("File transfer failed.");
System.exit(1);
}
Util.copyStream(input, output);
input.close();
output.close();
// Must call completePendingCommand() to finish command.
if(!ftp.completePendingCommand()) {
ftp.logout();
ftp.disconnect();
System.err.println("File transfer failed.");
System.exit(1);
}
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
retrieveFile
public boolean retrieveFile(String remote,
OutputStream local) throws IOException
- Retrieves a named file from the server and writes it to the given
OutputStream. This method does NOT close the given OutputStream.
If the current file type is ASCII, line separators in the file are
converted to the local representation.
- Parameters:
- remote - The name of the remote file.
- local - The local OutputStream to which to write the file.
- Returns:
- True if successfully completed, false if not.
- 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: CopyStreamException
- If an I/O error occurs while actually
transferring the file. The CopyStreamException allows you to
determine the number of bytes transferred and the IOException
causing the error. This exception may be caught either
as an IOException or independently as itself.
- Throws: IOException
- If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.
retrieveFileStream
public InputStream retrieveFileStream(String remote) throws IOException
- Returns an InputStream from which a named file from the server
can be read. If the current file type is ASCII, the returned
InputStream will convert line separators in the file to
the local representation. You must close the InputStream when you
finish reading from it. The InputStream itself will take care of
closing the parent data connection socket upon being closed. To
finalize the file transfer you must call
completePendingCommand and
check its return value to verify success.
- Parameters:
- remote - The name of the remote file.
- Returns:
- An InputStream from which the remote file can be read. If
the data connection cannot be opened (e.g., the file does not
exist), null is returned (in which case you may check the reply
code to determine the exact reason for failure).
- 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 a
command to the server or receiving a reply from the server.
storeFile
public boolean storeFile(String remote,
InputStream local) throws IOException
- Stores a file on the server using the given name and taking input
from the given InputStream. This method does NOT close the given
InputStream. If the current file type is ASCII, line separators in
the file are transparently converted to the NETASCII format (i.e.,
you should not attempt to create a special InputStream to do this).
- Parameters:
- remote - The name to give the remote file.
- local - The local InputStream from which to read the file.
- Returns:
- True if successfully completed, false if not.
- 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: CopyStreamException
- If an I/O error occurs while actually
transferring the file. The CopyStreamException allows you to
determine the number of bytes transferred and the IOException
causing the error. This exception may be caught either
as an IOException or independently as itself.
- Throws: IOException
- If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.
storeFileStream
public OutputStream storeFileStream(String remote) throws IOException
- Returns an OutputStream through which data can be written to store
a file on the server using the given name. If the current file type
is ASCII, the returned OutputStream will convert line separators in
the file to the NETASCII format (i.e., you should not attempt to
create a special OutputStream to do this). You must close the
OutputStream when you finish writing to it. The OutputStream itself
will take care of closing the parent data connection socket upon being
closed. To finalize the file transfer you must call
completePendingCommand and
check its return value to verify success.
- Parameters:
- remote - The name to give the remote file.
- Returns:
- An OutputStream through which the remote file can be written. If
the data connection cannot be opened (e.g., the file does not
exist), null is returned (in which case you may check the reply
code to determine the exact reason for failure).
- 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 a
command to the server or receiving a reply from the server.
appendFile
public boolean appendFile(String remote,
InputStream local) throws IOException
- Appends to a file on the server with the given name, taking input
from the given InputStream. This method does NOT close the given
InputStream. If the current file type is ASCII, line separators in
the file are transparently converted to the NETASCII format (i.e.,
you should not attempt to create a special InputStream to do this).
- Parameters:
- remote - The name of the remote file.
- local - The local InputStream from which to read the data to
be appended to the remote file.
- Returns:
- True if successfully completed, false if not.
- 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: CopyStreamException
- If an I/O error occurs while actually
transferring the file. The CopyStreamException allows you to
determine the number of bytes transferred and the IOException
causing the error. This exception may be caught either
as an IOException or independently as itself.
- Throws: IOException
- If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.
appendFileStream
public OutputStream appendFileStream(String remote) throws IOException
- Returns an OutputStream through which data can be written to append
to a file on the server with the given name. If the current file type
is ASCII, the returned OutputStream will convert line separators in
the file to the NETASCII format (i.e., you should not attempt to
create a special OutputStream to do this). You must close the
OutputStream when you finish writing to it. The OutputStream itself
will take care of closing the parent data connection socket upon being
closed. To finalize the file transfer you must call
completePendingCommand and
check its return value to verify success.
- Parameters:
- remote - The name of the remote file.
- Returns:
- An OutputStream through which the remote file can be appended.
If the data connection cannot be opened (e.g., the file does not
exist), null is returned (in which case you may check the reply
code to determine the exact reason for failure).
- 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 a
command to the server or receiving a reply from the server.
storeUniqueFile
public boolean storeUniqueFile(String remote,
InputStream local) throws IOException
- Stores a file on the server using a unique name derived from the
given name and taking input
from the given InputStream. This method does NOT close the given
InputStream. If the current file type is ASCII, line separators in
the file are transparently converted to the NETASCII format (i.e.,
you should not attempt to create a special InputStream to do this).
- Parameters:
- remote - The name on which to base the unique name given to
the remote file.
- local - The local InputStream from which to read the file.
- Returns:
- True if successfully completed, false if not.
- 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: CopyStreamException
- If an I/O error occurs while actually
transferring the file. The CopyStreamException allows you to
determine the number of bytes transferred and the IOException
causing the error. This exception may be caught either
as an IOException or independently as itself.
- Throws: IOException
- If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.
storeUniqueFileStream
public OutputStream storeUniqueFileStream(String remote) throws IOException
- Returns an OutputStream through which data can be written to store
a file on the server using a unique name derived from the given name.
If the current file type
is ASCII, the returned OutputStream will convert line separators in
the file to the NETASCII format (i.e., you should not attempt to
create a special OutputStream to do this). You must close the
OutputStream when you finish writing to it. The OutputStream itself
will take care of closing the parent data connection socket upon being
closed. To finalize the file transfer you must call
completePendingCommand and
check its return value to verify success.
- Parameters:
- remote - The name on which to base the unique name given to
the remote file.
- Returns:
- An OutputStream through which the remote file can be written. If
the data connection cannot be opened (e.g., the file does not
exist), null is returned (in which case you may check the reply
code to determine the exact reason for failure).
- 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 a
command to the server or receiving a reply from the server.
storeUniqueFile
public boolean storeUniqueFile(InputStream local) throws IOException
- Stores a file on the server using a unique name assigned by the
server and taking input from the given InputStream. This method does
NOT close the given
InputStream. If the current file type is ASCII, line separators in
the file are transparently converted to the NETASCII format (i.e.,
you should not attempt to create a special InputStream to do this).
- Parameters:
- remote - The name to give the remote file.
- local - The local InputStream from which to read the file.
- Returns:
- True if successfully completed, false if not.
- 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: CopyStreamException
- If an I/O error occurs while actually
transferring the file. The CopyStreamException allows you to
determine the number of bytes transferred and the IOException
causing the error. This exception may be caught either
as an IOException or independently as itself.
- Throws: IOException
- If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.
storeUniqueFileStream
public OutputStream storeUniqueFileStream() throws IOException
- Returns an OutputStream through which data can be written to store
a file on the server using a unique name assigned by the server.
If the current file type
is ASCII, the returned OutputStream will convert line separators in
the file to the NETASCII format (i.e., you should not attempt to
create a special OutputStream to do this). You must close the
OutputStream when you finish writing to it. The OutputStream itself
will take care of closing the parent data connection socket upon being
closed. To finalize the file transfer you must call
completePendingCommand and
check its return value to verify success.
- Parameters:
- remote - The name to give the remote file.
- Returns:
- An OutputStream through which the remote file can be written. If
the data connection cannot be opened (e.g., the file does not
exist), null is returned (in which case you may check the reply
code to determine the exact reason for failure).
- 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 a
command to the server or receiving a reply from the server.
allocate
public boolean allocate(int bytes) throws IOException
- Reserve a number of bytes on the server for the next file transfer.
- Parameters:
- bytes - The number of bytes which the server should allocate.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
allocate
public boolean allocate(int bytes,
int recordSize) throws IOException
- Reserve space on the server for the next file transfer.
- Parameters:
- bytes - The number of bytes which the server should allocate.
- bytes - The size of a file record.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
restart
public boolean restart(long offset) throws IOException
- Restart a
STREAM_TRANSFER_MODE
file transfer starting
from the given offset. This will only work on FTP servers supporting
the REST comand for the stream transfer mode. However, most FTP
servers support this. Any subsequent file transfer will start
reading or writing the remote file from the indicated offset.
- Parameters:
- offset - The offset into the remote file at which to start the
next file transfer.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
rename
public boolean rename(String from,
String to) throws IOException
- Renames a remote file.
- Parameters:
- from - The name of the remote file to rename.
- to - The new name of the remote file.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
abort
public boolean abort() throws IOException
- Abort a transfer in progress.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
deleteFile
public boolean deleteFile(String pathname) throws IOException
- Deletes a file on the FTP server.
- Parameters:
- pathname - The pathname of the file to be deleted.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
removeDirectory
public boolean removeDirectory(String pathname) throws IOException
- Removes a directory on the FTP server (if empty).
- Parameters:
- pathname - The pathname of the directory to remove.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
makeDirectory
public boolean makeDirectory(String pathname) throws IOException
- Creates a new subdirectory on the FTP server in the current directory
(if a relative pathname is given) or where specified (if an absolute
pathname is given).
- Parameters:
- pathname - The pathname of the directory to create.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
printWorkingDirectory
public String printWorkingDirectory() throws IOException
- Returns the pathname of the current working directory.
- Returns:
- The pathname of the current working directory. If it cannot
be obtained, returns null.
- 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 a
command to the server or receiving a reply from the server.
sendSiteCommand
public boolean sendSiteCommand(String arguments) throws IOException
- Send a site specific command.
- Parameters:
- argument - The site specific command and arguments.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
getSystemName
public String getSystemName() throws IOException
- Fetches the system type name from the server and returns the string.
- Returns:
- The system type name obtained from the server. null if the
information could not be obtained.
- 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 a
command to the server or receiving a reply from the server.
listHelp
public String listHelp() throws IOException
- Fetches the system help information from the server and returns the
full string.
- Returns:
- The system help string obtained from the server. null if the
information could not be obtained.
- 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 a
command to the server or receiving a reply from the server.
listHelp
public String listHelp(String command) throws IOException
- Fetches the help information for a given command from the server and
returns the full string.
- Parameters:
- The - command on which to ask for help.
- Returns:
- The command help string obtained from the server. null if the
information could not be obtained.
- 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 a
command to the server or receiving a reply from the server.
sendNoOp
public boolean sendNoOp() throws IOException
- Sends a NOOP command to the FTP server. This is useful for preventing
server timeouts.
- Returns:
- True if successfully completed, false if not.
- 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 a
command to the server or receiving a reply from the server.
listNames
public String[] listNames(String pathname) throws IOException
- Obtain a list of filenames in a directory (or just the name of a given
file, which is not particularly useful). This information is obtained
through the NLST command. If the given pathname is a directory and
contains no files, a zero length array is returned only
if the FTP server returned a positive completion code, otherwise
null is returned (the FTP server returned a 550 error No files found.).
If the directory is not empty, an array of filenames in the directory is
returned. If the pathname corresponds
to a file, only that file will be listed. The server may or may not
expand glob expressions.
- Parameters:
- pathname - The file or directory to list.
- Returns:
- The list of filenames contained in the given path. null if
the list could not be obtained. If there are no filenames in
the directory, a zero-length array is returned.
- 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 a
command to the server or receiving a reply from the server.
listNames
public String[] listNames() throws IOException
- Obtain a list of filenames in the current working directory
This information is obtained through the NLST command. If the current
directory contains no files, a zero length array is returned only
if the FTP server returned a positive completion code, otherwise,
null is returned (the FTP server returned a 550 error No files found.).
If the directory is not empty, an array of filenames in the directory is
returned.
- Returns:
- The list of filenames contained in the current working
directory. null if the list could not be obtained.
If there are no filenames in the directory, a zero-length array
is returned.
- 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 a
command to the server or receiving a reply from the server.
listFiles
public FTPFile[] listFiles(FTPFileListParser parser,
String pathname) throws IOException
- Using a programmer specified
FTPFileListParser
, obtain a
list of file information for a directory or information for
just a single file. This information is obtained through the LIST
command. The contents of the returned array is determined by the
FTPFileListParser
used.
The server may or may not expand glob expressions. You should avoid
using glob expressions because the return format for glob listings
differs from server to server and will likely cause this method to fail.
- Parameters:
- parser - The
FTPFileListParser
that should be
used to parse the server file listing.
- pathname - The file or directory to list.
- Returns:
- The list of file information contained in the given path in
the format determined by the
parser
parameter.
- 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 a
command to the server or receiving a reply from the server.
listFiles
public FTPFile[] listFiles(FTPFileListParser parser) throws IOException
- Using a programmer specified
FTPFileListParser
,
obtain a list of file information for the current working directory.
This information is obtained through the LIST command.
The contents of the array returned is determined by the
FTPFileListParser
used.
- Parameters:
- parser - The
FTPFileListParser
that should be
used to parse the server file listing.
- Returns:
- The list of file information contained in the given path in
the format determined by the
parser
parameter.
- 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 a
command to the server or receiving a reply from the server.
listFiles
public FTPFile[] listFiles(String pathname) throws IOException
- Using the
DefaultFTPFileListParser
, obtain a list of
file information
for a directory or information for just a single file. This information
is obtained through the LIST command. If the given
pathname is a directory and contains no files, null
is
returned, otherwise an array of FTPFile
instances
representing the files in the directory is returned.
If the pathname corresponds to a file, only the information for that
file will be contained in the array (which will be of length 1). The
server may or may not expand glob expressions. You should avoid using
glob expressions because the return format for glob listings differs
from server to server and will likely cause this method to fail.
- Parameters:
- pathname - The file or directory to list.
- Returns:
- The list of file information contained in the given path. null
if the list could not be obtained or if there are no files in
the directory.
- 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 a
command to the server or receiving a reply from the server.
listFiles
public FTPFile[] listFiles() throws IOException
- Using the
DefaultFTPFileListParser
, obtain a list of
file information for the current working directory. This information
is obtained through the LIST command. If the given
current directory contains no files null is returned, otherwise an
array of FTPFile
instances representing the files in the
directory is returned.
- Returns:
- The list of file information contained in the current working
directory. null if the list could not be obtained or if there are
no files in the directory.
- 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 a
command to the server or receiving a reply from the server.
getStatus
public String getStatus() throws IOException
- Issue the FTP STAT command to the server.
- Returns:
- The status information returned by 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 a
command to the server or receiving a reply from the server.
getStatus
public String getStatus(String pathname) throws IOException
- Issue the FTP STAT command to the server for a given pathname. This
should produce a listing of the file or directory.
- Returns:
- The status information returned by 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 a
command to the server or receiving a reply from the server.
All Packages Class Hierarchy This Package Previous Next Index