⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.net.ftp

Class FTP

org.apache.commons.net.telnet.Telnet
|
+--org.apache.commons.net.telnet.TelnetClient
   |
   +--org.apache.commons.net.ftp.FTP

Known Direct Subclasses:
FTPClient

public class FTP
extends TelnetClient

FTP provides the basic the functionality necessary to implement your own FTP client. It extends org.apache.commons.net.TelnetClient simply because it saves the writing of extra code to handle the FTP control connection which always remains open during an FTP session and uses the Telnet protocol. Aggregation would require writing new wrapper methods and wouldn't leverage the functionality already present in org.apache.commons.net.SocketClient.

To derive the full benefits of the FTP class requires some knowledge of the FTP protocol defined in RFC 959. However, there is no reason why you should have to use the FTP class. The FTPClient class, derived from FTP, implements all the functionality required of an FTP client. The FTP class is made public to provide access to various FTP constants and to make it easier for adventurous programmers (or those with special needs) to interact with the FTP protocol and implement their own clients. A set of methods with names corresponding to the FTP command names are provided to facilitate this interaction.

You should keep in mind that the FTP server may choose to prematurely close a connection if the client has been idle for longer than a given time period (usually 900 seconds). The FTP class will detect a premature FTP server connection closing when it receives a FTPReply.SERVICE_NOT_AVAILABLE response to a command. When that occurs, the FTP class method encountering that reply will throw an FTPConnectionClosedException . FTPConectionClosedException is a subclass of IOException and therefore need not be caught separately, but if you are going to catch it separately, its catch block must appear before the more general IOException catch block. When you encounter an FTPConnectionClosedException , you must disconnect the connection with disconnect() to properly clean up the system resources used by FTP. Before disconnecting, you may check the last reply code and text with getReplyCode , getReplyString , and getReplyStrings. You may avoid server disconnections while the client is idle by periodicaly sending NOOP commands to the server.

Rather than list it separately for each method, we mention here that every method communicating with the server and throwing an IOException can also throw a MalformedServerReplyException , which is a subclass of IOException. A MalformedServerReplyException will be thrown when the reply received from the server deviates enough from the protocol specification that it cannot be interpreted in a useful manner despite attempts to be as lenient as possible.

Author:
Daniel F. Savarese
See Also:
FTPClient
FTPConnectionClosedException
org.apache.commons.net.MalformedServerReplyException

Field Summary

static int

ASCII_FILE_TYPE

A constant used to indicate the file(s) being transfered should be treated as ASCII.

static int

BINARY_FILE_TYPE

A constant used to indicate the file(s) being transfered should be treated as a binary image, i.e., no translations should be performed.

static int

BLOCK_TRANSFER_MODE

A constant used to indicate a file is to be transfered as a series of blocks.

static int

CARRIAGE_CONTROL_TEXT_FORMAT

A constant used to indicate a text file contains ASA vertical format control characters.

static int

COMPRESSED_TRANSFER_MODE

A constant used to indicate a file is to be transfered as FTP compressed data.

static int

DEFAULT_DATA_PORT

The default FTP data port (20).

static int

DEFAULT_PORT

The default FTP control port (21).

static int

EBCDIC_FILE_TYPE

A constant used to indicate the file(s) being transfered should be treated as EBCDIC.

static int

FILE_STRUCTURE

A constant used to indicate a file is to be treated as a continuous sequence of bytes.

static int

IMAGE_FILE_TYPE

A constant used to indicate the file(s) being transfered should be treated as a binary image, i.e., no translations should be performed.

static int

LOCAL_FILE_TYPE

A constant used to indicate the file(s) being transfered should be treated as a local type.

static int

NON_PRINT_TEXT_FORMAT

A constant used for text files to indicate a non-print text format.

static int

PAGE_STRUCTURE

A constant used to indicate a file is to be treated as a set of independent indexed pages.

static int

