org.apache.ftpserver.ftplet.UserManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ftplet-api Show documentation

Ftplets are, similar to servlets, an API to plug into the request lifecycle of FtpServer. Ftplets are called on session connect and disconnect as well as before and after each command within a user session.

There is a newer version: 1.2.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.ftpserver.ftplet;

/**
 * User manager interface.
 *
 * @author Apache MINA Project
 */
public interface UserManager {

    /**
     * Get user by name.
     *
     * @param username the name to search for.
     * @throws FtpException when the UserManager can't fulfill the request.
     * @return the user with the specified name, or null if a such user does
     *         not exist.
     */
    User getUserByName(String username) throws FtpException;

    /**
     * Get all user names in the system.
     *
     * @throws FtpException when the UserManager can't fulfill the request.
     * @return an array of username strings, note that the result should never
     *         be null, if there is no users the result is an empty array.
     */
    String[] getAllUserNames() throws FtpException;

    /**
     * Delete the user from the system.
     * @param username The name of the {@link User} to delete
     *
     * @throws FtpException when the UserManager can't fulfill the request.
     * @throws UnsupportedOperationException
     *             if UserManager in read-only mode
     */
    void delete(String username) throws FtpException;

    /**
     * Save user. If a new user, create it else update the existing user.
     *
     * @param user the Uset to save
     * @throws FtpException when the UserManager can't fulfill the request.
     * @throws UnsupportedOperationException
     *             if UserManager in read-only mode
     */
    void save(User user) throws FtpException;

    /**
     * Check if the user exists.
     * @param username the name of the user to check.
     * @return true if the user exist, false otherwise.
     * @throws FtpException 
     */
    boolean doesExist(String username) throws FtpException;

    /**
     * Authenticate user
     * @param authentication The {@link Authentication} that proves the users identity
     * @return the authenticated account.
     * @throws AuthenticationFailedException 
     * @throws FtpException when the UserManager can't fulfill the request.
     */
    User authenticate(Authentication authentication)
            throws AuthenticationFailedException;

    /**
     * Get admin user name
     * @return the admin user name
     * @throws FtpException when the UserManager can't fulfill the request.
     */
    String getAdminName() throws FtpException;

    /**
     * Check if the user is admin.
     * @param username The name of the {@link User} to check
     * @return true if user with this login is administrator
     * @throws FtpException when the UserManager can't fulfill the request.
     */
    boolean isAdmin(String username) throws FtpException;
}