xref: /aosp_15_r20/external/mockftpserver/branches/1.x_Branch/README.txt (revision 876b9d758e92bb9ac60d09763a5f23a1c6322c5f)
1*876b9d75SXin LiMockFtpServer version ${project.version}
2*876b9d75SXin Li-------------------------------------------------------------------------------
3*876b9d75SXin Li${project.url}
4*876b9d75SXin Li
5*876b9d75SXin LiThe MockFtpServer project provides a mock/dummy FTP server implementation that can be very
6*876b9d75SXin Liuseful for testing of FTP client code. It can be configured to return custom data or reply
7*876b9d75SXin Licodes, to simulate either success or failure scenarios. Expected command invocations can
8*876b9d75SXin Lialso be verified.
9*876b9d75SXin Li
10*876b9d75SXin LiMockFtpServer is written in Java, and is ideally suited to testing Java code. But because
11*876b9d75SXin Licommunication with the FTP server is across sockets and TCP/IP, it can be used to test FTP client
12*876b9d75SXin Licode written in any language.
13*876b9d75SXin Li
14*876b9d75SXin LiThe MockFtpServer project may one day provide multiple mock/dummy FTP server implementations,
15*876b9d75SXin Liat different levels of abstraction. Currently, however, StubFtpServer is the only one provided,
16*876b9d75SXin Lithough others are being considered. StubFtpServer is a "stub" implementation of an FTP server.
17*876b9d75SXin LiSee the "StubFtpServer Getting Started Guide" for more information.
18*876b9d75SXin Li
19*876b9d75SXin LiSee the FTP Protocol Spec (http://www.ietf.org/rfc/rfc0959.txt) for information about
20*876b9d75SXin LiFTP, commands, reply codes, etc..
21*876b9d75SXin Li
22*876b9d75SXin LiDEPENDENCIES
23*876b9d75SXin Li
24*876b9d75SXin LiMockFtpServer requires
25*876b9d75SXin Li - Java (JDK) version 1.3 or later
26*876b9d75SXin Li - The Log4J jar, version 1.2.13 or later, accessible on the CLASSPATH
27*876b9d75SXin Li   (http://logging.apache.org/log4j/index.html).
28