RECORD_STRUCTURE

A constant used to indicate a file is to be treated as a sequence of records.

static int

STREAM_TRANSFER_MODE

A constant used to indicate a file is to be transfered as a stream of bytes.

static int

TELNET_TEXT_FORMAT

A constant used to indicate a text file contains format vertical format control characters.

ProtocolCommandSupport

_commandSupport_

A ProtocolCommandSupport object used to manage the registering of ProtocolCommandListeners and te firing of ProtocolCommandEvents.

Constructor Summary

FTP()

The default FTP constructor.

Method Summary

void

_connectAction_()

int

abor()

A convenience method to send the FTP ABOR command to the server, receive the reply, and return the reply code.

int

acct(String account)

A convenience method to send the FTP ACCT command to the server, receive the reply, and return the reply code.

void

addProtocolCommandListener(ProtocolCommandListener listener)

Adds a ProtocolCommandListener.

int

allo(int bytes)

A convenience method to send the FTP ALLO command to the server, receive the reply, and return the reply code.

int

allo(int bytes, int recordSize)

A convenience method to send the FTP ALLO command to the server, receive the reply, and return the reply code.

int

appe(String pathname)

A convenience method to send the FTP APPE command to the server, receive the reply, and return the reply code.

int

cdup()

A convenience method to send the FTP CDUP command to the server, receive the reply, and return the reply code.

int

cwd(String directory)

A convenience method to send the FTP CWD command to the server, receive the reply, and return the reply code.

int

dele(String pathname)

A convenience method to send the FTP DELE command to the server, receive the reply, and return the reply code.

void

disconnect()

Closes the control connection to the FTP server and sets to null some internal data so that the memory may be reclaimed by the garbage collector.

int

getReply()

Fetches a reply from the FTP server and returns the integer reply code.

int

getReplyCode()

Returns the integer value of the reply code of the last FTP reply.

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.

String[]

getReplyStrings()

Returns the lines of text from the last FTP server response as an array of strings, one entry per line.

int

help()

A convenience method to send the FTP HELP command to the server, receive the reply, and return the reply code.

int

help(String command)

A convenience method to send the FTP HELP command to the server, receive the reply, and return the reply code.

int

list()

A convenience method to send the FTP LIST command to the server, receive the reply, and return the reply code.

int

list(String pathname)

A convenience method to send the FTP LIST command to the server, receive the reply, and return the reply code.

int

mkd(String pathname)

A convenience method to send the FTP MKD command to the server, receive the reply, and return the reply code.

int

mode(int mode)

A convenience method to send the FTP MODE command to the server, receive the reply, and return the reply code.

int

nlst()

A convenience method to send the FTP NLST command to the server, receive the reply, and return the reply code.

int

nlst(String pathname)

A convenience method to send the FTP NLST command to the server, receive the reply, and return the reply code.

int

noop()

A convenience method to send the FTP NOOP command to the server, receive the reply, and return the reply code.

int

pass(String password)

A convenience method to send the FTP PASS command to the server, receive the reply, and return the reply code.

int

pasv()

A convenience method to send the FTP PASV command to the server, receive the reply, and return the reply code.

int

port(InetAddress host, int port)

A convenience method to send the FTP PORT command to the server, receive the reply, and return the reply code.

int

pwd()

A convenience method to send the FTP PWD command to the server, receive the reply, and return the reply code.

int

quit()

A convenience method to send the FTP QUIT command to the server, receive the reply, and return the reply code.

int

rein()

A convenience method to send the FTP REIN command to the server, receive the reply, and return the reply code.

void

removeProtocolCommandistener(ProtocolCommandListener listener)

Removes a ProtocolCommandListener.

int

rest(String marker)

A convenience method to send the FTP REST command to the server, receive the reply, and return the reply code.

int

retr(String pathname)

A convenience method to send the FTP RETR command to the server, receive the reply, and return the reply code.

