org.apache.ftpserver.ftplet.FileSystemView 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;

/**
 * This is an abstraction over the user file system view.
 *
 * @author Apache MINA Project
 */
public interface FileSystemView {

    /**
     * Get the user home directory.
     * @return The {@link FtpFile} for the users home directory
     * @throws FtpException 
     */
    FtpFile getHomeDirectory() throws FtpException;

    /**
     * Get user current directory.
     * @return The {@link FtpFile} for the users current directory
     * @throws FtpException 
     */
    FtpFile getWorkingDirectory() throws FtpException;

    /**
     * Change directory.
     * @param dir The path of the directory to set as the current directory for the user
     * @return true if successful
     * @throws FtpException 
     */
    boolean changeWorkingDirectory(String dir) throws FtpException;

    /**
     * Get file object.
     * @param file The path to the file to get
     * @return The {@link FtpFile} for the provided path
     * @throws FtpException 
     */
    FtpFile getFile(String file) throws FtpException;

    /**
     * Does the file system support random file access?
     * @return true if the file supports random access
     * @throws FtpException 
     */
    boolean isRandomAccessible() throws FtpException;

    /**
     * Dispose file system view.
     */
    void dispose();
}