[This is preliminary documentation and is subject to change.]
The FileSystem type exposes the following members.Constructors
| Name | Description | |
|---|---|---|
| FileSystem | Initializes a new instance of the FileSystem class |
Methods
| Name | Description | |
|---|---|---|
| __setComponentDirector | (Inherited from ApplicationComponent.) | |
| AutoStartSystems |
Automatically starts systems designated in config with auto-start attribute
| |
| CombinePaths |
Combines two or more path segments joining them using primary file system path separator. This method is thread-safe
| |
| Configure |
Configures file system. This method is a part of lifecycle management and is intended to be called only by creating thread (not thread-safe)
| |
| Destructor | (Overrides ApplicationComponent Destructor .) | |
| Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) | |
| DoBeginTransaction |
Override in particular file systems that support transactions to begin transaction in specified session.
This method may be called by miltiple threads
| |
| DoBeginTransactionAsync |
Async version of DoBeginTransaction(FileSystemSession).
This base/default implementation just synchronously calls DoBeginTransaction(FileSystemSession) and
returns already completed Task with result returned by DoBeginTransaction(FileSystemSession) | |
| DoCheckCanChange |
Override in particular file systems to see if item can change, i.e.
for file systems that support versioning throw exception if item is in session
which "looks" at a sealed/closed version and can not change. This method may be called by miltiple threads
| |
| DoCheckCanChangeAsync |
Async version of DoCheckCanChange(FileSystemSessionItem).
This base/default implementation just synchronously calls DoCheckCanChange(FileSystemSessionItem) and
returns already completed Task with result returned by DoCheckCanChange(FileSystemSessionItem) | |
| DoCommitTransaction |
Override in particular file systems that support transactions to commit transaction in specified session.
This method may be called by miltiple threads
| |
| DoCommitTransactionAsync |
Async version of DoCommitTransaction(FileSystemSession).
This base/default implementation just synchronously calls DoCommitTransaction(FileSystemSession) and
returns already completed Task with result returned by DoCommitTransaction(FileSystemSession) | |
| DoConfigure |
Override to perform custom configuration
| |
| DoCreateDirectory |
Override to create a directory.
This method may be called by miltiple threads
| |
| DoCreateDirectoryAsync |
Async version of DoCreateDirectory(FileSystemDirectory, String).
This base/default implementation just synchronously calls DoCreateDirectory(FileSystemDirectory, String) and
returns already completed Task with result returned by DoCreateDirectory(FileSystemDirectory, String) | |
| DoCreateFile(FileSystemDirectory, String, Int32) |
Override to create a file.
This method may be called by miltiple threads
| |
| DoCreateFile(FileSystemDirectory, String, String, Boolean) |
Override to create a file from local file.
This method may be called by miltiple threads
| |
| DoCreateFileAsync(FileSystemDirectory, String, Int32) |
Async version of DoCreateFile(FileSystemDirectory, String, Int32).
This base/default implementation just synchronously calls DoCreateFile(FileSystemDirectory, String, Int32) and
returns already completed Task with result returned by DoCreateFile(FileSystemDirectory, String, Int32) | |
| DoCreateFileAsync(FileSystemDirectory, String, String, Boolean) |
Async version of DoCreateFile(FileSystemDirectory, String, String, Boolean).
This base/default implementation just synchronously calls DoCreateFile(FileSystemDirectory, String, String, Boolean) and
returns already completed Task with result returned by DoCreateFile(FileSystemDirectory, String, String, Boolean) | |
| DoDeleteItem |
Override to delete item.
This method may be called by miltiple threads
| |
| DoDeleteItemAsync |
Async version of DoDeleteItem(FileSystemSessionItem).
This base/default implementation just synchronously calls DoDeleteItem(FileSystemSessionItem) and
returns already completed Task with result returned by DoDeleteItem(FileSystemSessionItem) | |
| DoDirectoryDeepCopyAsync |
Implements asynchronous deep copy of folders where destination folder may belong to a different file system.
The specifics of implementation may be dictated by particular file systems, i.e.: asynchronous strategies for getting file
lists may depend on the particular system.
| |
| DoFlushAsync | ||
| DoGetCreationTimestamp |
Override to get item creation timestamp.
This method may be called by miltiple threads
| |
| DoGetCreationUser |
Override in particular file systems to get user who created item.
This method may be called by miltiple threads
| |
| DoGetCreationUserAsync |
Async version of DoGetCreationUser(FileSystemSessionItem).
This base/default implementation just synchronously calls DoGetCreationUser(FileSystemSessionItem) and
returns already completed Task with result returned by DoGetCreationUser(FileSystemSessionItem) | |
| DoGetFileNames |
Override to get file names in directory. If directory is null then root is assumed.
This method may be called by miltiple threads
| |
| DoGetFileNamesAsync |
Async version of DoGetFileNames(FileSystemDirectory, Boolean).
This base/default implementation just synchronously calls DoGetFileNames(FileSystemDirectory, Boolean) and
returns already completed Task with result returned by DoGetFileNames(FileSystemDirectory, Boolean) | |
| DoGetFileStream |
Override to get file stream.
This method may be called by miltiple threads
| |
| DoGetFileStreamAsync |
Async version of DoGetFileStream(FileSystemFile, Action FileSystemStream ).
This base/default implementation just synchronously calls DoGetFileStream(FileSystemFile, Action FileSystemStream ) and
returns already completed Task with result returned by DoGetFileStream(FileSystemFile, Action FileSystemStream ) | |
| DoGetItemSize |
Override to get the byte size of item (directory or file).
This method may be called by miltiple threads
| |
| DoGetItemSizeAsync |
Async version of DoGetItemSize(FileSystemSessionItem).
This base/default implementation just synchronously calls DoGetItemSize(FileSystemSessionItem) and
returns already completed Task with result returned by DoGetItemSize(FileSystemSessionItem) | |
| DoGetLastAccessTimestamp |
Override to get item last access timestamp.
This method may be called by miltiple threads
| |
| DoGetLastAccessUser |
Override in particular file systems to get user who was the last user accessing the item.
This method may be called by miltiple threads
| |
| DoGetLastAccessUserAsync |
Async version of DoGetLastAccessUser(FileSystemSessionItem).
This base/default implementation just synchronously calls DoGetLastAccessUser(FileSystemSessionItem) and
returns already completed Task with result returned by DoGetLastAccessUser(FileSystemSessionItem) | |
| DoGetLatestVersion |
Override in particular file systems that support versioning to get latest version object that this session can work with.
This method may be called by miltiple threads
| |
| DoGetLatestVersionAsync |
Async version of DoGetLatestVersion(FileSystemSession).
This base/default implementation just synchronously calls DoGetLatestVersion(FileSystemSession) and
returns already completed Task with result returned by DoGetLatestVersion(FileSystemSession) | |
| DoGetMetadataStream |
Override to get metadata stream for item (directory or file).
This method may be called by miltiple threads
| |
| DoGetMetadataStreamAsync |
Async version of DoGetMetadataStream(FileSystemSessionItem, Action FileSystemStream ).
This base/default implementation just synchronously calls DoGetMetadataStream(FileSystemSessionItem, Action FileSystemStream ) and
returns already completed Task with result returned by DoGetMetadataStream(FileSystemSessionItem, Action FileSystemStream ) | |
| DoGetModificationTimestamp |
Override to get item modification timestamp.
This method may be called by miltiple threads
| |
| DoGetModificationUser |
Override in particular file systems to get user who was the last user modifying the item.
This method may be called by miltiple threads
| |
| DoGetModificationUserAsync |
Async version of DoGetModificationUser(FileSystemSessionItem).
This base/default implementation just synchronously calls DoGetModificationUser(FileSystemSessionItem) and
returns already completed Task with result returned by DoGetModificationUser(FileSystemSessionItem) | |
| DoGetPermissionsStream |
Override to get permissions stream for item (directory or file).
This method may be called by miltiple threads
| |
| DoGetPermissionsStreamAsync |
Async version of DoGetPermissionsStream(FileSystemSessionItem, Action FileSystemStream ).
This base/default implementation just synchronously calls DoGetPermissionsStream(FileSystemSessionItem, Action FileSystemStream ) and
returns already completed Task with result returned by DoGetPermissionsStream(FileSystemSessionItem, Action FileSystemStream ) | |
| DoGetReadOnly |
Override to get item readonly status.
This method may be called by miltiple threads
| |
| DoGetSubDirectoryNames |
Override to get subdirectory names of directory. If directory is null then root is assumed.
This method may be called by miltiple threads
| |
| DoGetSubDirectoryNamesAsync |
Async version of DoGetSubDirectoryNames(FileSystemDirectory, Boolean).
This base/default implementation just synchronously calls DoGetSubDirectoryNames(FileSystemDirectory, Boolean) and
returns already completed Task with result returned by DoGetSubDirectoryNames(FileSystemDirectory, Boolean) | |
| DoGetVersion |
Override in particular file systems that support versioning to get version object for session.
This method may be called by miltiple threads
| |
| DoGetVersionAsync |
Async version of DoGetVersion(FileSystemSession).
This base/default implementation just synchronously calls DoGetVersion(FileSystemSession) and
returns already completed Task with result returned by DoGetVersion(FileSystemSession) | |
| DoNavigate |
Override to get file or directory from specified path. Return null if item does not exist.
This method may be called by miltiple threads
| |
| DoNavigateAsync |
Async version of DoNavigate(FileSystemSession, String).
This base/default implementation just synchronously calls DoNavigate(FileSystemSession, String) and
returns already completed Task with result returned by DoNavigate(FileSystemSession, String) | |
| DoReadAsync | ||
| DoRefresh |
Override to refresh item state, i.e. re-fetch remote information.
This method may be called by miltiple threads
| |
| DoRefreshAsync |
Async version of DoRefreshAsync(FileSystemSessionItem).
This base/default implementation just synchronously calls DoRefreshAsync(FileSystemSessionItem) and
returns already completed Task with result returned by DoRefreshAsync(FileSystemSessionItem) | |
| DoRenameItem |
Override to rename item return true on success.
This method may be called by miltiple threads
| |
| DoRenameItemAsync |
Async version of DoRenameItem(FileSystemSessionItem, String).
This base/default implementation just synchronously calls DoRenameItem(FileSystemSessionItem, String) and
returns already completed Task with result returned by DoRenameItem(FileSystemSessionItem, String) | |
| DoRollbackTransaction |
Override in particular file systems that support transactions to rollback transaction in specified session.
This method may be called by miltiple threads
| |
| DoRollbackTransactionAsync |
Async version of DoRollbackTransaction(FileSystemSession).
This base/default implementation just synchronously calls DoRollbackTransaction(FileSystemSession) and
returns already completed Task with result returned by DoRollbackTransaction(FileSystemSession) | |
| DoSetCreationTimestamp |
Override to set item creation timestamp.
This method may be called by miltiple threads
| |
| DoSetCreationTimestampAsync |
Async version of DoSetCreationTimestamp(FileSystemSessionItem, DateTime).
This base/default implementation just synchronously calls DoSetCreationTimestamp(FileSystemSessionItem, DateTime) and
returns already completed Task with result returned by DoSetCreationTimestamp(FileSystemSessionItem, DateTime) | |
| DoSetLastAccessTimestamp |
Override to set item last access timestamp.
This method may be called by miltiple threads
| |
| DoSetLastAccessTimestampAsync |
Async version of DoSetLastAccessTimestamp(FileSystemSessionItem, DateTime).
This base/default implementation just synchronously calls DoSetLastAccessTimestamp(FileSystemSessionItem, DateTime) and
returns already completed Task with result returned by DoSetLastAccessTimestamp(FileSystemSessionItem, DateTime) | |
| DoSetModificationTimestamp |
Override to set item modification timestamp.
This method may be called by miltiple threads
| |
| DoSetModificationTimestampAsync |
Async version of DoSetModificationTimestamp(FileSystemSessionItem, DateTime).
This base/default implementation just synchronously calls DoSetModificationTimestamp(FileSystemSessionItem, DateTime) and
returns already completed Task with result returned by DoSetModificationTimestamp(FileSystemSessionItem, DateTime) | |
| DoSetReadOnly |
Override to set item readonly status.
This method may be called by miltiple threads
| |
| DoSetReadOnlyAsync |
Async version of DoSetReadOnly(FileSystemSessionItem, Boolean).
This base/default implementation just synchronously calls DoSetReadOnly(FileSystemSessionItem, Boolean) and
returns already completed Task with result returned by DoSetReadOnly(FileSystemSessionItem, Boolean) | |
| DoSetVersion |
Override in particular file systems that support versioning to set seesion to specific version.
This method may be called by miltiple threads
| |
| DoSetVersionAsync |
Async version of DoSetVersion(FileSystemSession, IFileSystemVersion).
This base/default implementation just synchronously calls DoSetVersion(FileSystemSession, IFileSystemVersion) and
returns already completed Task with result returned by DoSetVersion(FileSystemSession, IFileSystemVersion) | |
| DoWriteAsync | ||
| EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) | |
Determines whether the specified object is equal to the current object. (Inherited from | ||
| Finalize | (Inherited from DisposableObject.) | |
Serves as the default hash function. (Inherited from | ||
Gets the (Inherited from | ||
| Make TParam (IConfigSectionNode) | ||
| Make TParam (String, String) | ||
| MakeSessionConfigParams | ||
Creates a shallow copy of the current (Inherited from | ||
| StartSession |
Creates a new session for the user. This method is thread-safe, however the returned FileSystemSession object is not.
Every thread must obtain its own session via this method
| |
| ToString | (Overrides |
Extension Methods
Fields
| Name | Description | |
|---|---|---|
| CONFIG_AUTO_START_ATTR | ||
| CONFIG_DEFAULT_SESSION_CONNECT_PARAMS_SECTION | ||
| CONFIG_FILESYSTEM_SECTION | ||
| CONFIG_FILESYSTEMS_SECTION | ||
| CONFIG_NAME_ATTR | ||
| m_Name | ||
| m_Sessions |
Properties
| Name | Description | |
|---|---|---|
| ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.) | |
| ComponentDirector |
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.) | |
| ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) | |
| ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) | |
| DefaultSessionConnectParams | ||
| Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) | |
| DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) | |
| GeneralCapabilities |
Returns capabilities for this file system in general
| |
| InstanceCapabilities |
Returns capabilities for this file system instance, that may or may not be the same as GeneralCapabilities
| |
| Instances |
Returns the read-only registry view of file systems currently activated
| |
| Name |
Provides name for file system instance
| |
| Sessions |
Returns a list of sessions. This accessor is thread-safe
|
See Also