VirtualFileSystem (Maverick Legacy - Server Assembly 1.6.31 API)

java.lang.Object
- com.maverick.sshd.vfs.VirtualFileSystem

All Implemented Interfaces:

FileSystem

Deprecated.
Switch to using VirtualFileFactory instead.
```
public class VirtualFileSystem
extends Object
implements FileSystem
```
Provides a platform independent file system that uses standard java file operations. The virtual file system operates on a set of 'mounts' that map a virtual directory to a physical location on the server.

To configure the file system use the following code in your com.maverick.sshd.SshDaemon#configure(ConfigurationContext) implementation:
```
 context.setFileSystemProvider(VirtualFileSystem.class);
 
```
Mounts can be created by setting system properties and only one property is required "com.maverick.sshd.vfs.VFSRoot". This instructs the server where to look for the root of the file system "/". For example if you wanted to provide access to the root of a windows machine you could set the following property
```
 System.setProperty("com.maverick.sshd.vfs.VFSRoot", "C:\\");
 
```
Additional mounts can be set using "com.maverick.sshd.vfs.VFSMount.1" "com.maverick.sshd.vfs.VFSMount.2" and so forth. These mounts must start with a "/" and also have a descriptive name. For example to set the virtual path "/documents" you could use the following property:
```
 System.setProperty("com.maverick.sshd.vfs.VFSMount.1",
                "/documents=C:\\My Documents");
 
```
The setting of attributes is NOT supported within the virtual file system and by default users will have access to all files and folders. You can optionally implement your own VFSPermissionHandler that will enable you to restrict access to files based on user/group permissions. To configure the file system with your handler simply set the "com.maverick.sshd.vfs.VFSPermissionHandler" system property to the fully qualified class name of your class. This will be installed whenever an instance of the VirtualFileSystem is created.

The file system also maps the /home/USERNAME to the users home directory.
Author:

Lee David Painter

Field Summary

Fields
Modifier and Type Field and Description

protected boolean lockFiles
Deprecated.
- Fields inherited from interface com.maverick.sshd.platform.FileSystem
  AUTHORIZED_KEYS_STORE, OPEN_APPEND, OPEN_CREATE, OPEN_EXCLUSIVE, OPEN_READ, OPEN_TEXT, OPEN_TRUNCATE, OPEN_WRITE, SCP, SFTP, SHELL

Fields
Modifier and Type	Field and Description
`protected boolean`	`lockFiles` Deprecated.

Constructor Summary

Constructors
Constructor and Description

VirtualFileSystem()
Deprecated.

