160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair/* 260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Copyright 2007 the original author or authors. 360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Licensed under the Apache License, Version 2.0 (the "License"); 560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * you may not use this file except in compliance with the License. 660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * You may obtain a copy of the License at 760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * http://www.apache.org/licenses/LICENSE-2.0 960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 1060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Unless required by applicable law or agreed to in writing, software 1160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * distributed under the License is distributed on an "AS IS" BASIS, 1260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * See the License for the specific language governing permissions and 1460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * limitations under the License. 1560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 1660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairpackage org.mockftpserver.stub.command; 1760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 1860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairimport org.mockftpserver.core.command.Command; 1960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairimport org.mockftpserver.core.command.CommandHandler; 2060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairimport org.mockftpserver.core.command.InvocationRecord; 2160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairimport org.mockftpserver.core.command.ReplyCodes; 2260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairimport org.mockftpserver.core.session.Session; 2360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 2460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair/** 2560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * CommandHandler for the STAT (Status) command. By default, return empty status information, 2660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * along with a reply code of 211 if no pathname parameter is specified or 213 if a 2760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * pathname is specified. You can customize the returned status information by setting 2860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * the <code>status</code> property. 2960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * <p> 3060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Each invocation record stored by this CommandHandler includes the following data element key/values: 3160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * <ul> 3260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * <li>{@link #PATHNAME_KEY} ("pathname") - the pathname of the directory (or file) submitted on the 3360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * invocation (the first command parameter); this parameter is optional, so the value may be null. 3460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * </ul> 3560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 3660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @author Chris Mair 3760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @version $Revision$ - $Date$ 3860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @see SystCommandHandler 3960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 4060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairpublic class StatCommandHandler extends AbstractStubCommandHandler implements CommandHandler { 4160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 4260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair public static final String PATHNAME_KEY = "pathname"; 4360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 4460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair private String status = ""; 4560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 4660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair /** 4760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Constructor. 4860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 4960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair public StatCommandHandler() { 5060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair // Do not initialize replyCode -- will be set dynamically 5160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair } 5260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 5360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair public void handleCommand(Command command, Session session, InvocationRecord invocationRecord) { 5460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair String pathname = command.getOptionalString(0); 5560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair invocationRecord.set(PATHNAME_KEY, pathname); 5660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 5760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair // Only use dynamic reply code if the replyCode property was NOT explicitly set 5860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair if (replyCode == 0) { 5960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair int code = (pathname == null) ? ReplyCodes.STAT_SYSTEM_OK : ReplyCodes.STAT_FILE_OK; 6060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair sendReply(session, code, replyMessageKey, replyText, new String[]{status}); 6160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair } else { 6260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair sendReply(session, status); 6360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair } 6460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair } 6560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 6660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair /** 6760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Set the contents of the status to send back as the reply text for this command 6860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 6960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @param status - the status 7060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 7160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair public void setStatus(String status) { 7260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair this.status = status; 7360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair } 7460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 7560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair} 76