HelpCommandHandler.java revision 3b7668ee59bf567db6bce593a9090f65db171fdb
1/* 2 * Copyright 2007 the original author or authors. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16package org.mockftpserver.stub.command; 17 18import org.mockftpserver.core.command.Command; 19import org.mockftpserver.core.command.CommandHandler; 20import org.mockftpserver.core.command.InvocationRecord; 21import org.mockftpserver.core.command.ReplyCodes; 22import org.mockftpserver.core.session.Session; 23 24/** 25 * CommandHandler for the HELP command. By default, return an empty help message, 26 * along with a reply code of 214. You can customize the returned help message by 27 * setting the <code>helpMessage</code> property. 28 * <p> 29 * Each invocation record stored by this CommandHandler includes the following data element key/values: 30 * <ul> 31 * <li>{@link #COMMAND_NAME_KEY} ("commandName") - the command name optionally submitted on 32 * the invocation (the first command parameter). May be null. 33 * </ul> 34 * 35 * @author Chris Mair 36 * @version $Revision$ - $Date$ 37 */ 38public final class HelpCommandHandler extends AbstractStubCommandHandler implements CommandHandler { 39 40 public static final String COMMAND_NAME_KEY = "commandName"; 41 42 private String helpMessage = ""; 43 44 /** 45 * Constructor. Initialize the replyCode. 46 */ 47 public HelpCommandHandler() { 48 setReplyCode(ReplyCodes.HELP_OK); 49 } 50 51 /** 52 * @see org.mockftpserver.core.command.AbstractTrackingCommandHandler#handleCommand(org.mockftpserver.core.command.Command, org.mockftpserver.core.session.Session, org.mockftpserver.core.command.InvocationRecord) 53 */ 54 public void handleCommand(Command command, Session session, InvocationRecord invocationRecord) { 55 invocationRecord.set(COMMAND_NAME_KEY, command.getOptionalString(0)); 56 sendReply(session, helpMessage); 57 } 58 59 /** 60 * Set the help message String to be returned by this command 61 * 62 * @param helpMessage - the help message 63 */ 64 public void setHelpMessage(String helpMessage) { 65 this.helpMessage = helpMessage; 66 } 67 68} 69