ftp2me
Class Ftp2Me

java.lang.Object
  ftp2me.Ftp2Me

public class Ftp2Me
extends java.lang.Object

Ftp client class for j2me Implements all of the RFC959 commands

Field Summary

static int

RESP_ALL

Constructor Summary

Ftp2Me(java.lang.String host)
Create an instance of Ftp2Me.

Ftp2Me(java.lang.String host, int port)
Create an instance of Ftp2Me.

Ftp2Me(java.lang.String host, int port, java.lang.String user, java.lang.String pass)
Create an instance of Ftp2Me.

Ftp2Me(java.lang.String host, int port, java.lang.String user, java.lang.String pass, java.lang.String acct)
Create an instance of Ftp2Me.

Method Summary

boolean	abor() Abort This command tells the server to abort the previous FTP service command and any associated transfer of data.
void	acct(java.lang.String account) Account The argument field is a Telnet string identifying the user’s account.
boolean	allo(long size, long maxRecordSize) Allocate This command may be required by some servers to reserve sufficient storage to accommodate the new file to be transferred.
void	appe(java.io.InputStream is, java.lang.String filename) Append (with create) This command causes the server-DTP to accept the data transferred via the data connection and to store the data in a file at the server site.
void	cdup() Change to parent directory This command is a special case of CWD, and is included to simplify the implementation of programs for transferring directory trees between operating systems having different syntaxes for naming the parent directory.
void	cwd(java.lang.String dir) Changes the working directory This command allows the user to work with a different directory or dataset for file storage or retrieval without altering his login or accounting information.
void	dele(java.lang.String filename) Delete This command causes the file specified in the pathname to be deleted at the server site.
void	disconnect() Disconnects from the FTP server.
void	expectResponse(int expectedCode) Gets a response.
java.lang.String	getLastMessage() Returns the last message from the server.
void	help(java.lang.String command) Help This command shall cause the server to send helpful information regarding its implementation status over the control connection to the user.
boolean	isNegativePermanent() Is the last message a negative permanent reply?
boolean	isNegativeTransient() Is the last message a negative transient reply?
boolean	isPositiveCompletion() Is the last message a positive completion reply?
boolean	isPositiveIntermediate() Is the last message a positive intermediate reply?
boolean	isPositivePreliminary() Is the last message a positive preliminary reply?
java.util.Enumeration	list() List This command causes a list to be sent from the server to the passive DTP.
void	mkd(java.lang.String pathname) Make directory This command causes the directory specified in the pathname to be created as a directory (if the pathname is absolute) or as a subdirectory of the current working directory (if the pathname is relative).
void	mode(char mode) Transfer mode The argument is a single Telnet character code specifying the data transfer modes described in the Section on Transmission Modes.
java.util.Enumeration	nlst() Name list This command causes a directory listing to be sent from server to user site.
void	noop() No operation This command does not affect any parameters or previously entered commands.
void	pass(java.lang.String pass) Password The argument field is a Telnet string specifying the user’s password.
PasvInfo	pasv() Passive This command requests the server-DTP to "listen" on a data port (which is not its default data port) and to wait for h1 connection rather than initiate one upon receipt of h1 transfer command.
void	port(int h1, int h2, int h3, int h4, int port) Data port The argument is a HOST-PORT specification for the data port to be used in data connection.
java.lang.String	pwd() Print working directory This command causes the name of the current working directory to be returned in the reply.
void	quit() Quit This command terminates a USER and if file transfer is not in progress, the server closes the control connection.
void	rein() Reinitialize This command terminates a USER, flushing all I/O and account information, except to allow any transfer in progress to be completed.
void	rest(java.lang.String marker) Restart file transfer The argument field represents the server marker at which file transfer is to be restarted.
void	retr(java.io.OutputStream outputStream, java.lang.String filename) Retrieve This command causes the server-DTP to transfer a copy of the file, specified in the pathname, to the server- or user-DTP at the other end of the data connection.
void	rmd(java.lang.String pathname) Remove directory This command causes the directory specified in the pathname to be removed as a directory (if the pathname is absolute) or as a subdirectory of the current working directory (if the pathname is relative).
void	rnfr(java.lang.String pathname) Rename from This command specifies the old pathname of the file which is to be renamed.
void	rnto(java.lang.String pathname) Rename to This command specifies the new pathname of the file specified in the immediately preceding "rename from" command.
void	site() Site parameters This command is used by the server to provide services specific to his system that are essential to file transfer but not sufficiently universal to be included as commands in the protocol.
void	smnt(java.lang.String pathname) Structure mount This command allows the user to mount a different file system data structure without altering his login or accounting information.
void	stat(java.lang.String pathname) Status This command shall cause a status response to be sent over the control connection in the form of a reply.
void	stor(java.io.InputStream is, java.lang.String filename) Store This command causes the server-DTP to accept the data transferred via the data connection and to store the data as a file at the server site.
void	stou(java.io.InputStream is, java.lang.String filename) Store unique This command behaves like STOR except that the resultant file is to be created in the current directory under a name unique to that directory.
void	stru(char structure) File structure The argument is a single Telnet character code specifying file structure described in the Section on Data Representation and Storage.
void	syst() System This command is used to find out the type of operating system at the server.
void	type(char type) Calls type(type, 8) ( see type(char type, int bytesize) )
void	type(char type, int bytesize) Set transfer type.
void	user(java.lang.String user) User name The argument field is a Telnet string identifying the user.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESP_ALL

