jfilesyslib

Class FullFileSystem

java.lang.Object

jfilesyslib.FileSystem

jfilesyslib.FullFileSystem

Direct Known Subclasses:

CachingFs, ExtendedSupportFs, LoggingFs, MergeDirectlyFs

public abstract class FullFileSystem
extends FileSystem

This abstract class lets you implement every file system feature.

Author:

Marc Miltenberger

Constructor Summary

Constructors

Constructor and Description
FullFileSystem()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	afterUnmounting() Is called after the file system has been unmounted successfully.
abstract void	beforeMounting(java.lang.String mountPath) Is called directly before the file system is mounted
abstract void	beforeUnmounting() Is called directly before the file system is unmounted
abstract void	createHardLink(java.lang.String source, java.lang.String destination) Creates a hard link at source pointing to destination.
abstract void	createSymbolicLink(java.lang.String source, java.lang.String destination) Creates a symbolic link at source pointing to destination.
abstract int	getFilesFreeCount() Returns the number of files which may be created.
abstract int	getMaxPathLength() Returns the maximum path length.
abstract int	getTotalFilesCount() Returns the total number of files on the volume.
abstract UnixPermissions	getUnixPermissions(java.lang.String path) Returns the unix permissions
abstract int	getVolumeSerialNumber() Returns a volume serial number
abstract WindowsAttributes	getWindowsAttributes(java.lang.String path) Returns the windows attributes.
abstract boolean	isCompressed() Returns true if the file system is compressed
abstract boolean	isReadOnly() Returns true if the file system is read only
abstract java.lang.Iterable<ExtendedAttribute>	listExtendedAttributes(java.lang.String path) Lists the extended attributes of a path.
abstract void	lockFile(FileHandle handle, long byteOffset, long length) Locks a file in the specified range for every write access except for the File Handle handle.
abstract void	removeExtendedAttribute(java.lang.String path, java.lang.String attributeName) Sets or adds extended attributes.
abstract void	setExtendedAttribute(java.lang.String path, ExtendedAttribute attribute) Sets or adds extended attribute.
abstract void	setUnixPermissions(java.lang.String path, UnixPermissions perms) Sets the unix permissions for a file/directory.
abstract void	setWindowsAttributes(java.lang.String path, WindowsAttributes windowsAttributes) Sets the windows attributes.
abstract boolean	supportsUnicodeFilenames() Returns true if the file system supports unicode filenames.
abstract void	unlockFile(FileHandle handle, long byteOffset, long length) Unlocks a file in the specified range.

Methods inherited from class jfilesyslib.FileSystem

close, createDirectory, createFile, delete, deleteDirectoryRecursively, deleteFile, flush, getBlockSize, getExtendedAttribute, getFileMetaData, getFileSystemName, getFreeBlockAvailableCount, getFreeBlockCount, getMountPath, getNumberOfFilesInDirectory, getTotalBlockCount, getVolumeName, isCaseSensitive, listDirectory, openFile, pathExists, read, rename, setCreationTime, setLastAccessTime, setLastModificationTime, setLength, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FullFileSystem

public FullFileSystem()

Method Detail

createSymbolicLink

public abstract void createSymbolicLink(java.lang.String source,
                      java.lang.String destination)
                                 throws PathNotFoundException,
                                        SourceAlreadyExistsException,
                                        AccessDeniedException,
                                        UnsupportedFeatureException

Description copied from class: FileSystem

Creates a symbolic link at source pointing to destination.
The default file system does not support this feature.

Overrides:

createSymbolicLink in class FileSystem

Parameters:

source - the source

destination - the destination

Throws:

PathNotFoundException - the parent directory (of source) could not be found

SourceAlreadyExistsException - the source does already exist

AccessDeniedException - the access was denied

UnsupportedFeatureException - the feature is unsupported

See Also:

https://en.wikipedia.org/wiki/Symbolic_link

createHardLink

public abstract void createHardLink(java.lang.String source,
                  java.lang.String destination)
                             throws PathNotFoundException,
                                    SourceAlreadyExistsException,
                                    AccessDeniedException,
                                    UnsupportedFeatureException

