Class FTPConnection

protected static final String ABOR

Field Value:

"ABOR"

protected static final String ACCT

Field Value:

"ACCT"

protected static final String ALLO

Field Value:

"ALLO"

protected static final String APPE

Field Value:

"APPE"

protected static final String AUTH

Field Value:

"AUTH"

protected static final String CCC

Field Value:

"CCC"

protected static final String CDUP

Field Value:

"CDUP"

protected static final String CWD

Field Value:

"CWD"

protected static final String DELE

Field Value:

"DELE"

public static final int FTP_DATA_PORT

The FTP data port.

Field Value:

20

public static final int FTP_PORT

The default FTP transmission control port.

Field Value:

21

protected static final String HELP

Field Value:

"HELP"

protected static final String LIST

Field Value:

"LIST"

protected static final String MKD

Field Value:

"MKD"

protected static final String MODE

Field Value:

"MODE"

public static final int MODE_BLOCK

Field Value:

2

public static final int MODE_COMPRESSED

Field Value:

3

public static final int MODE_STREAM

Field Value:

1

protected static final String NLST

Field Value:

"NLST"

protected static final String NOOP

Field Value:

"NOOP"

protected static final String PASS

Field Value:

"PASS"

protected static final String PASV

Field Value:

"PASV"

protected static final String PBSZ

Field Value:

"PBSZ"

protected static final String PORT

Field Value:

"PORT"

protected static final String PROT

Field Value:

"PROT"

protected static final String PWD

Field Value:

"PWD"

protected static final String QUIT

Field Value:

"QUIT"

protected static final String REIN

Field Value:

"REIN"

protected static final String REST

Field Value:

"REST"

protected static final String RETR

Field Value:

"RETR"

protected static final String RMD

Field Value:

"RMD"

protected static final String RNFR

Field Value:

"RNFR"

protected static final String RNTO

Field Value:

"RNTO"

protected static final String SITE

Field Value:

"SITE"

protected static final String SMNT

Field Value:

"SMNT"

protected static final String STAT

Field Value:

"STAT"

protected static final String STOR

Field Value:

"STOR"

protected static final String STOU

Field Value:

"STOU"

protected static final String STRU

Field Value:

"STRU"

public static final int STRUCTURE_FILE

Field Value:

1

public static final int STRUCTURE_PAGE

Field Value:

3

public static final int STRUCTURE_RECORD

Field Value:

2

protected static final String SYST

Field Value:

"SYST"

protected static final String TLS

Field Value:

"TLS"

protected static final String TYPE

Field Value:

"TYPE"

public static final int TYPE_ASCII

Field Value:

1

public static final int TYPE_BINARY

Field Value:

3

public static final int TYPE_EBCDIC

Field Value:

2

protected static final String USER

Field Value:

"USER"

protected int connectionTimeout

The timeout when attempting to connect a socket.

protected boolean debug

If true, print debugging information.

protected gnu.java.net.protocol.ftp.DTP dtp

The current data transfer process in use by this connection.

protected int fileStructure

The current file structure type.

protected LineInputStream in

The socket input stream.

protected CRLFOutputStream out

The socket output stream.

protected boolean passive

If true, use passive mode.

protected int representationType

The current representation type.

protected Socket socket

The socket used to communicate with the server.

protected int timeout

The read timeout on sockets.

protected int transferMode

The current transfer mode.

public FTPConnection(String hostname)
            throws UnknownHostException,
                   IOException

Creates a new connection to the server using the default port.

Parameters:

hostname - the hostname of the server to connect to

public FTPConnection(String hostname,
                     int port)
            throws UnknownHostException,
                   IOException

Creates a new connection to the server.

Parameters:

hostname - the hostname of the server to connect to

port - the port to connect to(if <=0, use default port)

public FTPConnection(String hostname,
                     int port,
                     int connectionTimeout,
                     int timeout,
                     boolean debug)
            throws UnknownHostException,
                   IOException

Creates a new connection to the server.

Parameters:

hostname - the hostname of the server to connect to

port - the port to connect to(if <=0, use default port)

connectionTimeout - the connection timeout, in milliseconds

timeout - the I/O timeout, in milliseconds

debug - print debugging information

public boolean abort()
            throws IOException

Aborts the transfer in progress.

Returns:

true if a transfer was in progress, false otherwise

public void allocate(long size)
            throws IOException

This command may be required by some servers to reserve sufficient storage to accommodate the new file to be transferred. It should be immediately followed by a store or append.

Parameters:

size - the number of bytes of storage to allocate

public OutputStream append(String filename)
            throws IOException

Returns a stream for uploading a file. If a file with the same filename already exists on the server, the content specified will be appended to the existing file.

Parameters:

filename - the name of the file to save the content as

Returns:

an OutputStream to write the file data to

public boolean authenticate(String username,
                            String password)
            throws IOException

