FTP_DATA_PORT
public static final int FTP_DATA_PORT
The FTP data port.
- 20
FTP_PORT
public static final int FTP_PORT
The default FTP transmission control port.
- 21
connectionTimeout
protected int connectionTimeout
The timeout when attempting to connect a socket.
debug
protected boolean debug
If true, print debugging information.
dtp
protected gnu.inet.ftp.DTP dtp
The current data transfer process in use by this connection.
fileStructure
protected int fileStructure
The current file structure type.
passive
protected boolean passive
If true, use passive mode.
socket
protected Socket socket
The socket used to communicate with the server.
timeout
protected int timeout
The read timeout on sockets.
transferMode
protected int transferMode
The current transfer mode.
FTPConnection
public FTPConnection(String hostname,
int port,
int connectionTimeout,
int timeout,
boolean debug)
throws UnknownHostException,
IOException Creates a new connection to the server.
hostname - the hostname of the server to connect toport - the port to connect to(if <=0, use default port)connectionTimeout - the connection timeout, in millisecondstimeout - the I/O timeout, in millisecondsdebug - print debugging information
abort
public boolean abort()
throws IOException Aborts the transfer in progress.
- true if a transfer was in progress, false otherwise
allocate
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.
size - the number of bytes of storage to allocate
append
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.
filename - the name of the file to save the content as
- an OutputStream to write the file data to
authenticate
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.
username - the usernamepassword - the optional password
- true on success, false otherwise
changeToParentDirectory
public boolean changeToParentDirectory()
throws IOException Changes directory to the parent of the current working directory.
- true on success, false otherwise
changeWorkingDirectory
public boolean changeWorkingDirectory(String path)
throws IOException Changes directory to the specified path.
path - an absolute or relative pathname
- true on success, false if the specified path does not exist
delete
public boolean delete(String filename)
throws IOException Causes the file specified to be deleted at the server site.
filename - the file to delete
getFileStructure
public int getFileStructure()
Returns the current file structure type.
- STRUCTURE_FILE, STRUCTURE_RECORD, or STRUCTURE_PAGE
getRepresentationType
public int getRepresentationType()
Returns the current representation type of the transfer data.
- TYPE_ASCII, TYPE_EBCDIC, or TYPE_BINARY
getResponse
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.
getTransferMode
public int getTransferMode()
Returns the current transfer mode.
- MODE_STREAM, MODE_BLOCK, or MODE_COMPRESSED
list
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.
pathname - the context pathname, or null
logout
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.
makeDirectory
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.
pathname - the directory to create
nameList
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.
pathname - the directory pathname, or null
- a list of filenames(strings)
noop
public void noop()
throws IOException Does nothing.
This method can be used to ensure that the connection does not time
out.
reinitialize
public void reinitialize()
throws IOException Terminates an authenticated login.
If file transfer is in progress, it remains active for result response
only.
removeDirectory
public boolean removeDirectory(String pathname)
throws IOException Causes the directory specified to be deleted.
This may be an absolute or relative pathname.
pathname - the directory to delete
rename
public boolean rename(String oldName,
String newName)
throws IOException Renames a file.
oldName - the current name of the filenewName - the new name
- true if successful, false otherwise
retrieve
public InputStream retrieve(String filename)
throws IOException Retrieves the specified file.
filename - the filename of the file to retrieve
- an InputStream containing the file content
send
protected void send(String cmd)
throws IOException Sends the specified command line to the server.
The CRLF sequence is automatically appended.
cmd - the command line to send
setFileStructure
public void setFileStructure(int structure)
throws IOException Sets the desired file structure type.
structure - STRUCTURE_FILE, STRUCTURE_RECORD, or STRUCTURE_PAGE
setPassive
public void setPassive(boolean flag)
throws IOException Set passive mode.
flag - true if we should use passive mode, false otherwise
setRepresentationType
public void setRepresentationType(int type)
throws IOException Sets the desired representation type of the transfer data.
type - TYPE_ASCII, TYPE_EBCDIC, or TYPE_BINARY
setTransferMode
public void setTransferMode(int mode)
throws IOException Sets the desired transfer mode.
mode - MODE_STREAM, MODE_BLOCK, or MODE_COMPRESSED
starttls
public boolean starttls(boolean confidential)
throws IOException Negotiates TLS over the current connection.
See IETF draft-murray-auth-ftp-ssl-15.txt for details.
confidential - whether to provide confidentiality for the
connection
starttls
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.
confidential - whether to provide confidentiality for the
connectiontm - the trust manager used to validate the server certificate.
store
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.
filename - the name of the file to save the content as
- an OutputStream to write the file data to
* FTPConnection.java
* Copyright (C) 2003 The Free Software Foundation
*
* This file is part of GNU inetlib, a library.
*
* GNU inetlib is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* GNU inetlib is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Linking this library statically or dynamically with other modules is
* making a combined work based on this library. Thus, the terms and
* conditions of the GNU General Public License cover the whole
* combination.
*
* As a special exception, the copyright holders of this library give you
* permission to link this library with independent modules to produce an
* executable, regardless of the license terms of these independent
* modules, and to copy and distribute the resulting executable under
* terms of your choice, provided that you also meet, for each linked
* independent module, the terms and conditions of the license of that
* module. An independent module is a module which is not derived from
* or based on this library. If you modify this library, you may extend
* this exception to your version of the library, but you are not
* obliged to do so. If you do not wish to do so, delete this
* exception statement from your version.