int

rmd(String pathname)

A convenience method to send the FTP RMD command to the server, receive the reply, and return the reply code.

int

rnfr(String pathname)

A convenience method to send the FTP RNFR command to the server, receive the reply, and return the reply code.

int

rnto(String pathname)

A convenience method to send the FTP RNTO command to the server, receive the reply, and return the reply code.

int

sendCommand(String command, String args)

Sends an FTP command to the server, waits for a reply and returns the numerical response code.

int

sendCommand(int command, String args)

Sends an FTP command to the server, waits for a reply and returns the numerical response code.

int

sendCommand(String command)

Sends an FTP command with no arguments to the server, waits for a reply and returns the numerical response code.

int

sendCommand(int command)

Sends an FTP command with no arguments to the server, waits for a reply and returns the numerical response code.

int

site(String parameters)

A convenience method to send the FTP SITE command to the server, receive the reply, and return the reply code.

int

smnt(String dir)

A convenience method to send the FTP SMNT command to the server, receive the reply, and return the reply code.

int

stat()

A convenience method to send the FTP STAT command to the server, receive the reply, and return the reply code.

int

stat(String pathname)

A convenience method to send the FTP STAT command to the server, receive the reply, and return the reply code.

int

stor(String pathname)

A convenience method to send the FTP STOR command to the server, receive the reply, and return the reply code.

int

stou()

A convenience method to send the FTP STOU command to the server, receive the reply, and return the reply code.

int

stou(String pathname)

A convenience method to send the FTP STOU command to the server, receive the reply, and return the reply code.

int

stru(int structure)

A convenience method to send the FTP STRU command to the server, receive the reply, and return the reply code.

int

syst()

A convenience method to send the FTP SYST command to the server, receive the reply, and return the reply code.

int

type(int fileType, int formatOrByteSize)

A convenience method to send the FTP TYPE command for text files to the server, receive the reply, and return the reply code.

int

type(int fileType)

A convenience method to send the FTP TYPE command to the server, receive the reply, and return the reply code.

int

user(String username)

A convenience method to send the FTP USER command to the server, receive the reply, and return the reply code.

Field Details

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.

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.

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.

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).

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.

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). **

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.

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.

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.

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).

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.

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.

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.

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).

_commandSupport_

protected ProtocolCommandSupport _commandSupport_

A ProtocolCommandSupport object used to manage the registering of ProtocolCommandListeners and te firing of ProtocolCommandEvents.

Constructor Details

FTP

public FTP()

The default FTP constructor. Sets the default port to DEFAULT_PORT and initializes internal data structures for saving FTP reply information.

Method Details

_connectAction_

protected void _connectAction_()

abor

public int abor()

A convenience method to send the FTP ABOR command to the server, receive the reply, and return the reply code.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

acct

public int acct(String account)

A convenience method to send the FTP ACCT command to the server, receive the reply, and return the reply code.

Parameters:
account - The account name to access.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

addProtocolCommandListener

public void addProtocolCommandListener(ProtocolCommandListener listener)

Adds a ProtocolCommandListener. Delegates this task to _commandSupport_ .

Parameters:
listener - The ProtocolCommandListener to add.

allo

public int allo(int bytes)

A convenience method to send the FTP ALLO command to the server, receive the reply, and return the reply code.

Parameters:
bytes - The number of bytes to allocate.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

allo

public int allo(int bytes, int recordSize)

A convenience method to send the FTP ALLO command to the server, receive the reply, and return the reply code.

Parameters:
bytes - The number of bytes to allocate.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

appe

public int appe(String pathname)

A convenience method to send the FTP APPE command to the server, receive the reply, and return the reply code. 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.
- If an I/O error occurs while either sending the command or receiving the server reply.

cdup

public int cdup()

A convenience method to send the FTP CDUP command to the server, receive the reply, and return the reply code.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

cwd

public int cwd(String directory)

