FTP Client
A B C D E F G H I L M N O P Q R S T U W

A

ABORT_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"abor" - abort a file transfer
ACCOUNT_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"acct" - send account information
ANON_PASSWORD - Static variable in class com.amoebacode.ftp.FTPClient
The password for anonymous login
ANON_USERNAME - Static variable in class com.amoebacode.ftp.FTPClient
The username for anonymous login
APPEND_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"appe" - append to a remote file
ASCII_TRANSFER_TYPE - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"a" - ascii transfer type
asciiTransfer - Variable in class com.amoebacode.ftp.FTPClient
Indicates whether this client is currently in ASCII transfer mode

B

BINARY_TRANSFER_TYPE - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"i" - binary transfer type

C

CHANGE_DIRECTORY_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"cwd" - change working directory
CURRENT_RELATIVE_DIRECTORY - Static variable in class com.amoebacode.ftp.FTPUtil
The current relative directory filename
CustomFTPCommandRegistry - class com.amoebacode.ftp.CustomFTPCommandRegistry.
CustomFTPCommandRegistry includes custom FTP commands to use with specific servers.
CustomFTPCommandRegistry() - Constructor for class com.amoebacode.ftp.CustomFTPCommandRegistry
 
changeDirectory(String) - Method in class com.amoebacode.ftp.FTPClient
Changes the current FTP server directory to the specified (absolute or relative) path.
closeConnection() - Method in class com.amoebacode.ftp.FTPClient
Disconnects this client from the FTP server.
closeConnection() - Method in class com.amoebacode.ftp.FTPSocket
Closes this connection from the FTP server.
com.amoebacode.ftp - package com.amoebacode.ftp
 
connectionSocket - Variable in class com.amoebacode.ftp.FTPSocket
The communication socket connecting the FTP client and server

D

DEFAULT_PORT - Static variable in class com.amoebacode.ftp.FTPClient
The default FTP port (21)
DELETE_FILE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"dele" - delete a remote file
debugMode - Variable in class com.amoebacode.ftp.FTPSocket
Indicates whether server responses should be logged
debugPrint(String) - Method in class com.amoebacode.ftp.FTPSocket
When debug mode is on, prints the specified message to the System output stream.
deleteFile(String) - Method in class com.amoebacode.ftp.FTPClient
Deletes the specified file from the FTP server.
downloadDirectory(String, String, boolean, boolean) - Method in class com.amoebacode.ftp.FTPClient
Downloads the specified directory from the FTP server to the specified local path using the specified transfer mode.
downloadDirectory(String, boolean, boolean) - Method in class com.amoebacode.ftp.FTPClient
Downloads the current working directory from the FTP server to the specified local path using the specified transfer mode.
downloadFile(String) - Method in class com.amoebacode.ftp.FTPClient
Downloads the specified file from the FTP server to the current local working directory using the current client transfer mode.
downloadFile(String, String) - Method in class com.amoebacode.ftp.FTPClient
Downloads the specified file from the FTP server to the specified local path using the current client transfer mode.
downloadFile(String, String, boolean) - Method in class com.amoebacode.ftp.FTPClient
Downloads the specified file from the FTP server to the specified local path using the specified transfer mode.

E

executeCommand(String) - Method in class com.amoebacode.ftp.FTPSocket
Sends the specified command to the FTP server.
executeCompleteCommand(String) - Method in class com.amoebacode.ftp.FTPSocket
Sends the specified command to the FTP server (expecting a positive complete response).
executeDataCommand(String, OutputStream) - Method in class com.amoebacode.ftp.FTPSocket
Sends the specified data command to the FTP server, transferring the results to the specified output stream.
executeDataCommand(String, InputStream) - Method in class com.amoebacode.ftp.FTPSocket
Sends the specified data command to the FTP server, then transfers the contents of the specified input stream.
executeIntermediateCommand(String) - Method in class com.amoebacode.ftp.FTPSocket
Sends the specified command to the FTP server (expecting a positive intermediate response).
executePreliminaryCommand(String) - Method in class com.amoebacode.ftp.FTPSocket
Sends the specified command to the FTP server (expecting a positive preliminary response).
executeSiteCommand(String) - Method in class com.amoebacode.ftp.FTPClient
Executes the SITE command on the FTP server with the given argument.

F

