1f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair/* 2f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * Copyright 2007 the original author or authors. 3f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * 4f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * Licensed under the Apache License, Version 2.0 (the "License"); 5f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * you may not use this file except in compliance with the License. 6f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * You may obtain a copy of the License at 7f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * 8f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * http://www.apache.org/licenses/LICENSE-2.0 9f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * 10f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * Unless required by applicable law or agreed to in writing, software 11f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * distributed under the License is distributed on an "AS IS" BASIS, 12f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * See the License for the specific language governing permissions and 14f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * limitations under the License. 15f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair */ 16f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismairpackage org.mockftpserver.stub.command; 17f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 18f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismairimport java.util.ArrayList; 19f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismairimport java.util.List; 20f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 21f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismairimport org.mockftpserver.core.command.Command; 22f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismairimport org.mockftpserver.core.command.CommandHandler; 23f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismairimport org.mockftpserver.core.command.InvocationRecord; 24f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismairimport org.mockftpserver.core.command.ReplyCodes; 25f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismairimport org.mockftpserver.core.session.Session; 26f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 27f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair/** 28f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * CommandHandler for the USER command. The <code>passwordRequired</code> property defaults to true, 29f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * indicating that a password is required following the user name. If true, this command handler 30f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * returns a reply of 331. If false, return a reply of 230. 31f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * <p> 32f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * Each invocation record stored by this CommandHandler includes the following data element key/values: 33f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * <ul> 34f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * <li>{@link #USERNAME_KEY} ("username") - the user name submitted on the invocation (the first command parameter) 35f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * </ul> 36f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * 37f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * @version $Revision$ - $Date$ 38f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * 39f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * @author Chris Mair 40f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair */ 41f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismairpublic final class UserCommandHandler extends AbstractStubCommandHandler implements CommandHandler { 42f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 43f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair public static final String USERNAME_KEY = "username"; 44f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 45f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair private boolean passwordRequired = true; 46f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair private List usernames = new ArrayList(); 47f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 48f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair /** 49f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * Constructor. 50f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair */ 51f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair public UserCommandHandler() { 52f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair // Do not initialize replyCode -- will be set dynamically 53f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair } 54f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 55f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair /** 56f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * @see org.mockftpserver.core.command.CommandHandler#handleCommand(Command, Session, InvocationRecord) 57f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair */ 58f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair public void handleCommand(Command command, Session session, InvocationRecord invocationRecord) { 59f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair usernames.add(command.getRequiredString(0)); 60f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair invocationRecord.set(USERNAME_KEY, command.getRequiredString(0)); 61f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 62f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair // Only use dynamic reply code if the replyCode property was NOT explicitly set 63f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair if (replyCode == 0) { 64f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair int code = (passwordRequired) ? ReplyCodes.USER_NEED_PASSWORD_OK : ReplyCodes.USER_LOGGED_IN_OK; 65f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair sendReply(session, code, replyMessageKey, replyText, null); 66f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair } 67f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair else { 68f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair sendReply(session); 69f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair } 70f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair } 71f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 72f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair /** 73f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * Return true if a password is required at login. See {@link #setPasswordRequired(boolean)}. 74f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * @return the passwordRequired flag 75f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair */ 76f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair public boolean isPasswordRequired() { 77f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair return passwordRequired; 78f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair } 79f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 80f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair /** 81f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * Set true to indicate that a password is required. If true, this command handler returns a reply 82f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * of 331. If false, return a reply of 230. 83f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair * @param passwordRequired - is a password required for login 84f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair */ 85f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair public void setPasswordRequired(boolean passwordRequired) { 86f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair this.passwordRequired = passwordRequired; 87f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair } 88f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair 89f688bc4bc07500f1548006ebbc4a0bd95f46b106chrismair} 90