12ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair/* 22ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * Copyright 2008 the original author or authors. 32ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 42ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * Licensed under the Apache License, Version 2.0 (the "License"); 52ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * you may not use this file except in compliance with the License. 62ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * You may obtain a copy of the License at 72ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 82ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * http://www.apache.org/licenses/LICENSE-2.0 92ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 102ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * Unless required by applicable law or agreed to in writing, software 112ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * distributed under the License is distributed on an "AS IS" BASIS, 122ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 132ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * See the License for the specific language governing permissions and 142ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * limitations under the License. 152ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair */ 162ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairpackage org.mockftpserver.fake; 172ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 182ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport org.mockftpserver.core.command.CommandHandler; 192ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport org.mockftpserver.core.command.CommandNames; 202ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport org.mockftpserver.core.command.ConnectCommandHandler; 212ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport org.mockftpserver.core.command.ReplyTextBundleUtil; 222ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport org.mockftpserver.core.command.UnsupportedCommandHandler; 232ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport org.mockftpserver.core.server.AbstractFtpServer; 242ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport org.mockftpserver.fake.command.*; 252ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport org.mockftpserver.fake.filesystem.FileSystem; 262ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 272ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport java.util.HashMap; 282ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport java.util.List; 292ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairimport java.util.Map; 302ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 312ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair/** 322ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <b>FakeFtpServer</b> is the top-level class for a "fake" implementation of an FTP Server, 332ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * suitable for testing FTP client code or standing in for a live FTP server. 342ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <p/> 352ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <b>FakeFtpServer</b> provides a high-level abstraction for an FTP Server and is suitable 362ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * for most testing and simulation scenarios. You define a filesystem (internal, in-memory) containing 372ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * an arbitrary set of files and directories. These files and directories can (optionally) have 382ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * associated access permissions. You also configure a set of one or more user accounts that 392ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * control which users can login to the FTP server, and their home (default) directories. The 402ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * user account is also used when assigning file and directory ownership for new files. 412ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <p> <b>FakeFtpServer</b> processes FTP client requests and responds with reply codes and 422ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * reply messages consistent with its configuration and the contents of its internal filesystem, 432ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * including file and directory permissions, if they have been configured. 442ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <p/> 452ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <b>FakeFtpServer</b> can be fully configured programmatically or within the 462ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <a href="http://www.springframework.org/">Spring Framework</a> or other dependency-injection container. 472ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <p/> 482ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * In general the steps for setting up and starting the <b>FakeFtpServer</b> are: 492ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <ol> 502ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <li>Create a new <b>FakeFtpServer</b> instance, and optionally set the server control port.</li> 512ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <li>Create and configure a <b>FileSystem</b>, and attach to the <b>FakeFtpServer</b> instance.</li> 522ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <li>Create and configure one or more <b>UserAccount</b> objects and attach to the <b>FakeFtpServer</b> instance.</li> 532ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <li>Start the <b>FakeFtpServer</b> instance.</li> 542ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * </ol> 552ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <h4>Example Code</h4> 562ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <pre><code> 572ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * FakeFtpServer fakeFtpServer = new FakeFtpServer(); 582ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 592ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * FileSystem fileSystem = new WindowsFakeFileSystem(); 602ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileSystem.add(new DirectoryEntry("c:\\")); 612ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileSystem.add(new DirectoryEntry("c:\\data")); 622ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileSystem.add(new FileEntry("c:\\data\\file1.txt", "abcdef 1234567890")); 632ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileSystem.add(new FileEntry("c:\\data\\run.exe")); 642ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fakeFtpServer.setFileSystem(fileSystem); 652ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 662ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * // Create UserAccount with username, password, home-directory 672ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * UserAccount userAccount = new UserAccount("joe", "joe123", "c:\\"); 682ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fakeFtpServer.addUserAccounts(userAccount); 692ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 702ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fakeFtpServer.start(); 712ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * </code></pre> 722ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 732ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <h4>Example Code with Permissions</h4> 742ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * You can optionally set the permissions and owner/group for each file and directory, as in the following example. 752ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <pre><code> 762ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * FileSystem fileSystem = new UnixFakeFileSystem(); 772ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * DirectoryEntry directoryEntry1 = new DirectoryEntry("/"); 782ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * directoryEntry1.setPermissions(new Permissions("rwxrwx---")); 792ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * directoryEntry1.setOwner("joe"); 802ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * directoryEntry1.setGroup("dev"); 812ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 822ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * DirectoryEntry directoryEntry2 = new DirectoryEntry("/data"); 832ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * directoryEntry2.setPermissions(Permissions.ALL); 842ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * directoryEntry2.setOwner("joe"); 852ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * directoryEntry2.setGroup("dev"); 862ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 872ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * FileEntry fileEntry1 = new FileEntry("/data/file1.txt", "abcdef 1234567890"); 882ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileEntry1.setPermissionsFromString("rw-rw-rw-"); 892ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileEntry1.setOwner("joe"); 902ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileEntry1.setGroup("dev"); 912ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 922ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * FileEntry fileEntry2 = new FileEntry("/data/run.exe"); 932ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileEntry2.setPermissionsFromString("rwxrwx---"); 942ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileEntry2.setOwner("mary"); 952ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileEntry2.setGroup("dev"); 962ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 972ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileSystem.add(directoryEntry1); 982ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileSystem.add(directoryEntry2); 992ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileSystem.add(fileEntry1); 1002ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fileSystem.add(fileEntry2); 1012ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 1022ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * FakeFtpServer fakeFtpServer = new FakeFtpServer(); 1032ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fakeFtpServer.setFileSystem(fileSystem); 1042ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 1052ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * // Create UserAccount with username, password, home-directory 1062ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * UserAccount userAccount = new UserAccount("joe", "joe123", "/"); 1072ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fakeFtpServer.addUserAccounts(userAccount); 1082ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 1092ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * fakeFtpServer.start(); 1102ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * </code></pre> 1112ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 1122ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <h4>FTP Server Control Port</h4> 1132ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * By default, <b>MockFtpServer</b> binds to the server control port of 21. You can use a different server 1142ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * control port by setting the the <code>serverControlPort</code> property. This is usually necessary 1152ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * when running on Unix or some other system where that port number is already in use or cannot be bound 1162ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * from a user process. 1172ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 1182ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <h4>Other Configuration</h4> 1192ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * The <code>systemName</code> property specifies the value returned by the <code>SYST</code> 1202ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * command. Note that this is typically used by an FTP client to determine how to parse 1212ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * system-dependent reply text, such as directory listings. This value defaults to <code>"WINDOWS"</code>. 1222ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <p/> 1232ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * The <code>helpText</code> property specifies a <i>Map</i> of help text replies sent by the 1242ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <code>HELP</code> command. The keys in that <i>Map</i> correspond to the command names passed as 1252ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * parameters to the <code>HELP</code> command. An entry with the key of an empty string ("") indicates the 1262ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * text used as the default help text when no command name parameter is specified for the <code>HELP</code> command. 1272ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 1282ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <h4>FTP Command Reply Text ResourceBundle</h4> 1292ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * The default text asociated with each FTP command reply code is contained within the 1302ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * "ReplyText.properties" ResourceBundle file. You can customize these messages by providing a 1312ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * locale-specific ResourceBundle file on the CLASSPATH, according to the normal lookup rules of 1322ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * the ResourceBundle class (e.g., "ReplyText_de.properties"). Alternatively, you can 1332ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * completely replace the ResourceBundle file by calling the calling the 1342ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * {@link #setReplyTextBaseName(String)} method. 1352ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 1362ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @author Chris Mair 1372ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @version $Revision$ - $Date$ 1382ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair */ 1392ab05e83458f35931075adca0d7b0fce4ea7cccbchrismairpublic class FakeFtpServer extends AbstractFtpServer implements ServerConfiguration { 1402ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 1412ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair private FileSystem fileSystem; 1422ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair private String systemName = "WINDOWS"; 1432ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair private String systemStatus = "Connected"; 1442ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair private Map helpText = new HashMap(); 1452ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair private Map userAccounts = new HashMap(); 1462ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 1472ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public FileSystem getFileSystem() { 1482ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair return fileSystem; 1492ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 1502ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 1512ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public void setFileSystem(FileSystem fileSystem) { 1522ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair this.fileSystem = fileSystem; 1532ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 1542ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 1552ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public String getSystemName() { 1562ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair return systemName; 1572ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 1582ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 1592ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public void setSystemName(String systemName) { 1602ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair this.systemName = systemName; 1612ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 1622ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 1632ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public Map getHelpText() { 1642ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair return helpText; 1652ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 1662ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 1672ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public void setHelpText(Map helpText) { 1682ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair this.helpText = helpText; 1692ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 1702ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 1712ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public FakeFtpServer() { 1722ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.ACCT, new AcctCommandHandler()); 1732ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.ABOR, new AborCommandHandler()); 1742ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.ALLO, new AlloCommandHandler()); 1752ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.APPE, new AppeCommandHandler()); 1762ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.CWD, new CwdCommandHandler()); 1772ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.CDUP, new CdupCommandHandler()); 1782ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.DELE, new DeleCommandHandler()); 1792ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.HELP, new HelpCommandHandler()); 1802ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.LIST, new ListCommandHandler()); 1812ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.MKD, new MkdCommandHandler()); 1822ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.MODE, new ModeCommandHandler()); 1832ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.NLST, new NlstCommandHandler()); 1842ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.NOOP, new NoopCommandHandler()); 1852ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.PASS, new PassCommandHandler()); 1862ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.PASV, new PasvCommandHandler()); 1872ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.PWD, new PwdCommandHandler()); 1882ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.PORT, new PortCommandHandler()); 1892ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.QUIT, new QuitCommandHandler()); 1902ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.REIN, new ReinCommandHandler()); 1912ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.REST, new RestCommandHandler()); 1922ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.RETR, new RetrCommandHandler()); 1932ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.RMD, new RmdCommandHandler()); 1942ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.RNFR, new RnfrCommandHandler()); 1952ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.RNTO, new RntoCommandHandler()); 1962ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.SITE, new SiteCommandHandler()); 1972ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.SMNT, new SmntCommandHandler()); 1982ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.STAT, new StatCommandHandler()); 1992ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.STOR, new StorCommandHandler()); 2002ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.STOU, new StouCommandHandler()); 2012ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.STRU, new StruCommandHandler()); 2022ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.SYST, new SystCommandHandler()); 2032ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.TYPE, new TypeCommandHandler()); 2042ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.USER, new UserCommandHandler()); 2052ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.XPWD, new PwdCommandHandler()); 2062ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2072ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair // "Special" Command Handlers 2082ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.CONNECT, new ConnectCommandHandler()); 2092ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair setCommandHandler(CommandNames.UNSUPPORTED, new UnsupportedCommandHandler()); 2102ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2112ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2122ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair /** 2132ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * Initialize a CommandHandler that has been registered to this server. 2142ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 2152ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * If the CommandHandler implements the <code>ServerConfigurationAware</code> interface, then set its 2162ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <code>ServerConfiguration</code> property to <code>this</code>. 2172ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 2182ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * If the CommandHandler implements the <code>ReplyTextBundleAware</code> interface, then set its 2192ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * <code>replyTextBundle</code> property using the reply text bundle for this server. 2202ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 2212ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @param commandHandler - the CommandHandler to initialize 2222ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair */ 2232ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair protected void initializeCommandHandler(CommandHandler commandHandler) { 2242ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair if (commandHandler instanceof ServerConfigurationAware) { 2252ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair ServerConfigurationAware sca = (ServerConfigurationAware) commandHandler; 2262ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair sca.setServerConfiguration(this); 2272ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2282ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2292ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair ReplyTextBundleUtil.setReplyTextBundleIfAppropriate(commandHandler, getReplyTextBundle()); 2302ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2312ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2322ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair /** 2332ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @return the {@link UserAccount} configured for this server for the specified user name 2342ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair */ 2352ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public UserAccount getUserAccount(String username) { 2362ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair return (UserAccount) userAccounts.get(username); 2372ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2382ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2392ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair /** 2402ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * Return the help text for a command or the default help text if no command name is specified 2412ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 2422ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @param name - the command name; may be empty or null to indicate a request for the default help text 2432ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @return the help text for the named command or the default help text if no name is supplied 2442ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair */ 2452ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public String getHelpText(String name) { 2462ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair String key = name == null ? "" : name; 2472ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair return (String) helpText.get(key); 2482ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2492ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2502ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair /** 2512ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * Add a single UserAccount. If an account with the same <code>username</code> already exists, 2522ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * it will be replaced. 2532ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 2542ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @param userAccount - the UserAccount to add 2552ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair */ 2562ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public void addUserAccount(UserAccount userAccount) { 2572ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair userAccounts.put(userAccount.getUsername(), userAccount); 2582ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2592ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2602ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair /** 2612ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * Add the UserAccount objects in the <code>userAccountList</code> to the set of UserAccounts. 2622ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 2632ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @param userAccountList - the List of UserAccount objects to add 2642ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair */ 2652ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public void setUserAccounts(List userAccountList) { 2662ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair for (int i = 0; i < userAccountList.size(); i++) { 2672ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair UserAccount userAccount = (UserAccount) userAccountList.get(i); 2682ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair userAccounts.put(userAccount.getUsername(), userAccount); 2692ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2702ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2712ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2722ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair /** 2732ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * Return the system status description 2742ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 2752ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @return the system status 2762ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair */ 2772ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public String getSystemStatus() { 2782ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair return systemStatus; 2792ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2802ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2812ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair /** 2822ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * Set the system status description text, used by the STAT command handler. 2832ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * 2842ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair * @param systemStatus - the system status description text 2852ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair */ 2862ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair public void setSystemStatus(String systemStatus) { 2872ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair this.systemStatus = systemStatus; 2882ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair } 2892ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair 2902ab05e83458f35931075adca0d7b0fce4ea7cccbchrismair}