Class StorageProvider

Namespace

CMS.IO

Assembly

CMS.IO.dll

Storage provider

public class StorageProvider : AbstractStorageProvider

Inheritance

object

AbstractStorageProvider

StorageProvider

Inherited Members

AbstractStorageProvider.DIRECTORY_INFO

AbstractStorageProvider.DIRECTORY

AbstractStorageProvider.FILE_INFO

AbstractStorageProvider.FILE

AbstractStorageProvider.FILE_STREAM

AbstractStorageProvider.DIRECTORY_LOCK

AbstractStorageProvider.GetInternalProvider(string)

AbstractStorageProvider.GetStorageProviderInternal(string)

AbstractStorageProvider.GetFullPath(string)

AbstractStorageProvider.UnMapStoragePath(string)

AbstractStorageProvider.RemoveMappedProvider(string)

AbstractStorageProvider.GetVirtualPhysicalPath(AbstractStorageProvider, string)

AbstractStorageProvider.GetTargetPhysicalPath(string)

AbstractStorageProvider.Name

AbstractStorageProvider.ExternalStorageName

AbstractStorageProvider.IsExternalStorage

AbstractStorageProvider.IsSharedStorage

AbstractStorageProvider.DirectoryProviderObject

AbstractStorageProvider.FileProviderObject

AbstractStorageProvider.CustomRootPath

AbstractStorageProvider.HasCustomRootPath

AbstractStorageProvider.PublicExternalFolderObject

AbstractStorageProvider.ParentStorageProvider

AbstractStorageProvider.MappedPath

AbstractStorageProvider.ProviderAssemblyName

AbstractStorageProvider.ProviderAssembly

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

StorageProvider(string, string, bool)

Creates new instance of custom storage provider.

public StorageProvider(string externalStorageName, string providerAssemblyName, bool isSharedStorage)

Parameters

externalStorageName string

External storage name. If used path translation to URL must be set explicitly. Use empty string if storage provider is working under application root.

providerAssemblyName string

Provider assembly name with required implementations.

isSharedStorage bool

Indicates whether the storage is shared between multiple instances.

Methods

CreateAmazonStorageProvider()

Creates new instance of storage provider for files hosted in Amazon S3 cloud storage.

[Obsolete("Use Kentico.Xperience.AmazonStorage.AmazonStorageProvider.Create() instead.", true)]
public static StorageProvider CreateAmazonStorageProvider()

Returns

StorageProvider

CreateAzureStorageProvider()

Creates new instance of storage provider for files hosted in Azure cloud storage.

[Obsolete("Use Kentico.Xperience.AzureStorage.AzureStorageProvider.Create() instead.", true)]
public static StorageProvider CreateAzureStorageProvider()

Returns

StorageProvider

CreateDirectoryProviderObject()

Creates new directory provider object

protected override AbstractDirectory CreateDirectoryProviderObject()

Returns

AbstractDirectory

CreateFileProviderObject()

Creates new directory provider object

protected override AbstractFile CreateFileProviderObject()

Returns

AbstractFile

CreateFileSystemStorageProvider(bool)

Creates new instance of storage provider for System.IO file system.

public static StorageProvider CreateFileSystemStorageProvider(bool isSharedStorage = false)

Parameters

isSharedStorage bool

Indicates whether the storage is shared between web farm servers.

Returns

StorageProvider

GetDirectoryInfo(string)

Returns new instance of directory info.

public override DirectoryInfo GetDirectoryInfo(string path)

Parameters

path string

Path

Returns

DirectoryInfo

GetFileInfo(string)

Returns new instance of FileInfo object.

public override FileInfo GetFileInfo(string fileName)

Parameters

fileName string

File name

Returns

FileInfo

GetFileStream(string, FileMode)

Returns new instance of file stream.

public override FileStream GetFileStream(string path, FileMode mode)

Parameters

path string

Path to file

mode FileMode

File mode

Returns

FileStream

GetFileStream(string, FileMode, FileAccess)

Returns new instance of file stream.

public override FileStream GetFileStream(string path, FileMode mode, FileAccess access)

Parameters

path string

Path to file

mode FileMode

File mode

access FileAccess

File access

Returns

FileStream

GetFileStream(string, FileMode, FileAccess, FileShare)

Returns new instance of file stream.

public override FileStream GetFileStream(string path, FileMode mode, FileAccess access, FileShare share)

Parameters

path string

Path to file

mode FileMode

File mode

access FileAccess

File access

share FileShare

Sharing permissions

Returns

FileStream

GetFileStream(string, FileMode, FileAccess, FileShare, int)

Returns new instance of file stream.

public override FileStream GetFileStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize)

Parameters

path string

Path to file

mode FileMode

File mode

access FileAccess

File access

share FileShare

Sharing permissions

bufferSize int

Buffer size

Returns

FileStream