org.apache.ftpserver.ftplet

Interface FileSystemView

public interface FileSystemView

This is an abstraction over the user file system view.

Author:

Apache MINA Project

Method Summary

Modifier and Type	Method and Description
boolean	changeWorkingDirectory(String dir) Change directory.
void	dispose() Dispose file system view.
FtpFile	getFile(String file) Get file object.
FtpFile	getHomeDirectory() Get the user home directory.
FtpFile	getWorkingDirectory() Get user current directory.
boolean	isRandomAccessible() Does the file system support random file access?

Method Detail

getHomeDirectory

FtpFile getHomeDirectory()
                  throws FtpException

Get the user home directory.

Returns:

The FtpFile for the users home directory

Throws:

FtpException

getWorkingDirectory

FtpFile getWorkingDirectory()
                     throws FtpException

Get user current directory.

Returns:

The FtpFile for the users current directory

Throws:

FtpException

changeWorkingDirectory

boolean changeWorkingDirectory(String dir)
                        throws FtpException

Change directory.

Parameters:

dir - The path of the directory to set as the current directory for the user

Returns:

true if successful

Throws:

FtpException

getFile

FtpFile getFile(String file)
         throws FtpException

Get file object.

Parameters:

file - The path to the file to get

Returns:

The FtpFile for the provided path

Throws:

FtpException

isRandomAccessible

boolean isRandomAccessible()
                    throws FtpException

Does the file system support random file access?

Returns:

true if the file supports random access

Throws:

FtpException

dispose

void dispose()

Dispose file system view.