A convenience method to send the FTP CWD command to the server, receive the reply, and return the reply code.

Parameters:
directory - The new working directory.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

dele

public int dele(String pathname)

A convenience method to send the FTP DELE command to the server, receive the reply, and return the reply code.

Parameters:
pathname - The pathname to delete.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

disconnect

public void disconnect()

Closes the control connection to the FTP server and sets to null some internal data so that the memory may be reclaimed by the garbage collector. The reply text and code information from the last command is voided so that the memory it used may be reclaimed.

Throws:
- If an error occurs while disconnecting.

getReply

public int getReply()

Fetches a reply from the FTP server and returns the integer reply code. After calling this method, the actual reply text can be accessed from either calling getReplyString or getReplyStrings . Only use this method if you are implementing your own FTP client or if you need to fetch a secondary response from the FTP server.

Returns:
The integer value of the reply code of the fetched FTP reply.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while 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.

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.

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.

help

public int help()

A convenience method to send the FTP HELP command to the server, receive the reply, and return the reply code.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

help

public int help(String command)

A convenience method to send the FTP HELP command to the server, receive the reply, and return the reply code.

Parameters:
command - The command name on which to request help.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

list

public int list()

A convenience method to send the FTP LIST command to the server, receive the reply, and return the reply code. Remember, it is up to you to manage the data connection. If you don't need this low level of access, use FTPClient, which will handle all low level details for you.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

list

public int list(String pathname)

A convenience method to send the FTP LIST command to the server, receive the reply, and return the reply code. 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.
- If an I/O error occurs while either sending the command or receiving the server reply.

mkd

public int mkd(String pathname)

A convenience method to send the FTP MKD command to the server, receive the reply, and return the reply code.

Parameters:
pathname - The pathname of the new directory to create.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

mode

public int mode(int mode)

A convenience method to send the FTP MODE command to the server, receive the reply, and return the reply code.

