Show / Hide Table of Contents

Class LocalFileSystem

Implements NFX.IO.FileSystem support around local machine file system. This is needed for components that may need to work with various file systems i.e. Apache HDFS or Aum Cluster File System (ACFS). This particular implementation uses traditional System.IO.* and does not support transactions, versioning, metadata and NFX security

Inheritance
System.Object
DisposableObject
ApplicationComponent
FileSystem
LocalFileSystem
Implements
IFileSystemImplementation
IFileSystem
IApplicationComponent
INamed
System.IDisposable
IConfigurable
Inherited Members
FileSystem.CONFIG_FILESYSTEMS_SECTION
FileSystem.CONFIG_FILESYSTEM_SECTION
FileSystem.CONFIG_AUTO_START_ATTR
FileSystem.CONFIG_NAME_ATTR
FileSystem.CONFIG_DEFAULT_SESSION_CONNECT_PARAMS_SECTION
FileSystem.Instances
FileSystem.AutoStartSystems()
FileSystem.Make<TParam>(IConfigSectionNode)
FileSystem.Make<TParam>(String, String)
FileSystem.Destructor()
FileSystem.m_Name
FileSystem.m_Sessions
FileSystem.Name
FileSystem.Sessions
FileSystem.Configure(IConfigSectionNode)
FileSystem.CombinePaths(String, String[])
FileSystem.ToString()
FileSystem.DefaultSessionConnectParams
FileSystem.DoConfigure(IConfigSectionNode)
FileSystem.MakeSessionConfigParams(IConfigSectionNode)
FileSystem.DoCheckCanChange(FileSystemSessionItem)
FileSystem.DoCheckCanChangeAsync(FileSystemSessionItem)
FileSystem.DoGetLatestVersion(FileSystemSession)
FileSystem.DoGetLatestVersionAsync(FileSystemSession)
FileSystem.DoGetVersion(FileSystemSession)
FileSystem.DoGetVersionAsync(FileSystemSession)
FileSystem.DoSetVersion(FileSystemSession, IFileSystemVersion)
FileSystem.DoSetVersionAsync(FileSystemSession, IFileSystemVersion)
FileSystem.DoBeginTransaction(FileSystemSession)
FileSystem.DoBeginTransactionAsync(FileSystemSession)
FileSystem.DoCommitTransaction(FileSystemSession)
FileSystem.DoCommitTransactionAsync(FileSystemSession)
FileSystem.DoRollbackTransaction(FileSystemSession)
FileSystem.DoRollbackTransactionAsync(FileSystemSession)
FileSystem.DoRefreshAsync(FileSystemSessionItem)
FileSystem.DoGetSubDirectoryNamesAsync(FileSystemDirectory, Boolean)
FileSystem.DoGetFileNamesAsync(FileSystemDirectory, Boolean)
FileSystem.DoNavigateAsync(FileSystemSession, String)
FileSystem.DoRenameItemAsync(FileSystemSessionItem, String)
FileSystem.DoDeleteItemAsync(FileSystemSessionItem)
FileSystem.DoCreateFileAsync(FileSystemDirectory, String, Int32)
FileSystem.DoCreateFileAsync(FileSystemDirectory, String, String, Boolean)
FileSystem.DoCreateDirectoryAsync(FileSystemDirectory, String)
FileSystem.DoDirectoryDeepCopyAsync(FileSystemDirectory, FileSystemDirectory, FileSystemDirectory.DirCopyFlags, Int32, Func<FileSystemSessionItem, Boolean>, Func<FileSystemSessionItem, Boolean>)
FileSystem.DoGetItemSizeAsync(FileSystemSessionItem)
FileSystem.DoGetPermissionsStreamAsync(FileSystemSessionItem, Action<FileSystemStream>)
FileSystem.DoGetMetadataStreamAsync(FileSystemSessionItem, Action<FileSystemStream>)
FileSystem.DoGetFileStreamAsync(FileSystemFile, Action<FileSystemStream>)
FileSystem.DoSetCreationTimestampAsync(FileSystemSessionItem, DateTime)
FileSystem.DoSetModificationTimestampAsync(FileSystemSessionItem, DateTime)
FileSystem.DoSetLastAccessTimestampAsync(FileSystemSessionItem, DateTime)
FileSystem.DoSetReadOnlyAsync(FileSystemSessionItem, Boolean)
FileSystem.DoGetCreationUser(FileSystemSessionItem)
FileSystem.DoGetCreationUserAsync(FileSystemSessionItem)
FileSystem.DoGetModificationUser(FileSystemSessionItem)
FileSystem.DoGetModificationUserAsync(FileSystemSessionItem)
FileSystem.DoGetLastAccessUser(FileSystemSessionItem)
FileSystem.DoGetLastAccessUserAsync(FileSystemSessionItem)
FileSystem.DoFlushAsync(FileSystemStream, CancellationToken)
FileSystem.DoReadAsync(FileSystemStream, Byte[], Int32, Int32, CancellationToken)
FileSystem.DoWriteAsync(FileSystemStream, Byte[], Int32, Int32, CancellationToken)
ApplicationComponent.AllComponents
ApplicationComponent.GetAppComponentBySID(UInt64)
ApplicationComponent.GetAppComponentByCommonName(String)
ApplicationComponent.ComponentSID
ApplicationComponent.ComponentStartTime
ApplicationComponent.ComponentDirector
DisposableObject.DisposeAndNull<T>(T)
DisposableObject.DisposeStarted
DisposableObject.Disposed
DisposableObject.EnsureObjectNotDisposed()
DisposableObject.Dispose()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: NFX.IO.FileSystem.Local
Assembly: NFX.dll
Syntax
public sealed class LocalFileSystem : FileSystem, IFileSystemImplementation, IFileSystem, IApplicationComponent, INamed, IDisposable, IConfigurable

