Class DefaultFileSystemManager
- All Implemented Interfaces:
AutoCloseable
,FileSystemManager
- Direct Known Subclasses:
StandardFileSystemManager
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) final class
This is an internal class because it needs access to the private member providers. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate FileObject
The base file to use for relative URI.All components used by this manager.private final DefaultVfsComponentContext
The context to pass to providers.private FileProvider
The default provider.private CacheStrategy
The cache strategyprivate FileContentInfoFactory
The class to use to determine the content-type (mime-type)private Class
<?> Class which decorates all returned fileObjectsprivate Constructor
<?> Reflection constructor extracted fromfileObjectDecorator
private FileReplicator
The file replicator to use.private FilesCache
The files cacheprivate boolean
Flag, if manager is initialized (after init() and before close()).private LocalFileProvider
The provider for local files.private org.apache.commons.logging.Log
The logger to use.private final Map
<String, List<FileOperationProvider>> Operations providers added to this manager.private final Map
<String, FileProvider> Mapping from URI scheme to FileProvider.private TemporaryFileStore
The temporary file store to use.private final FileTypeMap
Mappings of file types.private VirtualFileProvider
The virtual file provider.List of the schemes of virtual file systems added. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
_closeFileSystem
(FileSystem fileSystem) Closes the given file system.void
addExtensionMap
(String extension, String scheme) Adds an file name extension mapping.void
addMimeTypeMap
(String mimeType, String scheme) Adds a mime type mapping.void
addOperationProvider
(String[] schemes, FileOperationProvider operationProvider) void
addOperationProvider
(String scheme, FileOperationProvider operationProvider) Adds the specified FileOperationProvider for the specified scheme.void
addProvider
(String[] urlSchemes, FileProvider provider) Registers a file system provider.void
addProvider
(String urlScheme, FileProvider provider) Registers a file system provider.protected void
addVirtualFileSystemScheme
(String rootUri) boolean
Determines if a layered file system can be created for a given file.void
close()
Closes the manager.private void
closeComponent
(Object component) Closes a component, if it has not already been closed.void
closeFileSystem
(FileSystem fileSystem) Closes the given file system.createFileSystem
(String scheme, FileObject file) Creates a layered file system.createFileSystem
(FileObject file) Creates a layered file system.createVirtualFileSystem
(String rootUri) Creates an empty virtual file system.createVirtualFileSystem
(FileObject rootFile) Creates a virtual file system.void
Free all resources used by unused file systems created by this manager.Returns the base file used to resolve relative URI.Get the cache strategy used.get the fileContentInfoFactory used to determine the infos of a file content.Class
<?> Get the file object decorator used.Constructor
<?> The constructor associated to the fileObjectDecorator.Returns the filesCache implementation used to cache files.getFileSystemConfigBuilder
(String scheme) Get the configuration builder for the given scheme.private LocalFileProvider
Locates the local file provider.protected org.apache.commons.logging.Log
Returns the logger used by this manager.getOperationProviders
(String scheme) Gets Providers for file operations.getProviderCapabilities
(String scheme) Get the capabilities for a given scheme.Returns the file replicator.String[]
Get the schemes currently available.Returns the temporary file store.Get the URLStreamHandlerFactory.boolean
hasProvider
(String scheme) Returns true if this manager has a provider for a particular scheme.void
init()
Initializes this manager.void
removeProvider
(String urlScheme) Unregisters a file system provider.resolveFile
(File baseFile, String uri) Resolves a URI, relative to base file.resolveFile
(String uri) Locates a file by URI.resolveFile
(String uri, FileSystemOptions fileSystemOptions) Locate a file by URI, use the FileSystemOptions for file-system creation.resolveFile
(URI uri) Converts a URI into aFileObject
.resolveFile
(URL url) Converts a URL into aFileObject
.resolveFile
(FileObject baseFile, String uri) Resolves a URI, relative to a base file.resolveFile
(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) Resolves a URI, relative to a base file with specified FileSystem configuration.resolveName
(FileName root, String path) Resolves a name, relative to the file.resolveName
(FileName base, String name, NameScope scope) Resolves a name, relative to the root.resolveURI
(String uri) Resolve the uri to a file name.void
setBaseFile
(File baseFile) Sets the base file to use when resolving relative URI.void
setBaseFile
(FileObject baseFile) Sets the base file to use when resolving relative URI.void
setCacheStrategy
(CacheStrategy fileCacheStrategy) Set the cache strategy to use when dealing with file object data.void
setDefaultProvider
(FileProvider provider) Sets the default provider.void
setFileContentInfoFactory
(FileContentInfoFactory fileContentInfoFactory) set the fileContentInfoFactory used to determine the infos of a file content.void
setFileObjectDecorator
(Class<?> fileObjectDecorator) Set a fileObject decorator to be used for ALL returned file objects.void
setFilesCache
(FilesCache filesCache) Sets the filesCache implementation used to cache files.void
setLogger
(org.apache.commons.logging.Log log) Sets the logger to use.void
setReplicator
(FileReplicator replicator) Sets the file replicator to use.void
setTemporaryFileStore
(TemporaryFileStore tempFileStore) Sets the temporary file store to use.private void
setupComponent
(Object component) Initializes a component, if it has not already been initialized.toFileObject
(File file) Converts a local file into aFileObject
.
-
Field Details
-
providers
Mapping from URI scheme to FileProvider. -
virtualFileSystemSchemes
List of the schemes of virtual file systems added. -
components
All components used by this manager. -
context
The context to pass to providers. -
operationProviders
Operations providers added to this manager. -
typeMap
Mappings of file types. -
localFileProvider
The provider for local files. -
defaultProvider
The default provider. -
fileReplicator
The file replicator to use. -
baseFile
The base file to use for relative URI. -
filesCache
The files cache -
fileCacheStrategy
The cache strategy -
fileObjectDecorator
Class which decorates all returned fileObjects -
fileObjectDecoratorConst
Reflection constructor extracted fromfileObjectDecorator
-
fileContentInfoFactory
The class to use to determine the content-type (mime-type) -
log
private org.apache.commons.logging.Log logThe logger to use. Default implementation. -
tempFileStore
The temporary file store to use. -
vfsProvider
The virtual file provider. -
init
private boolean initFlag, if manager is initialized (after init() and before close()).
-
-
Constructor Details
-
DefaultFileSystemManager
public DefaultFileSystemManager()
-
-
Method Details
-
_closeFileSystem
Closes the given file system.If you use VFS as singleton it is VERY dangerous to call this method
- Parameters:
fileSystem
- The FileSystem to close.
-
addExtensionMap
Adds an file name extension mapping.- Parameters:
extension
- The file name extension.scheme
- The scheme to use for files with this extension.
-
addMimeTypeMap
Adds a mime type mapping.- Parameters:
mimeType
- The mime type.scheme
- The scheme to use for files with this mime type.
-
addOperationProvider
public void addOperationProvider(String scheme, FileOperationProvider operationProvider) throws FileSystemException Adds the specified FileOperationProvider for the specified scheme. Several FileOperationProvider's might be registered for the same scheme. For example, for "file" scheme we can register SvnWsOperationProvider and CvsOperationProvider.- Specified by:
addOperationProvider
in interfaceFileSystemManager
- Parameters:
scheme
- The scheme the provider should be registered for.operationProvider
- The FileOperationProvider.- Throws:
FileSystemException
- if an error occurs adding the provider.
-
addOperationProvider
public void addOperationProvider(String[] schemes, FileOperationProvider operationProvider) throws FileSystemException - Specified by:
addOperationProvider
in interfaceFileSystemManager
- Parameters:
schemes
- The array of schemes the provider should apply to.operationProvider
- The FileOperationProvider.- Throws:
FileSystemException
- if an error occurs.- See Also:
-
addProvider
Registers a file system provider.The manager takes care of all lifecycle management. A provider may be registered multiple times. The first
LocalFileProvider
added will be remembered forgetLocalFileProvider()
.- Parameters:
urlScheme
- The scheme the provider will handle.provider
- The provider.- Throws:
FileSystemException
- if an error occurs adding the provider.
-
addProvider
Registers a file system provider.The manager takes care of all lifecycle management. A provider may be registered multiple times. The first
LocalFileProvider
added will be remembered forgetLocalFileProvider()
.- Parameters:
urlSchemes
- The schemes the provider will handle.provider
- The provider.- Throws:
FileSystemException
- if an error occurs adding the provider.
-
addVirtualFileSystemScheme
-
canCreateFileSystem
Determines if a layered file system can be created for a given file.- Specified by:
canCreateFileSystem
in interfaceFileSystemManager
- Parameters:
file
- The file to check for.- Returns:
- true if the FileSystem can be created.
- Throws:
FileSystemException
- if an error occurs.
-
close
public void close()Closes the manager.This will close all providers (all files), it will also close all managed components including temporary files, replicator, file cache and file operations.
The manager is in uninitialized state after this method.
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceFileSystemManager
-
closeComponent
Closes a component, if it has not already been closed.- Parameters:
component
- The component to close.
-
closeFileSystem
Closes the given file system.If you use VFS as singleton it is VERY dangerous to call this method.
- Specified by:
closeFileSystem
in interfaceFileSystemManager
- Parameters:
fileSystem
- The FileSystem to close.
-
createFileSystem
Creates a layered file system.- Specified by:
createFileSystem
in interfaceFileSystemManager
- Parameters:
file
- The FileObject to use.- Returns:
- The layered FileObject.
- Throws:
FileSystemException
- if an error occurs.
-
createFileSystem
Creates a layered file system.- Specified by:
createFileSystem
in interfaceFileSystemManager
- Parameters:
scheme
- The scheme to use.file
- The FileObject.- Returns:
- The layered FileObject.
- Throws:
FileSystemException
- if an error occurs.
-
createVirtualFileSystem
Creates a virtual file system.- Specified by:
createVirtualFileSystem
in interfaceFileSystemManager
- Parameters:
rootFile
- The FileObject to use.- Returns:
- The FileObject in the VirtualFileSystem.
- Throws:
FileSystemException
- if an error occurs creating the file.
-
createVirtualFileSystem
Creates an empty virtual file system.- Specified by:
createVirtualFileSystem
in interfaceFileSystemManager
- Parameters:
rootUri
- The URI to use as the root of the FileSystem.- Returns:
- A FileObject in the virtual FileSystem.
- Throws:
FileSystemException
- if an error occurs.
-
freeUnusedResources
public void freeUnusedResources()Free all resources used by unused file systems created by this manager. -
getBaseFile
Returns the base file used to resolve relative URI.- Specified by:
getBaseFile
in interfaceFileSystemManager
- Returns:
- The FileObject that represents the base file.
- Throws:
FileSystemException
- if an error occurs.
-
getCacheStrategy
Get the cache strategy used.- Specified by:
getCacheStrategy
in interfaceFileSystemManager
- Returns:
- The CacheStrategy.
-
getFileContentInfoFactory
get the fileContentInfoFactory used to determine the infos of a file content.- Specified by:
getFileContentInfoFactory
in interfaceFileSystemManager
- Returns:
- The FileContentInfoFactory.
-
getFileObjectDecorator
Get the file object decorator used.- Specified by:
getFileObjectDecorator
in interfaceFileSystemManager
- Returns:
- The decorator.
-
getFileObjectDecoratorConst
The constructor associated to the fileObjectDecorator. We cache it here for performance reasons.- Specified by:
getFileObjectDecoratorConst
in interfaceFileSystemManager
- Returns:
- The decorator's Constructor.
-
getFilesCache
Returns the filesCache implementation used to cache files.- Specified by:
getFilesCache
in interfaceFileSystemManager
- Returns:
- The FilesCache.
-
getFileSystemConfigBuilder
Get the configuration builder for the given scheme.- Specified by:
getFileSystemConfigBuilder
in interfaceFileSystemManager
- Parameters:
scheme
- The scheme to locate.- Returns:
- The FileSystemConfigBuilder for the scheme.
- Throws:
FileSystemException
- if the given scheme is not konwn
-
getLocalFileProvider
Locates the local file provider.The local file provider is the first provider added implementing
LocalFileProvider
.- Returns:
- The LocalFileProvider.
- Throws:
FileSystemException
- if no local file provider was set.
-
getLogger
protected org.apache.commons.logging.Log getLogger()Returns the logger used by this manager.- Returns:
- the Logger.
-
getOperationProviders
Description copied from interface:FileSystemManager
Gets Providers for file operations.- Specified by:
getOperationProviders
in interfaceFileSystemManager
- Parameters:
scheme
- the scheme for wich we want to get the list af registered providers.- Returns:
- the registered FileOperationProviders for the specified scheme. If there were no providers registered for the scheme, it returns null.
- Throws:
FileSystemException
- if an error occurs.
-
getProviderCapabilities
Get the capabilities for a given scheme.- Specified by:
getProviderCapabilities
in interfaceFileSystemManager
- Parameters:
scheme
- The scheme to located.- Returns:
- A Collection of capabilities.
- Throws:
FileSystemException
- if the given scheme is not konwn
-
getReplicator
Returns the file replicator.- Returns:
- The file replicator. Never returns null.
- Throws:
FileSystemException
- if there is no FileReplicator.
-
getSchemes
Get the schemes currently available.- Specified by:
getSchemes
in interfaceFileSystemManager
- Returns:
- The array of scheme names.
-
getTemporaryFileStore
Returns the temporary file store.- Returns:
- The file store. Never returns null.
- Throws:
FileSystemException
- if there is no TemporaryFileStore.
-
getURLStreamHandlerFactory
Get the URLStreamHandlerFactory.- Specified by:
getURLStreamHandlerFactory
in interfaceFileSystemManager
- Returns:
- The URLStreamHandlerFactory.
-
hasProvider
Returns true if this manager has a provider for a particular scheme.- Specified by:
hasProvider
in interfaceFileSystemManager
- Parameters:
scheme
- The scheme to check.- Returns:
- true if a provider is configured for this scheme, false otherwise.
-
init
Initializes this manager.If no value for the following properties was specified, it will use the following defaults:
- fileContentInfoFactory = new FileContentInfoFilenameFactory()
- filesCache = new SoftRefFilesCache()
- fileCacheStrategy = CacheStrategy.ON_RESOLVE
- Throws:
FileSystemException
- if an error occurs during initialization.
-
removeProvider
Unregisters a file system provider.- Parameters:
urlScheme
- The scheme of the provider.- Since:
- 2.8.0
-
resolveFile
Resolves a URI, relative to base file.Uses the local file provider to locate the system file.
- Specified by:
resolveFile
in interfaceFileSystemManager
- Parameters:
baseFile
- The base File to use to locate the file.uri
- The URI of the file to locate.- Returns:
- The FileObject for the located file.
- Throws:
FileSystemException
- if the file cannot be located or an error occurs.
-
resolveFile
Resolves a URI, relative to a base file.- Specified by:
resolveFile
in interfaceFileSystemManager
- Parameters:
baseFile
- The base FileOjbect to use to locate the file.uri
- The URI of the file to locate.- Returns:
- The FileObject for the located file.
- Throws:
FileSystemException
- if the file cannot be located or an error occurs.
-
resolveFile
public FileObject resolveFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) throws FileSystemException Resolves a URI, relative to a base file with specified FileSystem configuration.- Parameters:
baseFile
- The base file.uri
- The file name. May be a fully qualified or relative path or a url.fileSystemOptions
- Options to pass to the file system.- Returns:
- A FileObject representing the target file.
- Throws:
FileSystemException
- if an error occurs accessing the file.
-
resolveFile
Locates a file by URI.- Specified by:
resolveFile
in interfaceFileSystemManager
- Parameters:
uri
- The URI of the file to locate.- Returns:
- The FileObject for the located file.
- Throws:
FileSystemException
- if the file cannot be located or an error occurs.
-
resolveFile
public FileObject resolveFile(String uri, FileSystemOptions fileSystemOptions) throws FileSystemException Locate a file by URI, use the FileSystemOptions for file-system creation.- Specified by:
resolveFile
in interfaceFileSystemManager
- Parameters:
uri
- The URI of the file to locate.fileSystemOptions
- The options for the FileSystem.- Returns:
- The FileObject for the located file.
- Throws:
FileSystemException
- if the file cannot be located or an error occurs.
-
resolveFile
Converts a URI into aFileObject
.- Specified by:
resolveFile
in interfaceFileSystemManager
- Parameters:
uri
- The URI to convert.- Returns:
- The
FileObject
that represents the URI. Never returns null. - Throws:
FileSystemException
- On error converting the URI.- Since:
- 2.1
-
resolveFile
Converts a URL into aFileObject
.- Specified by:
resolveFile
in interfaceFileSystemManager
- Parameters:
url
- The URL to convert.- Returns:
- The
FileObject
that represents the URL. Never returns null. - Throws:
FileSystemException
- On error converting the URL.- Since:
- 2.1
-
resolveName
Resolves a name, relative to the file. If the supplied name is an absolute path, then it is resolved relative to the root of the file system that the file belongs to. If a relative name is supplied, then it is resolved relative to this file name.- Specified by:
resolveName
in interfaceFileSystemManager
- Parameters:
root
- The base FileName.path
- The path to the file relative to the base FileName or an absolute path.- Returns:
- The constructed FileName.
- Throws:
FileSystemException
- if an error occurs constructing the FileName.
-
resolveName
Resolves a name, relative to the root.- Specified by:
resolveName
in interfaceFileSystemManager
- Parameters:
base
- the base file namename
- the namescope
- theNameScope
- Returns:
- The FileName of the file.
- Throws:
FileSystemException
- if an error occurs.
-
resolveURI
Resolve the uri to a file name.- Specified by:
resolveURI
in interfaceFileSystemManager
- Parameters:
uri
- The URI to resolve.- Returns:
- The FileName of the file.
- Throws:
FileSystemException
- if an error occurs.
-
setBaseFile
Sets the base file to use when resolving relative URI.- Parameters:
baseFile
- The new base FileObject.- Throws:
FileSystemException
- if an error occurs.
-
setBaseFile
Sets the base file to use when resolving relative URI.- Parameters:
baseFile
- The new base FileObject.
-
setCacheStrategy
Set the cache strategy to use when dealing with file object data.Can only be set before the FileSystemManager is initialized.
The default is
CacheStrategy.ON_RESOLVE
.- Parameters:
fileCacheStrategy
- The CacheStrategy to use.- Throws:
FileSystemException
- if this is not possible. e.g. it is already set.
-
setDefaultProvider
Sets the default provider. This is the provider that will handle URI with unknown schemes. The manager takes care of all lifecycle management.- Parameters:
provider
- The FileProvider.- Throws:
FileSystemException
- if an error occurs setting the provider.
-
setFileContentInfoFactory
public void setFileContentInfoFactory(FileContentInfoFactory fileContentInfoFactory) throws FileSystemException set the fileContentInfoFactory used to determine the infos of a file content.Can only be set before the FileSystemManager is initialized.
- Parameters:
fileContentInfoFactory
- The FileContentInfoFactory.- Throws:
FileSystemException
- if an error occurs setting the FileContentInfoFactory.
-
setFileObjectDecorator
Set a fileObject decorator to be used for ALL returned file objects.Can only be set before the FileSystemManager is initialized.
- Parameters:
fileObjectDecorator
- must be inherted fromDecoratedFileObject
a has to provide a constructor with a singleFileObject
as argument- Throws:
FileSystemException
- if an error occurs setting the decorator.
-
setFilesCache
Sets the filesCache implementation used to cache files.Can only be set before the FileSystemManager is initialized.
The manager takes care of the lifecycle. If none is set, a default is picked in
init()
.- Parameters:
filesCache
- The FilesCache.- Throws:
FileSystemException
- if an error occurs setting the cache..
-
setLogger
public void setLogger(org.apache.commons.logging.Log log) Sets the logger to use.This overwrites the default logger for this manager and is not reset in
close()
.- Specified by:
setLogger
in interfaceFileSystemManager
- Parameters:
log
- The Logger to use.
-
setReplicator
Sets the file replicator to use.The manager takes care of all lifecycle management.
- Parameters:
replicator
- The FileReplicator.- Throws:
FileSystemException
- if an error occurs setting the replicator.
-
setTemporaryFileStore
Sets the temporary file store to use.The manager takes care of all lifecycle management.
- Parameters:
tempFileStore
- The temporary FileStore.- Throws:
FileSystemException
- if an error occurs adding the file store.
-
setupComponent
Initializes a component, if it has not already been initialized.- Parameters:
component
- The component to setup.- Throws:
FileSystemException
- if an error occurs.
-
toFileObject
Converts a local file into aFileObject
.- Specified by:
toFileObject
in interfaceFileSystemManager
- Parameters:
file
- The input File.- Returns:
- the create FileObject
- Throws:
FileSystemException
- if an error occurs creating the file.
-