sshd-core/src/main/java/org/apache/sshd/common/file/FileSystemView.java

/*
 * 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.sshd.common.file;

/**
 * This is an abstraction over the user file system view.
 *
 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
 */
public interface FileSystemView {

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

    /**
     * Get file object.
     * @param baseDir The reference towards which the file should be resolved
     * @param file The path to the file to get
     * @return The {@link SshFile} for the provided path
     */
    SshFile getFile(SshFile baseDir, String file);

    /**
     * Return a view of this file system which has a single root
     * and uses '/' as a file separator.
     * If the file system has multiple roots, they are mapped
     * to directories inside that single root.
     * @return a normalized file system view
     */
    FileSystemView getNormalizedView();

}