Constructors

LocalFileSystem()

Declaration
public LocalFileSystem()

LocalFileSystem(String, IConfigSectionNode)

Declaration
public LocalFileSystem(string name, IConfigSectionNode node = null)
Parameters
Type Name Description
System.String name
IConfigSectionNode node

Properties

ComponentCommonName

Declaration
public override string ComponentCommonName { get; }
Property Value
Type Description
System.String
Overrides
ApplicationComponent.ComponentCommonName

GeneralCapabilities

Declaration
public override IFileSystemCapabilities GeneralCapabilities { get; }
Property Value
Type Description
IFileSystemCapabilities
Overrides
FileSystem.GeneralCapabilities

InstanceCapabilities

Declaration
public override IFileSystemCapabilities InstanceCapabilities { get; }
Property Value
Type Description
IFileSystemCapabilities
Overrides
FileSystem.InstanceCapabilities

Methods

DoCreateDirectory(FileSystemDirectory, String)

Declaration
protected override FileSystemDirectory DoCreateDirectory(FileSystemDirectory dir, string name)
Parameters
Type Name Description
FileSystemDirectory dir
System.String name
Returns
Type Description
FileSystemDirectory
Overrides
FileSystem.DoCreateDirectory(FileSystemDirectory, String)

DoCreateFile(FileSystemDirectory, String, Int32)

Declaration
protected override FileSystemFile DoCreateFile(FileSystemDirectory dir, string name, int size)
Parameters
Type Name Description
FileSystemDirectory dir
System.String name
System.Int32 size
Returns
Type Description
FileSystemFile
Overrides
FileSystem.DoCreateFile(FileSystemDirectory, String, Int32)

DoCreateFile(FileSystemDirectory, String, String, Boolean)

Declaration
protected override FileSystemFile DoCreateFile(FileSystemDirectory dir, string name, string localFile, bool readOnly)
Parameters
Type Name Description
FileSystemDirectory dir
System.String name
System.String localFile
System.Boolean readOnly
Returns
Type Description
FileSystemFile
Overrides
FileSystem.DoCreateFile(FileSystemDirectory, String, String, Boolean)

DoDeleteItem(FileSystemSessionItem)

