fakeftpserver-features.apt revision 3e469b93fd10bc09ea2c088516168bf6a5cbaa43 
1		--------------------------------------------------
2				FakeFtpServer Features and Limitations
3		--------------------------------------------------
4
5FakeFtpServer Features
6~~~~~~~~~~~~~~~~~~~~~~
7
8  * Standalone dummy FTP server. Run either within the same JVM as test code or in a different JVM.
9
10  * Implements common FTP server commands.
11
12  * Works out of the box with reasonable and expected behavior. Can simulate most mainline success and error scenarios.
13
14  * In most cases, requires little or no knowledge or understanding of FTP server commands and reply codes. 
15
16  * Provides a simulated server file system, including support for file and directory permissions and owner and
17   group authorization based on Unix. This file system can be populated at startup (or thereafter) with
18   directories and files (including arbitrary content) to be retrieved by an FTP client. Any files sent to the server
19   by an FTP client exist within that file system as well, and can be accessed through the file system API, or
20   can even be subsequently retrieved by an FTP client.
21
22  * Allows defining the set of user accounts that control which users can login to the FTP server, and their home
23    (default) directories.
24
25  * Supports active and passive mode data transfers.
26
27  * Supports extended address (IPv6) data transfers (RFC2428)
28
29  * Fully supports configuration within the <<Spring Framework>> or other dependency-injection container.
30  
31  * Can be used to test FTP client code written in any language
32  
33FTP Scenarios Supported by FakeFtpServer
34~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35
36  Some of the mainline success scenarios that you can simulate with <<FakeFtpServer>> include:
37
38    * Login (USER/PASS): with password, or when no password is required
39
40    * Retrieve existing file (RETR) from the server
41
42    * Send file to the server (STOR,STOU,APPE)
43
44    * List of file entries (LIST) and list of filenames (NLST)
45
46    * Print current working directory (PWD)
47
48    * Change current working directory (CWD)
49
50    * Rename an existing file (RNFR/RNTO)
51
52    * Delete an existing file (DELE)
53
54    * Create directory (MKD)
55
56    * Remove directory (RMD)
57
58    * Both active and passive mode (PASV) data transfers
59
60    * Extended Address (IPv6) data transfers (EPRT and EPSV commands)
61
62  Some of the error scenarios that you can simulate with <<FakeFtpServer>> include:
63
64    * Failed login (USER/PASS): no such user, wrong password
65
66    * Invalid client requests: missing required parameter, not logged in
67
68    * Failed retrieve (RETR): no such file, missing required access permissions for the current user
69
70    * Failed send (STOR,STOU,APPE): missing required access permissions for the current user
71
72    * Failed change current working directory (CWD): no such directory, missing required access permissions for the current user
73
74    * Failed delete an existing file (DELE): file does not exist, missing required access permissions for the current user
75
76    * Failed rename (RNFR/RNTO): no such file, missing required access permissions for the current user
77
78    * Failed create directory (MKD): parent directory does not exist, directory already exists, missing required access permissions for the current user
79
80    * Failed remove directory (RMD): no such directory, directory not empty, missing required access permissions for the current user
81
82
83FakeFtpServer Limitations
84~~~~~~~~~~~~~~~~~~~~~~~~~
85
86  Not all FTP features, error scenarios and reply codes can be simulated using <<FakeFtpServer>>. Features and
87  scenarios not supported include:
88
89  * Leaving the data connection open across multiple client requests.
90
91  * Transmission mode other than 'Stream'. The STRU command is implemented but has no effect (NOOP).
92
93  * Data Types other than ASCII and IMAGE (binary).
94
95  * Vertical Format Control other than the default (NON PRINT).
96
97  * Record Structure and Page Structure. The STRU command is implemented but has no effect (NOOP).
98
99  * Error Recovery and Restart. The REST command is implemented but has no effect (NOOP).
100
101  * Structure Mount. The SMNT command is implemented but has no effect (NOOP).
102
103  * Abort. The ABOR command is implemented but has no effect (NOOP).
104
105  * Allocate. The ALLO command is implemented but has no effect (NOOP).
106
107  []
108
109  For unsupported features, error scenarios and reply codes, consider using <<StubFtpServer>> instead, which
110  provides a lower-level abstraction and finer control over exact server reply codes and responses.
111