Description copied from class: FileSystem

Creates a hard link at source pointing to destination.
The default file system does not support this feature.

Overrides:

createHardLink in class FileSystem

Parameters:

source - the source

destination - the destination

Throws:

PathNotFoundException - the parent directory could not be found

SourceAlreadyExistsException - the source does already exist

AccessDeniedException - the access was denied

UnsupportedFeatureException - the feature is unsupported

See Also:

https://en.wikipedia.org/wiki/Hard_link

getMaxPathLength

public abstract int getMaxPathLength()

Description copied from class: FileSystem

Returns the maximum path length. The default value is 32768.

Overrides:

getMaxPathLength in class FileSystem

Returns:

the maximum path length

getFilesFreeCount

public abstract int getFilesFreeCount()

Description copied from class: FileSystem

Returns the number of files which may be created.

Overrides:

getFilesFreeCount in class FileSystem

Returns:

the number of files which may be created

getTotalFilesCount

public abstract int getTotalFilesCount()

Description copied from class: FileSystem

Returns the total number of files on the volume.
By default it returns 0, but it does not seem to harmful.

Overrides:

getTotalFilesCount in class FileSystem

Returns:

the total number of files

setUnixPermissions

public abstract void setUnixPermissions(java.lang.String path,
                      UnixPermissions perms)
                                 throws PathNotFoundException,
                                        AccessDeniedException,
                                        UnsupportedFeatureException

Description copied from class: FileSystem

Sets the unix permissions for a file/directory.
This feature is not supported by default.

Overrides:

setUnixPermissions in class FileSystem

Parameters:

path - the path

perms - the permissions

Throws:

PathNotFoundException - the path was not found

AccessDeniedException - the access is denied

UnsupportedFeatureException - the feature is unsupported

getUnixPermissions

public abstract UnixPermissions getUnixPermissions(java.lang.String path)
                                            throws PathNotFoundException

Description copied from class: FileSystem

Returns the unix permissions

Overrides:

getUnixPermissions in class FileSystem

Parameters:

path - the path

Returns:

the permissions

Throws:

PathNotFoundException - the path was not found

setWindowsAttributes

public abstract void setWindowsAttributes(java.lang.String path,
                        WindowsAttributes windowsAttributes)
                                   throws PathNotFoundException,
                                          AccessDeniedException,
                                          UnsupportedFeatureException

Description copied from class: FileSystem

Sets the windows attributes.
This feature is not supported by default.

Overrides:

setWindowsAttributes in class FileSystem

Parameters:

path - the path

windowsAttributes - the windows attributes

Throws:

PathNotFoundException - the path was not found

AccessDeniedException - the access is denied

UnsupportedFeatureException - the feature is not supported

getWindowsAttributes

public abstract WindowsAttributes getWindowsAttributes(java.lang.String path)
                                                throws PathNotFoundException,
                                                       AccessDeniedException,
                                                       UnsupportedFeatureException

Description copied from class: FileSystem

Returns the windows attributes.
The default implementation:
If the file system is read only, it returns the read only attribute.
If not, it does not return any attribute.

Overrides:

getWindowsAttributes in class FileSystem

Parameters:

path - the path

Returns:

the windows attributes

Throws:

PathNotFoundException - the path was not found

AccessDeniedException - the access is denied

UnsupportedFeatureException - the feature is not supported

lockFile

public abstract void lockFile(FileHandle handle,
            long byteOffset,
            long length)
                       throws PathNotFoundException,
                              AccessDeniedException,
                              NotAFileException,
                              UnsupportedFeatureException,
                              AlreadyLockedException

Description copied from class: FileSystem

Locks a file in the specified range for every write access except for the File Handle handle.
This is windows specific.
This feature is not supported by default.

Overrides:

lockFile in class FileSystem

Parameters:

handle - the file handle

byteOffset - the byte offset

length - the length

Throws:

PathNotFoundException - the path was not found

AccessDeniedException - the access is denied

NotAFileException - the path is not a file

UnsupportedFeatureException - the feature is not supported

AlreadyLockedException - parts of the specified range are already locked

unlockFile