Declaration
protected override void DoDeleteItem(FileSystemSessionItem item)
Parameters
Type Name Description
FileSystemSessionItem item
Overrides
FileSystem.DoDeleteItem(FileSystemSessionItem)

DoGetCreationTimestamp(FileSystemSessionItem)

Declaration
protected override DateTime? DoGetCreationTimestamp(FileSystemSessionItem item)
Parameters
Type Name Description
FileSystemSessionItem item
Returns
Type Description
System.Nullable<System.DateTime>
Overrides
FileSystem.DoGetCreationTimestamp(FileSystemSessionItem)

DoGetFileNames(FileSystemDirectory, Boolean)

Declaration
protected override IEnumerable<string> DoGetFileNames(FileSystemDirectory directory, bool recursive)
Parameters
Type Name Description
FileSystemDirectory directory
System.Boolean recursive
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>
Overrides
FileSystem.DoGetFileNames(FileSystemDirectory, Boolean)

DoGetFileStream(FileSystemFile, Action<FileSystemStream>)

Declaration
protected override FileSystemStream DoGetFileStream(FileSystemFile file, Action<FileSystemStream> disposeAction)
Parameters
Type Name Description
FileSystemFile file
System.Action<FileSystemStream> disposeAction
Returns
Type Description
FileSystemStream
Overrides
FileSystem.DoGetFileStream(FileSystemFile, Action<FileSystemStream>)

DoGetItemSize(FileSystemSessionItem)

Declaration
protected override ulong DoGetItemSize(FileSystemSessionItem item)
Parameters
Type Name Description
FileSystemSessionItem item
Returns
Type Description
System.UInt64
Overrides
FileSystem.DoGetItemSize(FileSystemSessionItem)

DoGetLastAccessTimestamp(FileSystemSessionItem)

Declaration
protected override DateTime? DoGetLastAccessTimestamp(FileSystemSessionItem item)
Parameters
Type Name Description
FileSystemSessionItem item
Returns
Type Description
System.Nullable<System.DateTime>
Overrides
FileSystem.DoGetLastAccessTimestamp(FileSystemSessionItem)

DoGetMetadataStream(FileSystemSessionItem, Action<FileSystemStream>)

Declaration
protected override FileSystemStream DoGetMetadataStream(FileSystemSessionItem item, Action<FileSystemStream> disposeAction)
Parameters
Type Name Description
FileSystemSessionItem item
System.Action<FileSystemStream> disposeAction
Returns
Type Description
FileSystemStream
Overrides
FileSystem.DoGetMetadataStream(FileSystemSessionItem, Action<FileSystemStream>)

DoGetModificationTimestamp(FileSystemSessionItem)

Declaration
protected override DateTime? DoGetModificationTimestamp(FileSystemSessionItem item)
Parameters
Type Name Description
FileSystemSessionItem item
Returns
Type Description
System.Nullable<System.DateTime>
Overrides
FileSystem.DoGetModificationTimestamp(FileSystemSessionItem)

DoGetPermissionsStream(FileSystemSessionItem, Action<FileSystemStream>)

Declaration
protected override FileSystemStream DoGetPermissionsStream(FileSystemSessionItem item, Action<FileSystemStream> disposeAction)
Parameters
Type Name Description
FileSystemSessionItem item
System.Action<FileSystemStream> disposeAction
Returns
Type Description
FileSystemStream
Overrides
FileSystem.DoGetPermissionsStream(FileSystemSessionItem, Action<FileSystemStream>)

DoGetReadOnly(FileSystemSessionItem)

Declaration
protected override bool DoGetReadOnly(FileSystemSessionItem item)
Parameters
Type Name Description
FileSystemSessionItem item
Returns
Type Description
System.Boolean
Overrides
FileSystem.DoGetReadOnly(FileSystemSessionItem)

DoGetSubDirectoryNames(FileSystemDirectory, Boolean)

