1ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair/* 2ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * Copyright 2007 the original author or authors. 3ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * 4ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * Licensed under the Apache License, Version 2.0 (the "License"); 5ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * you may not use this file except in compliance with the License. 6ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * You may obtain a copy of the License at 7ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * 8ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * http://www.apache.org/licenses/LICENSE-2.0 9ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * 10ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * Unless required by applicable law or agreed to in writing, software 11ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * distributed under the License is distributed on an "AS IS" BASIS, 12ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * See the License for the specific language governing permissions and 14ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * limitations under the License. 15ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair */ 16ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismairpackage org.mockftpserver.stub.command; 17ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair 18ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismairimport org.apache.log4j.Logger; 19ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismairimport org.mockftpserver.core.command.Command; 20ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismairimport org.mockftpserver.core.command.CommandHandler; 21ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismairimport org.mockftpserver.core.command.InvocationRecord; 22ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismairimport org.mockftpserver.core.command.ReplyCodes; 23ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismairimport org.mockftpserver.core.session.Session; 24ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair 25ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair/** 26ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * CommandHandler for the STOU (Store Unique) command. Send back two replies on the control connection: a 27ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * reply code of 150 and another of 226. The text accompanying the final reply (226) is the 28ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * unique filename, which is "" by default. You can customize the returned filename by setting 29ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * the <code>filename</code> property. 30ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * <p/> 31ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * Each invocation record stored by this CommandHandler includes the following data element key/values: 32ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * <ul> 33ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * <li>{@link #FILE_CONTENTS_KEY} ("fileContents") - the file contents (<code>byte[]</code>) sent on the data connection 34ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * </ul> 35ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * 36ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * @author Chris Mair 37ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * @version $Revision$ - $Date$ 38ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair */ 39ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismairpublic final class StouCommandHandler extends AbstractStubDataCommandHandler implements CommandHandler { 40ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair 41ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair public static final String FILE_CONTENTS_KEY = "filecontents"; 42ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair private static final String FINAL_REPLY_TEXT_KEY = "226.WithFilename"; 43ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair 44ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair private static final Logger LOG = Logger.getLogger(StouCommandHandler.class); 45ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair 46ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair private String filename = ""; 47ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair 48ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair /** 49ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * @see org.mockftpserver.stub.command.AbstractStubDataCommandHandler#processData(org.mockftpserver.core.command.Command, org.mockftpserver.core.session.Session, org.mockftpserver.core.command.InvocationRecord) 50ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair */ 51ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair protected void processData(Command command, Session session, InvocationRecord invocationRecord) { 52ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair byte[] data = session.readData(); 53ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair LOG.info("Received " + data.length + " bytes"); 54ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair LOG.trace("Received data [" + new String(data) + "]"); 55ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair invocationRecord.set(FILE_CONTENTS_KEY, data); 56ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair } 57ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair 58ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair /** 59ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * Override the default implementation to send a custom reply text that includes the STOU response filename 60ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * 61ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * @see org.mockftpserver.stub.command.AbstractStubDataCommandHandler#sendFinalReply(org.mockftpserver.core.session.Session) 62ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair */ 63ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair protected void sendFinalReply(Session session) { 64ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair final String[] ARGS = {filename}; 65ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair sendReply(session, ReplyCodes.TRANSFER_DATA_FINAL_OK, FINAL_REPLY_TEXT_KEY, null, ARGS); 66ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair } 67ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair 68ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair /** 69ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * Set the filename returned with the final reply of the STOU command 70ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * 71ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair * @param filename - the filename 72ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair */ 73ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair public void setFilename(String filename) { 74ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair this.filename = filename; 75ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair } 76ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair 77ad39334d4c363c6ada5863d0bb3184f5f4699d69chrismair} 78