FILE_SIZE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"size" - return the size of a file
FTPClient - class com.amoebacode.ftp.FTPClient.
FTPClient is a public class that handles many standard FTP client commands, including opening and closing connections, uploading and downloading files, creating and removing directories, renaming and deleting files, etc.
FTPClient() - Constructor for class com.amoebacode.ftp.FTPClient
Default public constructor creates an FTP client with debug mode turned off and the default socket timeout.
FTPClient(boolean) - Constructor for class com.amoebacode.ftp.FTPClient
Public constructor creates an FTP client with the specified debug mode and the default socket timeout.
FTPClient(int, boolean) - Constructor for class com.amoebacode.ftp.FTPClient
Public constructor creates an FTP client with the specified debug mode and socket timeout.
FTPCommandRegistry - class com.amoebacode.ftp.FTPCommandRegistry.
FTPCommandRegistry includes all basic FTP commands and provides convenience methods for concatenating commands with arguments.
FTPCommandRegistry() - Constructor for class com.amoebacode.ftp.FTPCommandRegistry
 
FTPServerResponse - class com.amoebacode.ftp.FTPServerResponse.
FTPServerResponse is a wrapper for FTP server responses, including response codes and text messages.
FTPServerResponse(int, String) - Constructor for class com.amoebacode.ftp.FTPServerResponse
Default protected constructor.
FTPServerResponse(String) - Constructor for class com.amoebacode.ftp.FTPServerResponse
Protected constructor parses the response code and text message from the full response String.
FTPSocket - class com.amoebacode.ftp.FTPSocket.
FTPSocket encapsulates all communication between the FTP client and the FTP server.
FTPSocket(int, boolean) - Constructor for class com.amoebacode.ftp.FTPSocket
Default protected constructor.
FTPUtil - class com.amoebacode.ftp.FTPUtil.
FTPUtil provides static utility methods for the FTPClient and FTPSocket.
FTPUtil() - Constructor for class com.amoebacode.ftp.FTPUtil
 
ftpSocket - Variable in class com.amoebacode.ftp.FTPClient
The object that handles all communication with the FTP server

G

getChangeDirectoryCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a change directory command for the specified directory.
getCommandWithArgument(String, String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Composes a complete command from the specified command and argument.
getCurrentDirectory() - Method in class com.amoebacode.ftp.FTPClient
Returns the current working directory on the FTP server.
getDataSocket() - Method in class com.amoebacode.ftp.FTPSocket
Creates and returns a data socket between the client and the FTP server.
getDeleteFileCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a delete file command for the specified filename.
getFileSize(String) - Method in class com.amoebacode.ftp.FTPClient
Returns the size of the specified file on the FTP server.
getFileSizeCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a file size command for the specified filename.
getFullResponse() - Method in class com.amoebacode.ftp.FTPServerResponse
Returns the full FTP server response.
getIPAddress(String[]) - Static method in class com.amoebacode.ftp.FTPUtil
Constructs an IP address from the specified String array of numbers.
getMakeDirectoryCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a make directory command for the specified directory.
getModificationTime(String) - Method in class com.amoebacode.ftp.FTPClient
Returns the last modification time of the specified file on the FTP server.
getModifyDateCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a modify date command for the specified filename.
getNameArray() - Method in class com.amoebacode.ftp.FTPClient
Returns a String array representing the files and directories contained in the current FTP server working directory.
getNameList() - Method in class com.amoebacode.ftp.FTPClient
Returns a new-line-delimited String representing the files and directories contained in the current FTP server working directory.
getPasswordCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a password command for the specified password.
getPort(String[]) - Static method in class com.amoebacode.ftp.FTPUtil
Determines the port from the specified String array of numbers.
getRemoveDirectoryCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a remove directory command for the specified directory.
getRenameFromCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a rename from command for the specified filename.
getRenameToCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a rename to command for the specified filename.
getResponseCode() - Method in class com.amoebacode.ftp.FTPServerResponse
Returns the numeric code for this response (should be between 100 and 600).
getResponseCode() - Method in class com.amoebacode.ftp.IllegalFTPResponseException
Returns the numeric code from the FTP server response.
getResponseMessage() - Method in class com.amoebacode.ftp.FTPServerResponse
Returns the text message for this response.
getResponseMessage() - Method in class com.amoebacode.ftp.IllegalFTPResponseException
Returns the text message from the FTP server response.
getRetrieveCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a retrieve command for the specified filename.
getServerResponse() - Method in class com.amoebacode.ftp.FTPSocket
Returns the FTP server response to the last client command.
getSiteCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a SITE command for the specified filename.
added by Pinellas County Government jdr 9/27/2004
getStoreCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a store command for the specified filename.
getStringArray(StringTokenizer) - Static method in class com.amoebacode.ftp.FTPUtil
Returns a String array comprised of the elements of the specified StringTokenizer.
getSystemType() - Method in class com.amoebacode.ftp.FTPClient
Returns the system type of the FTP server.
getTransferType(boolean) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Converts the specified boolean to a String transfer type.
getTransferTypeCommand(boolean) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a transfer type command for the specified transfer type.
getUsernameCommand(String) - Static method in class com.amoebacode.ftp.FTPCommandRegistry
Returns a username command for the specified username.

H

HELP_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"help" - return help on using the server

I

IP_SEPARATOR - Static variable in class com.amoebacode.ftp.FTPUtil
A period (the IP address value delimiter)
IllegalFTPResponseException - exception com.amoebacode.ftp.IllegalFTPResponseException.
IllegalFTPResponseException is thrown whenever an FTP server returns an unexpected response to the previous command.
IllegalFTPResponseException(FTPServerResponse) - Constructor for class com.amoebacode.ftp.IllegalFTPResponseException
Default protected constructor.
inputStream - Variable in class com.amoebacode.ftp.FTPSocket
The input stream for the primary communication socket
isActionNotTaken() - Method in class com.amoebacode.ftp.FTPServerResponse
Indicates whether the response code corresponds to an action not taken error.
isActionNotTaken() - Method in class com.amoebacode.ftp.IllegalFTPResponseException
Indicates whether the FTP server response code indicates that the requested action was not taken.
isDirectoryExistsError() - Method in class com.amoebacode.ftp.FTPServerResponse
Indicates whether the response code corresponds to a directory exists error.
isDirectoryExistsError() - Method in class com.amoebacode.ftp.IllegalFTPResponseException
Indicates whether the FTP server response code indicates that the directory already exists.
isFTPResponse(String) - Static method in class com.amoebacode.ftp.FTPUtil
Indicates whether the specified line is a proper FTP server response.
isPermanentNegative() - Method in class com.amoebacode.ftp.FTPServerResponse
Indicates whether the response code corresponds to a permanent negative response.
isPositiveComplete() - Method in class com.amoebacode.ftp.FTPServerResponse
Indicates whether the response code corresponds to a positive complete response.
isPositiveIntermediate() - Method in class com.amoebacode.ftp.FTPServerResponse
Indicates whether the response code corresponds to a positive preliminary response.
isPositivePreliminary() - Method in class com.amoebacode.ftp.FTPServerResponse
Indicates whether the response code corresponds to a positive preliminary response.
isRelativePath(String) - Static method in class com.amoebacode.ftp.FTPUtil
Indicates whether the specified file name is a relative path filename.
isTransientNegative() - Method in class com.amoebacode.ftp.FTPServerResponse
Indicates whether the response code corresponds to a transient negative response.

L

LIST_FILES_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"list" - list remote files
lineSeparator - Variable in class com.amoebacode.ftp.FTPSocket
The line separator used for sending commands (default value is the "line.seperator" System property)
login(String, String) - Method in class com.amoebacode.ftp.FTPClient
Logs in this client to the FTP server using the specified username and password.
loginAnonymous() - Method in class com.amoebacode.ftp.FTPClient
Logs in this client anonymously to the FTP server.

M

MAKE_DIRECTORY_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"mkd" - make a remote directory
MODE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"mode" - set transfer mode
MODIFY_DATE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"mdtm" - return the modification time of a file
makeDirectory(String) - Method in class com.amoebacode.ftp.FTPClient
Creates a directory on the FTP server with the specified name.

N

NAME_LIST_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"nlst" - name list of remote directory
NULL_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"noop" - do nothing
nameListCommand - Variable in class com.amoebacode.ftp.FTPClient
 

O

openConnection(String) - Method in class com.amoebacode.ftp.FTPClient
Opens a connection to the specified host through the default FTP port.
openConnection(String, int) - Method in class com.amoebacode.ftp.FTPClient
Opens a connection to the specified host through the specified port.
openConnection(String, int) - Method in class com.amoebacode.ftp.FTPSocket
Opens a connection to the specified host through the specified port.
outputStream - Variable in class com.amoebacode.ftp.FTPSocket
The output stream for the primary communication socket

P

PASSIVE_MODE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"pasv" - enter passive mode
PASSWORD_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"pass" - send password
PORT_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"port" - open a data port
PRINT_DIRECTORY_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"pwd" - print working directory
parentDirectory() - Method in class com.amoebacode.ftp.FTPClient
Changes the current FTP server directory up one level to its parent directory.

Q

QUIT_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"quit" - terminate the connection
QUOTE - Static variable in class com.amoebacode.ftp.FTPUtil
A quotation mark

R

REINITIALIZE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"rein" - reinitialize the connection
REMOTE_DIR_SEPARATOR - Static variable in class com.amoebacode.ftp.FTPClient
The character that separates remote directories (/)
REMOVE_DIRECTORY_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"rmd" - remove a remote directory
RENAME_FROM_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"rnfr - rename from
RENAME_TO_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"rnto" - rename to
RETRIEVE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"retr" - retrieve a remote file
readDataToFile(String, String) - Method in class com.amoebacode.ftp.FTPSocket
Sends the specified data command to the FTP server, transferring the results to the file at the specified path.
readDataToString(String) - Method in class com.amoebacode.ftp.FTPSocket
Sends the specified data command to the FTP server, returning the results as a String array.
removeDirectory(String) - Method in class com.amoebacode.ftp.FTPClient
Removes the specified directory (including its contents and subdirectories) from the FTP server.
removeDirectoryContents() - Method in class com.amoebacode.ftp.FTPClient
Removes all files and subdirectories from the current directory on the FTP server.
removeSurroundingQuotes(String) - Static method in class com.amoebacode.ftp.FTPUtil
Returns surrounding quotation marks (when present) from the specified text.
renameFile(String, String) - Method in class com.amoebacode.ftp.FTPClient
Renames the specified file on the FTP server with the specified name.
response - Variable in class com.amoebacode.ftp.IllegalFTPResponseException
The FTP server response that led to this exception
responseCode - Variable in class com.amoebacode.ftp.FTPServerResponse
The numeric code for this response (should be between 100 and 600)
responseMessage - Variable in class com.amoebacode.ftp.FTPServerResponse
The text message for this response

S

SITE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"site" - site-specific commands
SOCKET_TIMEOUT - Static variable in class com.amoebacode.ftp.FTPClient
The default socket timeout (120 seconds)
SPACE - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
a single space
STATUS_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"stat" - return server status
STORE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"stor" - store a file on the remote host
STORE_UNIQUE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"stou" - store a file uniquely
STRUCTURE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"stru" - set file transfer structure
SYSTEM_TYPE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"syst" - return system type
setLineSeparator(String) - Method in class com.amoebacode.ftp.FTPClient
Sets the line separator used for sending commands.
setLineSeparator(String) - Method in class com.amoebacode.ftp.FTPSocket
Sets the line separator used for sending commands.
setNameListCommand(String) - Method in class com.amoebacode.ftp.FTPClient
Sets the name list command for this client.
setTransferType(boolean) - Method in class com.amoebacode.ftp.FTPClient
Sets the default transfer type (ASCII or binary) for this client.
setTransferType(boolean) - Method in class com.amoebacode.ftp.FTPSocket
Sets the transfer type (ASCII or binary) for this connection.
socketTimeout - Variable in class com.amoebacode.ftp.FTPSocket
The socket timeout delay

T

TRANSFER_TYPE_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"type" - set transfer type
transferData(InputStream, OutputStream) - Method in class com.amoebacode.ftp.FTPSocket
Transfers data in one kilobyte blocks from the specified input stream to the specified output stream.

U

UP_DIRECTORY_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"cdup" - cwd to the parent of the current directory
UP_RELATIVE_DIRECTORY - Static variable in class com.amoebacode.ftp.FTPUtil
The up relative directory filename
USERNAME_COMMAND - Static variable in class com.amoebacode.ftp.FTPCommandRegistry
"user" - send username
uploadDirectory(String, String, boolean, boolean) - Method in class com.amoebacode.ftp.FTPClient
Uploads the specified directory from the local machine to the specified path of the FTP server using the specified transfer mode.
uploadDirectory(String, String, boolean, boolean, FilenameFilter) - Method in class com.amoebacode.ftp.FTPClient
Uploads files matching the specified filename filter in the specified directory from the local machine to the specified path of the FTP server using the specified transfer mode.
uploadFile(String) - Method in class com.amoebacode.ftp.FTPClient
Uploads the specified file from the local machine to the current working directory of the FTP server using the current client transfer mode.
uploadFile(String, String) - Method in class com.amoebacode.ftp.FTPClient
Uploads the specified file from the local machine to the specified path of the FTP server using the current client transfer mode.
uploadFile(String, String, boolean) - Method in class com.amoebacode.ftp.FTPClient
Uploads the specified file from the local machine to the specified path of the FTP server using the specified transfer mode.

W

WU_FTP_NAME_LIST_COMMAND - Static variable in class com.amoebacode.ftp.CustomFTPCommandRegistry
"nlst -a" - name list of remote directory for WU-FTP servers
writeDataFromFile(String, String) - Method in class com.amoebacode.ftp.FTPSocket
Sends the specified data command to the FTP server, then transfers the contents of the file at the specified path.

A B C D E F G H I L M N O P Q R S T U W
FTP Client