Constructors
Constructor and Description
`VirtualFileSystem()` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addMount(String vfspath, String nfspath)` Deprecated.
`void`	`closeFile(byte[] handle)` Deprecated. Close an open file or directory.
`boolean`	`closeFile(byte[] handle, boolean remove)` Deprecated.
`void`	`closeFilesystem()` Deprecated. The filesystem instance is being closed and no further use of the instance is required.
`void`	`createSymbolicLink(String link, String target)` Deprecated. Create a symbolic link.
`boolean`	`fileExists(String path)` Deprecated. Determine whether a file exists and return the result
`String`	`getDefaultPath()` Deprecated. Get the default path for the current session.
`SftpFileAttributes`	`getFileAttributes(byte[] handle)` Deprecated. Get the attributes for a given file handle.
`SftpFileAttributes`	`getFileAttributes(String path)` Deprecated. Get the attributes for a given file.
`protected VFSMount`	`getMount(String vfspath)` Deprecated.
`String`	`getPathForHandle(byte[] handle)` Deprecated. Return the path for a given handle.
`String`	`getRealPath(String path)` Deprecated. Get the real path for a given path.
`void`	`init(Connection con, String protocolInUse)` Deprecated. Initialize the file system.
`void`	`init(Connection con, String protocolInUse, VFSMount homeMount, VFSMount rootMount, List<VFSMount> additonalMounts, VFSPermissionHandler permissionHandler)` Deprecated.
`boolean`	`makeDirectory(String path, SftpFileAttributes attrs)` Deprecated. Create a directory.
`byte[]`	`openDirectory(String path)` Deprecated. Open a directory for reading and allocate an open file handle.
`byte[]`	`openFile(String path, com.maverick.util.UnsignedInteger32 flags, SftpFileAttributes attrs)` Deprecated. Open a file for reading/writing and allocate an open file handle.
`void`	`populateEvent(com.maverick.events.Event event)` Deprecated. Populate any extra fields in a file system event.
`SftpFile[]`	`readDirectory(byte[] handle)` Deprecated. Read the contents of a directory.
`int`	`readFile(byte[] handle, com.maverick.util.UnsignedInteger64 offset, byte[] buf, int start, int numBytesToRead)` Deprecated. Read a block of data from an open file.
`SftpFile`	`readSymbolicLink(String path)` Deprecated. Read the target location of a symbolic link.
`void`	`removeDirectory(String path)` Deprecated. Remove an empty directory from the file system.
`void`	`removeFile(String path)` Deprecated. Remove a file.
`void`	`renameFile(String oldpath, String newpath)` Deprecated. Rename a file.
`void`	`setFileAttributes(byte[] handle, SftpFileAttributes attrs)` Deprecated. Set the open files attributes
`void`	`setFileAttributes(String path, SftpFileAttributes attrs)` Deprecated. Set the files attributes.
`protected String`	`translateCanonicalPath(String path, String securemount)` Deprecated.
`String`	`translateNFSPath(String nfspath)` Deprecated.
`String`	`translateVFSPath(String vfspath)` Deprecated.
`void`	`writeFile(byte[] handle, com.maverick.util.UnsignedInteger64 offset, byte[] data, int off, int len)` Deprecated. Write a block of data to an open file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - lockFiles
```
protected boolean lockFiles
```
    Deprecated.
- Constructor Detail
  - VirtualFileSystem
```
public VirtualFileSystem()
```
    Deprecated.
- Method Detail
  - init
```
public void init(Connection con,
                 String protocolInUse,
                 VFSMount homeMount,
                 VFSMount rootMount,
                 List<VFSMount> additonalMounts,
                 VFSPermissionHandler permissionHandler)
          throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - init
```
public void init(Connection con,
                 String protocolInUse)
          throws IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Initialize the file system. An instance of the file system is created on demand and MAY be attached to a session. In some circumstances a file system will be created before a session is available, for example when attempting to read files from a PublicKeyStore. When this happens the method will receive a null session object, it is recommended that you do not rely on a SessionChannel being availble. In most cases this was used to detect the closing of the channel, and therefore the file system and to resolve this a new method has been added FileSystem.closeFilesystem().
    
    Specified by:
    
    init in interface FileSystem
    
    protocolInUse - the protocol in use
    
    Throws:
    
    IOException
  - addMount
```
protected void addMount(String vfspath,
                        String nfspath)
                 throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - closeFilesystem
```
public void closeFilesystem()
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    The filesystem instance is being closed and no further use of the instance is required.
    
    Specified by:
    
    closeFilesystem in interface FileSystem
  - translateNFSPath
```
public String translateNFSPath(String nfspath)
                        throws IOException,
                               FileNotFoundException
```
    Deprecated.
    
    Throws:
    
    IOException
    
    FileNotFoundException
  - getMount
```
protected VFSMount getMount(String vfspath)
                     throws FileNotFoundException,
                            IOException
```
    Deprecated.
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - translateVFSPath
```
public String translateVFSPath(String vfspath)
                        throws IOException,
                               FileNotFoundException
```
    Deprecated.
    
    Throws:
    
    IOException
    
    FileNotFoundException
  - translateCanonicalPath
```
protected String translateCanonicalPath(String path,
                                        String securemount)
                                 throws FileNotFoundException,
                                        IOException
