org.mockftpserver.fake.command.UserCommandHandler 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 2008 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.fake.command;

import org.mockftpserver.core.command.Command;
import org.mockftpserver.core.command.ReplyCodes;
import org.mockftpserver.core.session.Session;
import org.mockftpserver.core.session.SessionKeys;
import org.mockftpserver.fake.UserAccount;

/**
 * CommandHandler for the USER command. Handler logic:
 * 
 * If the required pathname parameter is missing, then reply with 501
 * If the user account configured for the named user is not valid, then reply with 530
 * If the named user does not need a password for login, then set the UserAccount and
 * current directory in the session, and reply with 230
 * Otherwise, set the username in the session and reply with 331
 * 
 *
 * @author Chris Mair
 */
public class UserCommandHandler extends AbstractFakeCommandHandler {

    protected void handle(Command command, Session session) {
        String username = command.getRequiredParameter(0);
        UserAccount userAccount = getServerConfiguration().getUserAccount(username);

        if (userAccount != null) {
            if (!validateUserAccount(username, session)) {
                return;
            }

            // If the UserAccount is configured to not require password for login
            if (!userAccount.isPasswordRequiredForLogin()) {
                login(userAccount, session, ReplyCodes.USER_LOGGED_IN_OK, "user.loggedIn");
                return;
            }
        }
        session.setAttribute(SessionKeys.USERNAME, username);
        sendReply(session, ReplyCodes.USER_NEED_PASSWORD_OK, "user.needPassword");
    }

}