Declaration
protected override IEnumerable<string> DoGetSubDirectoryNames(FileSystemDirectory directory, bool recursive)
Parameters
Type Name Description
FileSystemDirectory directory
System.Boolean recursive
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>
Overrides
FileSystem.DoGetSubDirectoryNames(FileSystemDirectory, Boolean)

DoNavigate(FileSystemSession, String)

Declaration
protected override FileSystemSessionItem DoNavigate(FileSystemSession session, string path)
Parameters
Type Name Description
FileSystemSession session
System.String path
Returns
Type Description
FileSystemSessionItem
Overrides
FileSystem.DoNavigate(FileSystemSession, String)

DoRefresh(FileSystemSessionItem)

Declaration
protected override void DoRefresh(FileSystemSessionItem item)
Parameters
Type Name Description
FileSystemSessionItem item
Overrides
FileSystem.DoRefresh(FileSystemSessionItem)

DoRenameItem(FileSystemSessionItem, String)

Declaration
protected override bool DoRenameItem(FileSystemSessionItem item, string newName)
Parameters
Type Name Description
FileSystemSessionItem item
System.String newName
Returns
Type Description
System.Boolean
Overrides
FileSystem.DoRenameItem(FileSystemSessionItem, String)

DoSetCreationTimestamp(FileSystemSessionItem, DateTime)

Declaration
protected override void DoSetCreationTimestamp(FileSystemSessionItem item, DateTime timestamp)
Parameters
Type Name Description
FileSystemSessionItem item
System.DateTime timestamp
Overrides
FileSystem.DoSetCreationTimestamp(FileSystemSessionItem, DateTime)

DoSetLastAccessTimestamp(FileSystemSessionItem, DateTime)

Declaration
protected override void DoSetLastAccessTimestamp(FileSystemSessionItem item, DateTime timestamp)
Parameters
Type Name Description
FileSystemSessionItem item
System.DateTime timestamp
Overrides
FileSystem.DoSetLastAccessTimestamp(FileSystemSessionItem, DateTime)

DoSetModificationTimestamp(FileSystemSessionItem, DateTime)

Declaration
protected override void DoSetModificationTimestamp(FileSystemSessionItem item, DateTime timestamp)
Parameters
Type Name Description
FileSystemSessionItem item
System.DateTime timestamp
Overrides
FileSystem.DoSetModificationTimestamp(FileSystemSessionItem, DateTime)

DoSetReadOnly(FileSystemSessionItem, Boolean)

Declaration
protected override void DoSetReadOnly(FileSystemSessionItem item, bool readOnly)
Parameters
Type Name Description
FileSystemSessionItem item
System.Boolean readOnly
Overrides
FileSystem.DoSetReadOnly(FileSystemSessionItem, Boolean)

StartSession(FileSystemSessionConnectParams)

Declaration
public override FileSystemSession StartSession(FileSystemSessionConnectParams cParams = null)
Parameters
Type Name Description
FileSystemSessionConnectParams cParams
Returns
Type Description
FileSystemSession
Overrides
FileSystem.StartSession(FileSystemSessionConnectParams)

Implements

IFileSystemImplementation
IFileSystem
IApplicationComponent
INamed
System.IDisposable
IConfigurable

Extension Methods