public static final int RESP_ALL

See Also:

Constant Field Values

Constructor Detail

Ftp2Me

public Ftp2Me(java.lang.String host)
       throws java.io.IOException,
              FtpProtocolException

Create an instance of Ftp2Me. Connects to the given host, at port 21 User/pass/acct must be issued manually

Parameters:

host - Name of the host to connect to

Throws:

IOException, - FtpProtocolException

java.io.IOException

FtpProtocolException

Ftp2Me

public Ftp2Me(java.lang.String host,
              int port)
       throws java.io.IOException,
              FtpProtocolException

Create an instance of Ftp2Me. Connects to the given host and port User/pass/acct must be issued manually

Parameters:

host - Name of the host to connect to

port - Port on the host to connect to

Throws:

IOException, - FtpProtocolException

java.io.IOException

FtpProtocolException

Ftp2Me

public Ftp2Me(java.lang.String host,
              int port,
              java.lang.String user,
              java.lang.String pass)
       throws java.io.IOException,
              FtpProtocolException

Create an instance of Ftp2Me. Issues the USER and PASS commands

Parameters:

host - Name of the host to connect to

port - Port on the host to connect to

user - Username to use for login

pass - Password to use for login

Throws:

IOException, - FtpProtocolException

java.io.IOException

FtpProtocolException

Ftp2Me

public Ftp2Me(java.lang.String host,
              int port,
              java.lang.String user,
              java.lang.String pass,
              java.lang.String acct)
       throws java.io.IOException,
              FtpProtocolException

Create an instance of Ftp2Me. Issues the USER, PASS and ACCT commands

Parameters:

host - Name of the host to connect to

port - Port on the host to connect to

user - Username to use for login

pass - Password to use for login

acct - Account name to use with acct command

Throws:

IOException, - FtpProtocolException

java.io.IOException

FtpProtocolException

Method Detail

disconnect

public void disconnect()

Disconnects from the FTP server. Does NOT send the QUIT command, just closes the communication channels. It does not throw any exceptions or return error codes, it designed to be a "fire and forget" method.

abor

public boolean abor()
             throws java.io.IOException,
                    FtpProtocolException

Abort This command tells the server to abort the previous FTP service command and any associated transfer of data. The abort command may require "special action", as discussed in the RFC959 "Section on FTP Commands", to force recognition by the server. No action is to be taken if the previous command has been completed (including data transfer). The control connection is not to be closed by the server, but the data connection must be closed. There are two cases for the server upon receipt of this command: (1) the FTP service command was already completed, or (2) the FTP service command is still in progress. In the first case, the server closes the data connection (if it is open) and responds with a 226 reply, indicating that the abort command was successfully processed. In the second case, the server aborts the FTP service in progress and closes the data connection, returning a 426 reply to indicate that the service request terminated abnormally. The server then sends a 226 reply, indicating that the abort command was successfully processed.