Parameters:
mode - The transfer mode to use (one of 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.
- If an I/O error occurs while either sending the command or receiving the server reply.

nlst

public int nlst()

A convenience method to send the FTP NLST command to the server, receive the reply, and return the reply code. Remember, it is up to you to manage the data connection. If you don't need this low level of access, use FTPClient, which will handle all low level details for you.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

nlst

public int nlst(String pathname)

A convenience method to send the FTP NLST command to the server, receive the reply, and return the reply code. 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.
- If an I/O error occurs while either sending the command or receiving the server reply.

noop

public int noop()

A convenience method to send the FTP NOOP command to the server, receive the reply, and return the reply code.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

pass

public int pass(String password)

A convenience method to send the FTP PASS command to the server, receive the reply, and return the reply code.

Parameters:
password - The plain text password of the username being logged into.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

pasv

public int pasv()

A convenience method to send the FTP PASV command to the server, receive the reply, and return the reply code. Remember, it's up to you to interpret the reply string containing the host/port information.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

port

public int port(InetAddress host, int port)

A convenience method to send the FTP PORT command to the server, receive the reply, and return the reply code.

Parameters:
host - The host owning the port.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

pwd

public int pwd()

A convenience method to send the FTP PWD command to the server, receive the reply, and return the reply code.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

quit

public int quit()

A convenience method to send the FTP QUIT command to the server, receive the reply, and return the reply code.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

rein

public int rein()

A convenience method to send the FTP REIN command to the server, receive the reply, and return the reply code.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

removeProtocolCommandistener

public void removeProtocolCommandistener(ProtocolCommandListener listener)

Removes a ProtocolCommandListener. Delegates this task to _commandSupport_ .

Parameters:
listener - The ProtocolCommandListener to remove.

rest

public int rest(String marker)

A convenience method to send the FTP REST command to the server, receive the reply, and return the reply code.

Parameters:
marker - The marker at which to restart a transfer.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

retr

public int retr(String pathname)

A convenience method to send the FTP RETR command to the server, receive the reply, and return the reply code. 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.
- If an I/O error occurs while either sending the command or receiving the server reply.

rmd

public int rmd(String pathname)

A convenience method to send the FTP RMD command to the server, receive the reply, and return the reply code.

Parameters:
pathname - The pathname of the directory to remove.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

rnfr

public int rnfr(String pathname)

A convenience method to send the FTP RNFR command to the server, receive the reply, and return the reply code.

Parameters:
pathname - The pathname to rename from.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

rnto

public int rnto(String pathname)

A convenience method to send the FTP RNTO command to the server, receive the reply, and return the reply code.

Parameters:
pathname - The pathname to rename to
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

sendCommand

public int sendCommand(String command)

Sends an FTP command with no arguments to the server, waits for a reply and returns the numerical response code. 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.
- If an I/O error occurs while either sending the command or receiving the server reply.

sendCommand

public int sendCommand(String command, String args)

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.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

sendCommand

public int sendCommand(int command)

Sends an FTP command with no arguments to the server, waits for a reply and returns the numerical response code. 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.
- If an I/O error occurs while either sending the command or receiving the server reply.

sendCommand

public int sendCommand(int command, String args)

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.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

site

public int site(String parameters)

A convenience method to send the FTP SITE command to the server, receive the reply, and return the reply code.

Parameters:
parameters - The site parameters to send.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

smnt

public int smnt(String dir)

A convenience method to send the FTP SMNT command to the server, receive the reply, and return the reply code.

Parameters:
dir - The directory name.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

stat

public int stat()

A convenience method to send the FTP STAT command to the server, receive the reply, and return the reply code.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

stat

public int stat(String pathname)

A convenience method to send the FTP STAT command to the server, receive the reply, and return the reply code.

Parameters:
pathname - A pathname to list.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

stor

public int stor(String pathname)

A convenience method to send the FTP STOR command to the server, receive the reply, and return the reply code. 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.
- If an I/O error occurs while either sending the command or receiving the server reply.

stou

public int stou()

A convenience method to send the FTP STOU command to the server, receive the reply, and return the reply code. Remember, it is up to you to manage the data connection. If you don't need this low level of access, use FTPClient, which will handle all low level details for you.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

stou

public int stou(String pathname)

A convenience method to send the FTP STOU command to the server, receive the reply, and return the reply code. 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.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

stru

public int stru(int structure)

A convenience method to send the FTP STRU command to the server, receive the reply, and return the reply code.

Parameters:
structure - The structure of the file (one of the _STRUCTURE constants).
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.
- If an I/O error occurs while either sending the command or receiving the server reply.

syst

public int syst()

A convenience method to send the FTP SYST command to the server, receive the reply, and return the reply code.

Returns:
The reply code received from the server.
Throws:
FTPConnectionClosedException - If the FTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send FTP reply code 421.
- If an I/O error occurs while either sending the command or receiving the server reply.

type

public int type(int fileType)

A convenience method to send the FTP TYPE command to the server, receive the reply, and return the reply code.

Parameters:
fileType - The type of the file (one of the FILE_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.
- If an I/O error occurs while either sending the command or receiving the server reply.

type

public int type(int fileType, int formatOrByteSize)

A convenience method to send the FTP TYPE command for text files to the server, receive the reply, and return the reply code.

Parameters:
fileType - The type of the file (one of the FILE_TYPE constants).
formatOrByteSize - The format of the file (one of the _FORMAT 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.
- If an I/O error occurs while either sending the command or receiving the server reply.

user

public int user(String username)

A convenience method to send the FTP USER command to the server, receive the reply, and return the reply code.

Parameters:
username - The username to login under.
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.
- If an I/O error occurs while either sending the command or receiving the server reply.
Generated on August 17, 2004 by GNU Classpath Tools (Gjdoc XmlDoclet 0.6.1).