```
    Deprecated.
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - makeDirectory
```
public boolean makeDirectory(String path,
                             SftpFileAttributes attrs)
                      throws PermissionDeniedException,
                             FileNotFoundException,
                             IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Create a directory. A false value should be returned if the file or directory with the specified path already exists.
    
    Specified by:
    
    makeDirectory in interface FileSystem
    
    Parameters:
    
    path - String the absolute path to the new directory.
    
    Returns:
    
    boolean true if the directory was created, false if the directory already exists.
    
    Throws:
    
    PermissionDeniedException - if the user cannot perform this operation.
    
    FileNotFoundException - if the parent directory does not exist.
    
    IOException
  - getFileAttributes
```
public SftpFileAttributes getFileAttributes(byte[] handle)
                                     throws IOException,
                                            InvalidHandleException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Get the attributes for a given file handle. This requires that you build a file attributes object based upon all the information that you can determine from the file whose open handle has been provided.
    
    Specified by:
    
    getFileAttributes in interface FileSystem
    
    Parameters:
    
    handle - byte[]
    
    Returns:
    
    SftpFileAttributes
    
    Throws:
    
    IOException
    
    InvalidHandleException
  - getFileAttributes
```
public SftpFileAttributes getFileAttributes(String path)
                                     throws IOException,
                                            FileNotFoundException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Get the attributes for a given file. This requires that you build a file attributes object based upon all the information that you can determine.
    
    Specified by:
    
    getFileAttributes in interface FileSystem
    
    Parameters:
    
    path - String the absolute path to the file
    
    Returns:
    
    SftpFileAttributes
    
    Throws:
    
    IOException
    
    FileNotFoundException - if the file cannot be found
    
    See Also:
    
    SftpFileAttributes
  - openDirectory
```
public byte[] openDirectory(String path)
                     throws PermissionDeniedException,
                            FileNotFoundException,
                            IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Open a directory for reading and allocate an open file handle. Open file handles can be whatever you require but the length of the handle string MUST NOT exceed 256 data bytes. Subsequent calls to readDirectory and closeFile will provide the handle returned from this method.
    
    Specified by:
    
    openDirectory in interface FileSystem
    
    Parameters:
    
    path - String
    
    Returns:
    
    byte[]
    
    Throws:
    
    PermissionDeniedException
    
    FileNotFoundException
    
    IOException
  - readDirectory
```
public SftpFile[] readDirectory(byte[] handle)
                         throws InvalidHandleException,
                                EOFException,
                                IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Read the contents of a directory. Each call to this method should return one or more file objects with full file attributes for each file. The client will call this method repeatedly until an EOFException is thrown indicating that there are no more files to read from the directory. If there are no files to list then the EOFException should be thrown upon first call.
    
    IMPORTANT: Each SftpFile object should be initialized with the relative path of the file AND NOT the absolute path.
    
    Specified by:
    
    readDirectory in interface FileSystem
    
    Parameters:
    
    handle - byte[]
    
    Returns:
    
    SftpFile[] an array of SftpFile objects.
    
    Throws:
    
    InvalidHandleException - the handle supplied is invalid.
    
    EOFException - thrown once all the files contained with the directory have been read.
    
    IOException - an error occurred
  - openFile