Throws:

java.io.IOException

FtpProtocolException

acct

public void acct(java.lang.String account)
          throws java.io.IOException,
                 FtpProtocolException

Account The argument field is a Telnet string identifying the user’s account. The command is not necessarily related to the USER command, as some sites may require an account for login and others only for specific access, such as storing files. In the latter case the command may arrive at any time. There are reply codes to differentiate these cases for the automation: when account information is required for login, the response to a successful PASSword command is reply code 332. On the other hand, if account information is NOT required for login, the reply to a successful PASSword command is 230; and if the account information is needed for a command issued later in the dialogue, the server should return a 332 or 532 reply depending on whether it stores (pending receipt of the ACCounT command) or discards the command, respectively.

Throws:

java.io.IOException

FtpProtocolException

allo

public boolean allo(long size,
                    long maxRecordSize)
             throws java.io.IOException,
                    FtpProtocolException

Allocate This command may be required by some servers to reserve sufficient storage to accommodate the new file to be transferred. The argument shall be a decimal integer representing the number of bytes (using the logical byte size) of storage to be reserved for the file. For files sent with record or page structure a maximum record or page size (in logical bytes) might also be necessary; this is indicated by a decimal integer in a second argument field of the command. This second argument is optional, but when present should be separated from the first by the three Telnet characters R . This command shall be followed by a STORe or APPEnd command. The ALLO command should be treated as a NOOP (no operation) by those servers which do not require that the maximum size of the file be declared beforehand, and those servers interested in only the maximum record or page size should accept a dummy value in the first argument and ignore it.

Throws:

java.io.IOException

FtpProtocolException

appe

public void appe(java.io.InputStream is,
                 java.lang.String filename)
          throws java.io.IOException,
                 FtpProtocolException

Append (with create) This command causes the server-DTP to accept the data transferred via the data connection and to store the data in a file at the server site. If the file specified in the pathname exists at the server site, then the data shall be appended to that file; otherwise the file specified in the pathname shall be created at the server site.

Throws:

java.io.IOException

FtpProtocolException

cdup

public void cdup()
          throws java.io.IOException,
                 FtpProtocolException

Change to parent directory This command is a special case of CWD, and is included to simplify the implementation of programs for transferring directory trees between operating systems having different syntaxes for naming the parent directory. The reply codes shall be identical to the reply codes of CWD. See Appendix II for further details.

Throws:

java.io.IOException

FtpProtocolException

cwd

public void cwd(java.lang.String dir)
         throws java.io.IOException,
                FtpProtocolException

Changes the working directory This command allows the user to work with a different directory or dataset for file storage or retrieval without altering his login or accounting information. Transfer parameters are similarly unchanged. The argument is h1 pathname specifying a directory or other system dependent file group designator.

Throws:

java.io.IOException

FtpProtocolException

dele

public void dele(java.lang.String filename)
          throws java.io.IOException,
                 FtpProtocolException

Delete This command causes the file specified in the pathname to be deleted at the server site. If an extra level of protection is desired (such as the query, "Do you really wish to delete?"), it should be provided by the user-FTP process.

Throws:

java.io.IOException

FtpProtocolException

help

public void help(java.lang.String command)
          throws java.io.IOException,
                 FtpProtocolException

Help This command shall cause the server to send helpful information regarding its implementation status over the control connection to the user. The command may take an argument (e.g., any command name) and return more specific information as a response. The reply is type 211 or 214. It is suggested that HELP be allowed before entering a USER command. The server may use this reply to specify site-dependent parameters, e.g., in response to HELP SITE.

Throws:

java.io.IOException

FtpProtocolException

list

public java.util.Enumeration list()
                           throws java.io.IOException,
                                  FtpProtocolException

List This command causes a list to be sent from the server to the passive DTP. 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 h1 file then the server should send current information on the file. A null argument implies the user’s current working or default directory. The data transfer is over the data connection in type ASCII or type EBCDIC. (The user must ensure that the TYPE is appropriately ASCII or EBCDIC). Since the information on a file may vary widely from system to system, this information may be hard to use automatically in a program, but may be quite useful to a human user. The file names and details are given as an enumeration of Strings.

Throws:

java.io.IOException

