org.mockftpserver.stub.command.StouCommandHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of MockFtpServer Show documentation

The MockFtpServer project provides mock/dummy FTP server implementations for testing FTP client code. Two FTP Server implementations are provided, each at a different level of abstraction. FakeFtpServer provides a higher-level abstraction. You define a virtual file system, including directories and files, as well as a set of valid user accounts and credentials. The FakeFtpServer then responds with appropriate replies and reply codes based on that configuration. StubFtpServer, on the other hand, is a lower-level "stub" implementation. You configure the individual FTP server commands to return custom data or reply codes, allowing simulation of either success or failure scenarios. You can also verify expected command invocations.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2007 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.mockftpserver.stub.command;

import org.mockftpserver.core.command.ReplyCodes;
import org.mockftpserver.core.session.Session;

/**
 * CommandHandler for the STOU (Store Unique) command. Send back two replies on the control connection: a
 * reply code of 150 and another of 226. The text accompanying the final reply (226) is the
 * unique filename, which is "" by default. You can customize the returned filename by setting
 * the filename property.
 * 
 * Each invocation record stored by this CommandHandler includes the following data element key/values:
 * 

 * {@link #FILE_CONTENTS_KEY} ("fileContents") - the file contents (byte[]) sent on the data connection
 * 
 *
 * @author Chris Mair
 */
public class StouCommandHandler extends AbstractStorCommandHandler {

    private static final String FINAL_REPLY_TEXT_KEY = "226.WithFilename";

    private String filename = "";

    /**
     * Override the default implementation to send a custom reply text that includes the STOU response filename
     *
     * @see org.mockftpserver.stub.command.AbstractStubDataCommandHandler#sendFinalReply(org.mockftpserver.core.session.Session)
     */
    protected void sendFinalReply(Session session) {
        final String[] ARGS = {filename};
        sendReply(session, ReplyCodes.TRANSFER_DATA_FINAL_OK, FINAL_REPLY_TEXT_KEY, null, ARGS);
    }

    /**
     * Set the filename returned with the final reply of the STOU command
     *
     * @param filename - the filename
     */
    public void setFilename(String filename) {
        this.filename = filename;
    }

}