Authenticate using the specified username and password. If the username suffices for the server, the password will not be used and may be null.

Parameters:

username - the username

password - the optional password

Returns:

true on success, false otherwise

public boolean changeToParentDirectory()
            throws IOException

Changes directory to the parent of the current working directory.

Returns:

true on success, false otherwise

public boolean changeWorkingDirectory(String path)
            throws IOException

Changes directory to the specified path.

Parameters:

path - an absolute or relative pathname

Returns:

true on success, false if the specified path does not exist

public boolean delete(String filename)
            throws IOException

Causes the file specified to be deleted at the server site.

Parameters:

filename - the file to delete

public int getFileStructure()

Returns the current file structure type.

Returns:

STRUCTURE_FILE, STRUCTURE_RECORD, or STRUCTURE_PAGE

public int getRepresentationType()

Returns the current representation type of the transfer data.

Returns:

TYPE_ASCII, TYPE_EBCDIC, or TYPE_BINARY

protected FTPResponse getResponse()
            throws IOException

Reads the next response from the server. If the server sends the "transfer complete" code, this is handled here, and the next response is passed to the caller.

public int getTransferMode()

Returns the current transfer mode.

Returns:

MODE_STREAM, MODE_BLOCK, or MODE_COMPRESSED

public String getWorkingDirectory()
            throws IOException

Returns the current working directory.

protected void initialiseDTP()
            throws IOException

Initialise the data transfer process.

public InputStream list(String pathname)
            throws IOException

Returns a listing of information about the specified pathname. If the pathname specifies a directory or other group of files, the server should transfer a list of files in the specified directory. If the pathname specifies a file then the server should send current information on the file. A null argument implies the user's current working or default directory.

Parameters:

pathname - the context pathname, or null

public void logout()
            throws IOException

Terminates the control connection. The file transfer connection remains open for result response only. This connection is invalid and no further commands may be issued.

public boolean makeDirectory(String pathname)
            throws IOException

Causes the directory specified to be created at the server site. This may be an absolute or relative pathname.

Parameters:

pathname - the directory to create

public List nameList(String pathname)
            throws IOException

Returns a directory listing. The pathname should specify a directory or other system-specific file group descriptor; a null argument implies the user's current working or default directory.

Parameters:

pathname - the directory pathname, or null

Returns:

a list of filenames(strings)

public void noop()
            throws IOException

Does nothing. This method can be used to ensure that the connection does not time out.

protected FTPResponse readResponse()
            throws IOException

Reads and parses the next response from the server.

public void reinitialize()
            throws IOException

Terminates an authenticated login. If file transfer is in progress, it remains active for result response only.

public boolean removeDirectory(String pathname)
            throws IOException

Causes the directory specified to be deleted. This may be an absolute or relative pathname.

Parameters:

pathname - the directory to delete

public boolean rename(String oldName,
                      String newName)
            throws IOException

Renames a file.

Parameters:

oldName - the current name of the file

newName - the new name

Returns:

true if successful, false otherwise

public InputStream retrieve(String filename)
            throws IOException

Retrieves the specified file.

Parameters:

filename - the filename of the file to retrieve

Returns:

an InputStream containing the file content

protected void send(String cmd)
            throws IOException

Sends the specified command line to the server. The CRLF sequence is automatically appended.

Parameters:

cmd - the command line to send

public void setFileStructure(int structure)
            throws IOException

Sets the desired file structure type.

Parameters:

structure - STRUCTURE_FILE, STRUCTURE_RECORD, or STRUCTURE_PAGE

public void setPassive(boolean flag)
            throws IOException

Set passive mode.

Parameters:

flag - true if we should use passive mode, false otherwise

public void setRepresentationType(int type)
            throws IOException

Sets the desired representation type of the transfer data.

Parameters:

type - TYPE_ASCII, TYPE_EBCDIC, or TYPE_BINARY

public void setTransferMode(int mode)
            throws IOException

Sets the desired transfer mode.

Parameters:

mode - MODE_STREAM, MODE_BLOCK, or MODE_COMPRESSED

public boolean starttls(boolean confidential)
            throws IOException

Negotiates TLS over the current connection. See IETF draft-murray-auth-ftp-ssl-15.txt for details.

Parameters:

confidential - whether to provide confidentiality for the connection

public boolean starttls(boolean confidential,
                        TrustManager tm)
            throws IOException

Negotiates TLS over the current connection. See IETF draft-murray-auth-ftp-ssl-15.txt for details.

Parameters:

confidential - whether to provide confidentiality for the connection

tm - the trust manager used to validate the server certificate.

public OutputStream store(String filename)
            throws IOException

Returns a stream for uploading a file. If a file with the same filename already exists on the server, it will be overwritten.

Parameters:

filename - the name of the file to save the content as

Returns:

an OutputStream to write the file data to

public String system()
            throws IOException

Returns the type of operating system at the server.