public abstract void unlockFile(FileHandle handle,
              long byteOffset,
              long length)
                         throws PathNotFoundException,
                                AccessDeniedException,
                                NotAFileException,
                                UnsupportedFeatureException

Description copied from class: FileSystem

Unlocks a file in the specified range.
This is windows specific.
The caller does not perform a check that the file handle is identical to the locker's file handle.
This feature is not supported by default.

Overrides:

unlockFile in class FileSystem

Parameters:

handle - the file handle

byteOffset - the byte offset

length - the length

Throws:

PathNotFoundException - the path was not found

AccessDeniedException - the access is denied

NotAFileException - the path is not a file

UnsupportedFeatureException - the feature is not supported

supportsUnicodeFilenames

public abstract boolean supportsUnicodeFilenames()

Description copied from class: FileSystem

Returns true if the file system supports unicode filenames.
Since most file systems use Java Strings to encode file names, the default value is true.

Overrides:

supportsUnicodeFilenames in class FileSystem

Returns:

true if the file system supports unicode filenames.

isCompressed

public abstract boolean isCompressed()

Description copied from class: FileSystem

Returns true if the file system is compressed

Overrides:

isCompressed in class FileSystem

Returns:

true if the file system is compressed

getVolumeSerialNumber

public abstract int getVolumeSerialNumber()

Description copied from class: FileSystem

Returns a volume serial number

Overrides:

getVolumeSerialNumber in class FileSystem

Returns:

a volume serial number

isReadOnly

public abstract boolean isReadOnly()

Description copied from class: FileSystem

Returns true if the file system is read only

Overrides:

isReadOnly in class FileSystem

Returns:

true if the file system is read only

listExtendedAttributes

public abstract java.lang.Iterable<ExtendedAttribute> listExtendedAttributes(java.lang.String path)
                                                                      throws PathNotFoundException,
                                                                             AccessDeniedException,
                                                                             UnsupportedFeatureException

Description copied from class: FileSystem

Lists the extended attributes of a path.
This feature is not supported by default.

Overrides:

listExtendedAttributes in class FileSystem

Parameters:

path - the path

Returns:

the extended attributes

Throws:

PathNotFoundException - the path was not found

AccessDeniedException - the access is denied

UnsupportedFeatureException - the feature is not supported

setExtendedAttribute

public abstract void setExtendedAttribute(java.lang.String path,
                        ExtendedAttribute attribute)
                                   throws PathNotFoundException,
                                          AccessDeniedException,
                                          UnsupportedFeatureException

Description copied from class: FileSystem

Sets or adds extended attribute.
This feature is not supported by default.

Overrides:

setExtendedAttribute in class FileSystem

Parameters:

path - the path

attribute - the attribute to add/set

Throws:

PathNotFoundException - the path was not found

AccessDeniedException - the access is denied

UnsupportedFeatureException - the feature is not supported

removeExtendedAttribute

public abstract void removeExtendedAttribute(java.lang.String path,
                           java.lang.String attributeName)
                                      throws PathNotFoundException,
                                             AccessDeniedException,
                                             UnsupportedFeatureException,
                                             AttributeNotFoundException

Description copied from class: FileSystem

Sets or adds extended attributes.
This feature is not supported by default.

Overrides:

removeExtendedAttribute in class FileSystem

Parameters:

path - the path

attributeName - the attribute name

Throws:

PathNotFoundException - the path was not found

AccessDeniedException - the access is denied

UnsupportedFeatureException - the feature is not supported

AttributeNotFoundException - the specified attribute was not found

beforeMounting

public abstract void beforeMounting(java.lang.String mountPath)

Description copied from class: FileSystem

Is called directly before the file system is mounted

Overrides:

beforeMounting in class FileSystem

Parameters:

mountPath - the mount path

beforeUnmounting

public abstract void beforeUnmounting()

Description copied from class: FileSystem

Is called directly before the file system is unmounted

Overrides:

beforeUnmounting in class FileSystem

afterUnmounting

public abstract void afterUnmounting()

Description copied from class: FileSystem

Is called after the file system has been unmounted successfully.

Overrides:

afterUnmounting in class FileSystem