FtpProtocolException

mkd

public void mkd(java.lang.String pathname)
         throws java.io.IOException,
                FtpProtocolException

Make directory This command causes the directory specified in the pathname to be created as a directory (if the pathname is absolute) or as a subdirectory of the current working directory (if the pathname is relative).

Throws:

java.io.IOException

FtpProtocolException

mode

public void mode(char mode)
          throws java.io.IOException,
                 FtpProtocolException

Transfer mode The argument is a single Telnet character code specifying the data transfer modes described in the Section on Transmission Modes. The following codes are assigned for transfer modes: S - Stream B - Block C - Compressed The default transfer mode is Stream.

Throws:

java.io.IOException

FtpProtocolException

nlst

public java.util.Enumeration nlst()
                           throws java.io.IOException,
                                  FtpProtocolException

Name list This command causes a directory listing to be sent from server to user site. The pathname should specify h1 directory or other system-specific file group descriptor; h1 null argument implies the current directory. The server will return a stream of names of files and no other information. The data will be transferred in ASCII or EBCDIC type over the data connection as valid pathname strings separated by or . (Again the user must ensure that the TYPE is correct.) This command is intended to return information that can be used by a program to further process the files automatically. For example, in the implementation of a "multiple get" function. File names returned as an enumeration of Strings.

Throws:

java.io.IOException

FtpProtocolException

noop

public void noop()
          throws java.io.IOException,
                 FtpProtocolException

No operation This command does not affect any parameters or previously entered commands. It specifies no action other than that the server send an OK reply.

Throws:

java.io.IOException

FtpProtocolException

pass

public void pass(java.lang.String pass)
          throws java.io.IOException,
                 FtpProtocolException

Password The argument field is a Telnet string specifying the user’s password. This command must be immediately preceded by the user name command, and, for some sites, completes the user’s identification for access control. Since password information is quite sensitive, it is desirable in general to "mask" it or suppress typeout. It appears that the server has no foolproof way to achieve this. It is therefore the responsibility of the user-FTP process to hide the sensitive password information.

Throws:

java.io.IOException

FtpProtocolException

pasv

public PasvInfo pasv()
              throws java.io.IOException,
                     FtpProtocolException

Passive This command requests the server-DTP to "listen" on a data port (which is not its default data port) and to wait for h1 connection rather than initiate one upon receipt of h1 transfer command. The response to this command includes the host and port address this server is listening on.

Throws:

java.io.IOException

FtpProtocolException

port

public void port(int h1,
                 int h2,
                 int h3,
                 int h4,
                 int port)
          throws java.io.IOException,
                 FtpProtocolException

Data port The argument is a HOST-PORT specification for the data port to be used in data connection. There are defaults for both the user and server data ports, and under normal circumstances this command and its reply are not needed. If this command is used, the argument is the concatenation of h1 32-bit internet host address and a 16-bit TCP port address. This address information is broken into 8-bit fields and the value of each field is transmitted as a decimal number (in character string representation). The fields are separated by commas. A port command would be: PORT h1,h2,h3,h4,p1,p2 where a is the high order 8 bits of the internet host address.

Throws:

java.io.IOException

FtpProtocolException

pwd

public java.lang.String pwd()
                     throws java.io.IOException,
                            FtpProtocolException

Print working directory This command causes the name of the current working directory to be returned in the reply.

Throws:

java.io.IOException

FtpProtocolException

quit

public void quit()
          throws java.io.IOException,
                 FtpProtocolException

Quit This command terminates a USER and if file transfer is not in progress, the server closes the control connection. If file transfer is in progress, the connection will remain open for result response and the server will then close it. If the user-process is transferring files for several USERs but does not wish to close and then reopen connections for each, then the REIN command should be used instead of QUIT. An unexpected close on the control connection will cause the server to take the effective action of an abort (ABOR) and a logout (QUIT).

Throws:

java.io.IOException

FtpProtocolException

rein

public void rein()
          throws java.io.IOException,
                 FtpProtocolException

Reinitialize This command terminates a USER, flushing all I/O and account information, except to allow any transfer in progress to be completed. All parameters are reset to the default settings and the control connection is left open. This is identical to the state in which a user finds himself immediately after the control connection is opened. A USER command may be expected to follow.