```
public byte[] openFile(String path,
                       com.maverick.util.UnsignedInteger32 flags,
                       SftpFileAttributes attrs)
                throws PermissionDeniedException,
                       FileNotFoundException,
                       IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Open a file for reading/writing and allocate an open file handle. Open file handles can be whatever you require but the length of the handle string MUST NOT exceed 256 data bytes. Subsequent calls to readDirectory and closeFile will provide the handle returned from this method. The method specifes one or more file open flags which determine which mode the file should be opened in.
    
    Specified by:
    
    openFile in interface FileSystem
    
    Parameters:
    
    path - String
    
    flags - UnsignedInteger32
    
    attrs - SftpFileAttributes
    
    Returns:
    
    byte[]
    
    Throws:
    
    PermissionDeniedException
    
    FileNotFoundException
    
    IOException
  - readFile
```
public int readFile(byte[] handle,
                    com.maverick.util.UnsignedInteger64 offset,
                    byte[] buf,
                    int start,
                    int numBytesToRead)
             throws InvalidHandleException,
                    EOFException,
                    IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Read a block of data from an open file. You should read from the file offset provided and write the data into the buffer array from the start position and return no more data than is requested by numBytesToRead; return the actual number of bytes read in the return value and if the file offset specified is passed EOF you should throw an EOFException.
    
    Specified by:
    
    readFile in interface FileSystem
    
    Parameters:
    
    handle - byte[]
    
    offset - UnsignedInteger64
    
    buf - byte[]
    
    start - int
    
    numBytesToRead - int
    
    Returns:
    
    int
    
    Throws:
    
    InvalidHandleException
    
    EOFException
    
    IOException
  - writeFile
```
public void writeFile(byte[] handle,
                      com.maverick.util.UnsignedInteger64 offset,
                      byte[] data,
                      int off,
                      int len)
               throws InvalidHandleException,
                      IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Write a block of data to an open file. You should write the data from the offset for as many bytes as are supplied.
    
    Specified by:
    
    writeFile in interface FileSystem
    
    Parameters:
    
    handle - byte[]
    
    offset - UnsignedInteger64
    
    data - byte[]
    
    off - int
    
    len - int
    
    Throws:
    
    InvalidHandleException
    
    IOException
  - closeFile
```
public void closeFile(byte[] handle)
               throws InvalidHandleException,
                      IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Close an open file or directory.
    
    Specified by:
    
    closeFile in interface FileSystem
    
    Parameters:
    
    handle - byte[]
    
    Throws:
    
    InvalidHandleException
    
    IOException
  - closeFile
```
public boolean closeFile(byte[] handle,
                         boolean remove)
                  throws InvalidHandleException,
                         IOException
```
    Deprecated.
    
    Throws:
    
    InvalidHandleException
    
    IOException
  - removeFile
```
public void removeFile(String path)
                throws PermissionDeniedException,
                       IOException,
                       FileNotFoundException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Remove a file.
    
    Specified by:
    
    removeFile in interface FileSystem
    
    Parameters:
    
    path - String
    
    Throws:
    
    PermissionDeniedException
    
    IOException
    
    FileNotFoundException
  - renameFile
```
public void renameFile(String oldpath,
                       String newpath)
                throws PermissionDeniedException,
                       FileNotFoundException,
                       IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Rename a file. It is an error if there already exists a file with the name specified by newpath.
    
    Specified by:
    
    renameFile in interface FileSystem
    
    Parameters:
    
    oldpath - String
    
    newpath - String
    
    Throws:
    
    PermissionDeniedException
    
    FileNotFoundException
    
    IOException
  - getDefaultPath
```
public String getDefaultPath()
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Get the default path for the current session. The default path is normally the users home directory.
    
    Specified by:
    
    getDefaultPath in interface FileSystem
    
    Returns:
    
    String the absolute path to the default path.
  - removeDirectory
```
public void removeDirectory(String path)
                     throws PermissionDeniedException,
                            FileNotFoundException,
                            IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Remove an empty directory from the file system. This method should fail if the directory has any file system objects as children.
    
    Specified by:
    
    removeDirectory in interface FileSystem
    
    Parameters:
    
    path - String
    
    Throws:
    
    PermissionDeniedException
    
    FileNotFoundException
    
    IOException
  - setFileAttributes
