stubftpserver-commandhandlers.apt revision 3e469b93fd10bc09ea2c088516168bf6a5cbaa43 
1		------------------------------------------------------
2			StubFtpServer FTP Commands and CommandHandlers
3		------------------------------------------------------
4
5StubFtpServer - FTP Commands and CommandHandlers
6
7  The following table lists the main FTP server commands with their corresponding FTP client commands,
8  and the <<StubFtpServer>> <CommandHandler> classes that implements support for the FTP server command.
9  See the Javadoc for each <CommandHandler> class for information on how to customize its behavior
10  through configuration, as well as what command invocation data is available.
11
12*------------------------*------------------------*------------------------------------------*
13| <<FTP Server Command>> | <<FTP Client Command>> | <<CommandHandler Class(es)>>             |
14*------------------------*------------------------*------------------------------------------*
15| ABOR                   | --                     | AborCommandHandler                       |
16*------------------------*------------------------*------------------------------------------*
17| ACCT                   | --                     | AcctCommandHandler                       |
18*------------------------*------------------------*------------------------------------------*
19| ALLO                   | --                     | AlloCommandHandler                       |
20*------------------------*------------------------*------------------------------------------*
21| APPE                   | APPEND                 | AppeCommandHandler                       |
22*------------------------*------------------------*------------------------------------------*
23| CDUP                   | --                     | CdupCommandHandler                       |
24*------------------------*------------------------*------------------------------------------*
25| CWD                    | CD                     | CwdCommandHandler                        |
26*------------------------*------------------------*------------------------------------------*
27| DELE                   | DELETE                 | DeleCommandHandler                       |
28*------------------------*------------------------*------------------------------------------*
29| EPRT                   | --                     | EprtCommandHandler                       |
30*------------------------*------------------------*------------------------------------------*
31| EPSV                   | --                     | EpsvCommandHandler                       |
32*------------------------*------------------------*------------------------------------------*
33| HELP                   | REMOTEHELP             | HelpCommandHandler                       |
34*------------------------*------------------------*------------------------------------------*
35| LIST                   | DIR / LS               | ListCommandHandler                       |
36*------------------------*------------------------*------------------------------------------*
37| MKD                    | MKDIR                  | MkdCommandHandler                        |
38*------------------------*------------------------*------------------------------------------*
39| MODE                   | --                     | ModeCommandHandler                       |
40*------------------------*------------------------*------------------------------------------*
41| NLST                   | --                     | NlstCommandHandler                       |
42*------------------------*------------------------*------------------------------------------*
43| NOOP                   | --                     | NoopCommandHandler                       |
44*------------------------*------------------------*------------------------------------------*
45| PASS                   | USER                   | PassCommandHandler                       |
46*------------------------*------------------------*------------------------------------------*
47| PASV                   | --                     | PasvCommandHandler                       |
48*------------------------*------------------------*------------------------------------------*
49| PORT                   | --                     | PortCommandHandler                       |
50*------------------------*------------------------*------------------------------------------*
51| PWD                    | PWD                    | PwdCommandHandler                        |
52*------------------------*------------------------*------------------------------------------*
53| QUIT                   | QUIT / BYE             | QuitCommandHandler                       |
54*------------------------*------------------------*------------------------------------------*
55| REIN                   | --                     | ReinCommandHandler                       |
56*------------------------*------------------------*------------------------------------------*
57| REST                   | --                     | RestCommandHandler                       |
58*------------------------*------------------------*------------------------------------------*
59| RETR                   | GET / RECV             | RetrCommandHandler                       |
60|                        |                        | FileRetrCommandHandler (1)               |
61*------------------------*------------------------*------------------------------------------*
62| RMD                    | RMDIR                  | RmdCommandHandler                        |
63*------------------------*------------------------*------------------------------------------*
64| RNFR                   | RENAME                 | RnfrCommandHandler                       |
65*------------------------*------------------------*------------------------------------------*
66| RNTO                   | RENAME                 | RntoCommandHandler                       |
67*------------------------*------------------------*------------------------------------------*
68| SITE                   | --                     | SiteCommandHandler                       |
69*------------------------*------------------------*------------------------------------------*
70| SMNT                   | --                     | SmntCommandHandler                       |
71*------------------------*------------------------*------------------------------------------*
72| STAT                   | STATUS                 | StatCommandHandler                       |
73*------------------------*------------------------*------------------------------------------*
74| STOR                   | PUT / SEND             | StorCommandHandler                       |
75*------------------------*------------------------*------------------------------------------*
76| STOU                   | --                     | StouCommandHandler                       |
77*------------------------*------------------------*------------------------------------------*
78| STRU                   | --                     | StruCommandHandler                       |
79*------------------------*------------------------*------------------------------------------*
80| SYST                   | --                     | SystCommandHandler                       |
81*------------------------*------------------------*------------------------------------------*
82| TYPE                   | ASCII / BINARY / TYPE  | TypeCommandHandler                       |
83*------------------------*------------------------*------------------------------------------*
84| USER                   | USER                   | UserCommandHandler                       |
85*------------------------*------------------------*------------------------------------------*
86
87  (1) An alternative to the default <CommandHandler> implementation. See its class Javadoc.
88
89
90* Special Command Handlers
91~~~~~~~~~~~~~~~~~~~~~~~~~~
92
93  There are also <special> <CommandHandler> classes defined (in the <<core>> package).
94
95  * <<ConnectCommandHandler>> - Sends a 220 reply code after the initial connection to the server.
96     
97  * <<UnsupportedCommandHandler>> - Sends a 502 reply when an unrecognized/unsupported
98    command name is sent from a client.