Throws:

java.io.IOException

FtpProtocolException

rest

public void rest(java.lang.String marker)
          throws java.io.IOException,
                 FtpProtocolException

Restart file transfer The argument field represents the server marker at which file transfer is to be restarted. This command does not cause file transfer but skips over the file to the specified data checkpoint. This command shall be immediately followed by the appropriate FTP service command which shall cause file transfer to resume.

Throws:

java.io.IOException

FtpProtocolException

retr

public void retr(java.io.OutputStream outputStream,
                 java.lang.String filename)
          throws java.io.IOException,
                 FtpProtocolException

Retrieve This command causes the server-DTP to transfer a copy of the file, specified in the pathname, to the server- or user-DTP at the other end of the data connection. The status and contents of the file at the server site shall be unaffected.

Throws:

java.io.IOException

FtpProtocolException

rmd

public void rmd(java.lang.String pathname)
         throws java.io.IOException,
                FtpProtocolException

Remove directory This command causes the directory specified in the pathname to be removed as a directory (if the pathname is absolute) or as a subdirectory of the current working directory (if the pathname is relative).

Throws:

java.io.IOException

FtpProtocolException

rnfr

public void rnfr(java.lang.String pathname)
          throws java.io.IOException,
                 FtpProtocolException

Rename from This command specifies the old pathname of the file which is to be renamed. This command must be immediately followed by a "rename to" command specifying the new file pathname.

Throws:

java.io.IOException

FtpProtocolException

rnto

public void rnto(java.lang.String pathname)
          throws java.io.IOException,
                 FtpProtocolException

Rename to This command specifies the new pathname of the file specified in the immediately preceding "rename from" command. Together the two commands cause a file to be renamed.

Throws:

java.io.IOException

FtpProtocolException

site

public void site()
          throws java.io.IOException,
                 FtpProtocolException

Site parameters This command is used by the server to provide services specific to his system that are essential to file transfer but not sufficiently universal to be included as commands in the protocol. The nature of these services and the specification of their syntax can be stated in a reply to the HELP SITE command.

Throws:

java.io.IOException

FtpProtocolException

smnt

public void smnt(java.lang.String pathname)
          throws java.io.IOException,
                 FtpProtocolException

Structure mount This command allows the user to mount a different file system data structure without altering his login or accounting information. Transfer parameters are similarly unchanged. The argument is a pathname specifying h1 directory or other system dependent file group designator.

Throws:

java.io.IOException

FtpProtocolException

stat

public void stat(java.lang.String pathname)
          throws java.io.IOException,
                 FtpProtocolException

Status This command shall cause a status response to be sent over the control connection in the form of a reply. The command may be sent during a file transfer (along with the Telnet IP and Synch signals--see the Section on FTP Commands) in which case the server will respond with the status of the operation in progress, or it may be sent between file transfers. In the latter case, the command may have an argument field. If the argument is ha1 pathname, the command is analogous to the "list" command except that data shall be transferred over the control connection. If a partial pathname is given, the server may respond with a list of file names or attributes associated with that specification. If no argument is given, the server should return general status information about the server FTP process. This should include current values of all transfer parameters and the status of connections.

Throws:

java.io.IOException

FtpProtocolException

stor

public void stor(java.io.InputStream is,
                 java.lang.String filename)
          throws java.io.IOException,
                 FtpProtocolException

Store This command causes the server-DTP to accept the data transferred via the data connection and to store the data as a file at the server site. If the file specified in the pathname exists at the server site, then its contents shall be replaced by the data being transferred. A new file is created at the server site if the file specified in the pathname does not already exist.

Throws:

java.io.IOException

FtpProtocolException

stou

public void stou(java.io.InputStream is,
                 java.lang.String filename)
          throws java.io.IOException,
                 FtpProtocolException

Store unique This command behaves like STOR except that the resultant file is to be created in the current directory under a name unique to that directory. The 250 Transfer Started response must include the name generated.

Throws:

java.io.IOException

FtpProtocolException

stru

public void stru(char structure)
          throws java.io.IOException,
                 FtpProtocolException