```
public void setFileAttributes(String path,
                              SftpFileAttributes attrs)
                       throws PermissionDeniedException,
                              IOException,
                              FileNotFoundException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Set the files attributes.
    
    Specified by:
    
    setFileAttributes in interface FileSystem
    
    Parameters:
    
    path - String
    
    attrs - SftpFileAttributes
    
    Throws:
    
    PermissionDeniedException
    
    IOException
    
    FileNotFoundException
  - setFileAttributes
```
public void setFileAttributes(byte[] handle,
                              SftpFileAttributes attrs)
                       throws PermissionDeniedException,
                              IOException,
                              InvalidHandleException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Set the open files attributes
    
    Specified by:
    
    setFileAttributes in interface FileSystem
    
    Parameters:
    
    handle - byte[]
    
    attrs - SftpFileAttributes
    
    Throws:
    
    PermissionDeniedException
    
    IOException
    
    InvalidHandleException
  - readSymbolicLink
```
public SftpFile readSymbolicLink(String path)
                          throws UnsupportedFileOperationException,
                                 FileNotFoundException,
                                 IOException,
                                 PermissionDeniedException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Read the target location of a symbolic link. If the file system does not support links then an UnsupportedOperationException should be thrown. Otherwise the full path to the target of the link should be returned.
    
    Specified by:
    
    readSymbolicLink in interface FileSystem
    
    Parameters:
    
    path - String
    
    Returns:
    
    SftpFile
    
    Throws:
    
    UnsupportedFileOperationException
    
    FileNotFoundException
    
    IOException
    
    PermissionDeniedException
  - createSymbolicLink
```
public void createSymbolicLink(String link,
                               String target)
                        throws UnsupportedFileOperationException,
                               FileNotFoundException,
                               IOException,
                               PermissionDeniedException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Create a symbolic link. If the file system does not support the creation of links then an UnsupportedOperationException should be thrown.
    
    Specified by:
    
    createSymbolicLink in interface FileSystem
    
    Parameters:
    
    link - String
    
    target - String
    
    Throws:
    
    UnsupportedFileOperationException
    
    FileNotFoundException
    
    IOException
    
    PermissionDeniedException
  - fileExists
```
public boolean fileExists(String path)
                   throws IOException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Determine whether a file exists and return the result
    
    Specified by:
    
    fileExists in interface FileSystem
    
    Parameters:
    
    path - String
    
    Returns:
    
    boolean true if the file exists, otherwise false.
    
    Throws:
    
    IOException
  - getRealPath
```
public String getRealPath(String path)
                   throws IOException,
                          FileNotFoundException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Get the real path for a given path. This requires that the path be processed and a full path be returned, for example '/usr/../var' would be returned as '/var'. This should also expand relative paths using the users home directory as a base.
    
    Specified by:
    
    getRealPath in interface FileSystem
    
    Parameters:
    
    path - String the path to canonicalize.
    
    Returns:
    
    String the absolute path to the file.
    
    Throws:
    
    IOException - if an unrecoverable error occurs.
    
    FileNotFoundException - if the path cannot be found.
  - getPathForHandle
```
public String getPathForHandle(byte[] handle)
                        throws InvalidHandleException
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Return the path for a given handle.
    
    Specified by:
    
    getPathForHandle in interface FileSystem
    
    Returns:
    
    Throws:
    
    InvalidHandleException
  - populateEvent
```
public void populateEvent(com.maverick.events.Event event)
```
    Deprecated.
    
    Description copied from interface: FileSystem
    
    Populate any extra fields in a file system event.
    
    Specified by:
    
    populateEvent in interface FileSystem

Class VirtualFileSystem

Field Summary

Fields inherited from interface com.maverick.sshd.platform.FileSystem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lockFiles

Constructor Detail

VirtualFileSystem

Method Detail

init

init

addMount

closeFilesystem

translateNFSPath

getMount

translateVFSPath

translateCanonicalPath

makeDirectory

getFileAttributes

getFileAttributes

openDirectory

readDirectory

openFile

readFile

writeFile

closeFile

closeFile

removeFile

renameFile

getDefaultPath

removeDirectory

setFileAttributes

setFileAttributes

readSymbolicLink

createSymbolicLink

fileExists

getRealPath

getPathForHandle

populateEvent