MiscUtils.NonNull<T>(T, Func<Exception>, String)
ObjectValueConversion.AsString(Object, String, ConvertErrorHandling)
ObjectValueConversion.AsNonNullOrEmptyString(Object)
ObjectValueConversion.AsLaconicConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsJSONConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsXMLConfig(Object, ConfigSectionNode, ConvertErrorHandling)
ObjectValueConversion.AsChar(Object, Char, ConvertErrorHandling)
ObjectValueConversion.AsNullableChar(Object, Nullable<Char>, ConvertErrorHandling)
ObjectValueConversion.AsByte(Object, Byte, ConvertErrorHandling)
ObjectValueConversion.AsNullableByte(Object, Nullable<Byte>, ConvertErrorHandling)
ObjectValueConversion.AsSByte(Object, SByte, ConvertErrorHandling)
ObjectValueConversion.AsNullableSByte(Object, Nullable<SByte>, ConvertErrorHandling)
ObjectValueConversion.AsShort(Object, Int16, ConvertErrorHandling)
ObjectValueConversion.AsNullableShort(Object, Nullable<Int16>, ConvertErrorHandling)
ObjectValueConversion.AsUShort(Object, UInt16, ConvertErrorHandling)
ObjectValueConversion.AsNullableUShort(Object, Nullable<UInt16>, ConvertErrorHandling)
ObjectValueConversion.AsInt(Object, Int32, ConvertErrorHandling)
ObjectValueConversion.AsNullableInt(Object, Nullable<Int32>, ConvertErrorHandling)
ObjectValueConversion.AsUInt(Object, UInt32, ConvertErrorHandling)
ObjectValueConversion.AsNullableUInt(Object, Nullable<UInt32>, ConvertErrorHandling)
ObjectValueConversion.AsLong(Object, Int64, ConvertErrorHandling)
ObjectValueConversion.AsNullableLong(Object, Nullable<Int64>, ConvertErrorHandling)
ObjectValueConversion.AsULong(Object, UInt64, ConvertErrorHandling)
ObjectValueConversion.AsNullableULong(Object, Nullable<UInt64>, ConvertErrorHandling)
ObjectValueConversion.AsDouble(Object, Double, ConvertErrorHandling)
ObjectValueConversion.AsNullableDouble(Object, Nullable<Double>, ConvertErrorHandling)
ObjectValueConversion.AsFloat(Object, Single, ConvertErrorHandling)
ObjectValueConversion.AsNullableFloat(Object, Nullable<Single>, ConvertErrorHandling)
ObjectValueConversion.AsDecimal(Object, Decimal, ConvertErrorHandling)
ObjectValueConversion.AsNullableDecimal(Object, Nullable<Decimal>, ConvertErrorHandling)
ObjectValueConversion.AsBool(Object, Boolean, ConvertErrorHandling)
ObjectValueConversion.AsNullableBool(Object, Nullable<Boolean>, ConvertErrorHandling)
ObjectValueConversion.AsGUID(Object, Guid, ConvertErrorHandling)
ObjectValueConversion.AsNullableGUID(Object, Nullable<Guid>, ConvertErrorHandling)
ObjectValueConversion.AsDateTime(Object)
ObjectValueConversion.AsDateTime(Object, DateTime, ConvertErrorHandling)
ObjectValueConversion.AsNullableDateTime(Object, Nullable<DateTime>, ConvertErrorHandling)
ObjectValueConversion.AsGDID(Object)
ObjectValueConversion.AsGDID(Object, GDID, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDID(Object, Nullable<GDID>, ConvertErrorHandling)
ObjectValueConversion.AsGDIDSymbol(Object)
ObjectValueConversion.AsGDIDSymbol(Object, GDIDSymbol, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDIDSymbol(Object, Nullable<GDIDSymbol>, ConvertErrorHandling)
ObjectValueConversion.AsTimeSpan(Object)
ObjectValueConversion.AsTimeSpan(Object, TimeSpan, ConvertErrorHandling)
ObjectValueConversion.AsNullableTimeSpan(Object, Nullable<TimeSpan>, ConvertErrorHandling)
ObjectValueConversion.AsEnum<TEnum>(Object, TEnum, ConvertErrorHandling)
ObjectValueConversion.AsNullableEnum<TEnum>(Object, Nullable<TEnum>, ConvertErrorHandling)
ObjectValueConversion.AsUri(Object, Uri, ConvertErrorHandling)
JSONExtensions.ToJSON(Object, JSONWritingOptions)
JSONExtensions.ToJSON(Object, TextWriter, JSONWritingOptions)
JSONExtensions.ToJSON(Object, Stream, JSONWritingOptions, Encoding)
ErlObject.ToErlObject(Object)
ErlObject.ToErlObject(Object, ErlTypeOrder, Boolean)
Back to top Copyright © 2006-2018 Agnicore Inc
Generated by DocFX