File structure The argument is a single Telnet character code specifying file structure described in the Section on Data Representation and Storage. The following codes are assigned for structure: F - File (no record structure) R - Record structure P - Page structure The default structure is File.

Throws:

java.io.IOException

FtpProtocolException

syst

public void syst()
          throws java.io.IOException,
                 FtpProtocolException

System This command is used to find out the type of operating system at the server. The reply shall have as its first word one of the system names listed in the current version of the Assigned Numbers document (Reynolds, Joyce, and Jon Postel, "Assigned Numbers", RFC 943, ISI, April 1985).

Throws:

java.io.IOException

FtpProtocolException

type

public void type(char type)
          throws java.io.IOException,
                 FtpProtocolException

Calls type(type, 8) ( see type(char type, int bytesize) )

Throws:

java.io.IOException

FtpProtocolException

type

public void type(char type,
                 int bytesize)
          throws java.io.IOException,
                 FtpProtocolException

Set transfer type. Valid types are: A(SCII) E(BCDIC) I(MAGE) L(OCAL < byte size >) N(on-print) T(elnet format effector) C(arriage Control)

Throws:

java.io.IOException

FtpProtocolException

user

public void user(java.lang.String user)
          throws java.io.IOException,
                 FtpProtocolException

User name The argument field is a Telnet string identifying the user. The user identification is that which is required by the server for access to its file system. This command will normally be the first command transmitted by the user after the control connections are made (some servers may require this). Additional identification information in the form of a password and/or an account command may also be required by some servers. Servers may allow a new USER command to be entered at any point in order to change the access control and/or accounting information. This has the effect of flushing any user, password, and account information already supplied and beginning the login sequence again. All transfer parameters are unchanged and any file transfer in progress is completed under the old access control parameters.

Throws:

java.io.IOException

FtpProtocolException

getLastMessage

public java.lang.String getLastMessage()

Returns the last message from the server. Works for multi-line responses too

expectResponse

public void expectResponse(int expectedCode)
                    throws java.io.IOException,
                           FtpProtocolException

Gets a response. If the response code not equals with the given number, throws an FtpProtocolException

Throws:

java.io.IOException

FtpProtocolException

isPositivePreliminary

public boolean isPositivePreliminary()

Is the last message a positive preliminary reply? The requested action is being initiated; expect another reply before proceeding with a new command. (The user-process sending another command before the completion reply would be in violation of protocol; but server-FTP processes should queue any commands that arrive while a preceding command is in progress.) This type of reply can be used to indicate that the command was accepted and the user-process may now pay attention to the data connections, for implementations where simultaneous monitoring is difficult. The server-FTP process may send at most, one 1yz reply per command.

isPositiveCompletion

public boolean isPositiveCompletion()

Is the last message a positive completion reply? The requested action has been successfully completed. A new request may be initiated.

isPositiveIntermediate

public boolean isPositiveIntermediate()

Is the last message a positive intermediate reply? The command has been accepted, but the requested action is being held in abeyance, pending receipt of further information. The user should send another command specifying this information. This reply is used in command sequence groups.

isNegativeTransient

public boolean isNegativeTransient()

Is the last message a negative transient reply? The command was not accepted and the requested action did not take place, but the error condition is temporary and the action may be requested again. The user should return to the beginning of the command sequence, if any. It is difficult to assign a meaning to "transient", particularly when two distinct sites (Server- and User-processes) have to agree on the interpretation. Each reply in the 4yz category might have a slightly different time value, but the intent is that the user-process is encouraged to try again. A rule of thumb in determining if a reply fits into the 4yz or the 5yz (Permanent Negative) category is that replies are 4yz if the commands can be repeated without any change in command form or in properties of the User or Server (e.g., the command is spelled the same with the same arguments used; the user does not change his file access or user name; the server does not put up a new implementation.)

isNegativePermanent

public boolean isNegativePermanent()

Is the last message a negative permanent reply? The command was not accepted and the requested action did not take place. The User-process is discouraged from repeating the exact request (in the same sequence). Even some "permanent" error conditions can be corrected, so the human user may want to direct his User-process to reinitiate the command sequence by direct action at some point in the future (e.g., after the spelling has been changed, or the user has altered his directory status.)