ZipStorageProvider Class

Represents virtual storage provider over zip file.

Inheritance Hierarchy

System.Object
  CMS.IO.AbstractStorageProvider
    CMS.IO.ZipStorageProvider

Namespace: CMS.IO
Assembly: CMS.IO (in CMS.IO.dll) Version: 13.0.131

Syntax

public class ZipStorageProvider : AbstractStorageProvider, 
	IDisposable

The ZipStorageProvider type exposes the following members.

Constructors

	Name	Description
Public method	ZipStorageProvider	Constructor

Fields

	Name	Description
Public field Static member	ZIP_END	Ending character for the zip archive within path
Public field Static member	ZIP_START	Starting character for the zip archive within path

Properties

	Name	Description
Public property	CacheData	If true, the loaded data is cached
Public property	CacheDataLimit	Limit size for the caching of the file data (bytes)
Public property	CustomRootPath	Gets or sets Custom path where files should be stored. (Inherited from AbstractStorageProvider.)
Public property	DirectoryProviderObject	Returns CMSDirectoryProvider object. (Inherited from AbstractStorageProvider.)
Public property	ExternalStorageName	Returns name of external storage (if current instance running on external storage). (Inherited from AbstractStorageProvider.)
Public property	FilePath	Zip file path
Public property	FileProviderObject	Returns AbstractFile object. (Inherited from AbstractStorageProvider.)
Public property	HasCustomRootPath	Returns whether provider has custom root path. (Inherited from AbstractStorageProvider.)
Public property	IsExternalStorage	Returns whether current instance is running on external storage. (Inherited from AbstractStorageProvider.)
Public property	IsSharedStorage	Gets or sets a value indicating whether current instance is running on shared storage. (Inherited from AbstractStorageProvider.)
Protected property	MappedPath	Mapped path (Inherited from AbstractStorageProvider.)
Public property	Name	Provider name (Overrides AbstractStorageProvider.Name.)
Protected property	ParentStorageProvider	Parent storage provider (Inherited from AbstractStorageProvider.)
Protected property	ProviderAssembly	Custom Provider library assembly. (Inherited from AbstractStorageProvider.)
Protected property	ProviderAssemblyName	Custom Provider library assembly. (Inherited from AbstractStorageProvider.)
Public property	PublicExternalFolderObject	Gets or sets whether external storage folder object (i.e. Container for WA blob storage) has public access or not. (Inherited from AbstractStorageProvider.)
Public property	RootDirectory	Root directory
Public property	ZipFile	Zip file info object

Methods

	Name	Description
Protected method	CreateDirectoryProviderObject	Creates new directory provider object (Overrides AbstractStorageProvider.CreateDirectoryProviderObject().)
Protected method	CreateFileProviderObject	Creates new directory provider object (Overrides AbstractStorageProvider.CreateFileProviderObject().)
Public method	Dispose()	Releases all resources used by the current instance of the ZipStorageProvider class.
Protected method	Dispose(Boolean)	Releases the unmanaged resources used by the current instance of the ZipStorageProvider class, and optionally releases the managed resources.
Public method Static member	Dispose(String)	Disposes the storage provider for the given path
Public method Static member	DisposeAll	Disposes the zip storage providers
Public method	GetDirectoryInfo	Returns new instance of directory info. (Overrides AbstractStorageProvider.GetDirectoryInfo(String).)
Public method	GetFileData	Gets the particular file data
Public method	GetFileInfo	Returns new instance of FileInfo object. (Overrides AbstractStorageProvider.GetFileInfo(String).)
Public method	GetFileStream(String)	Gets a file stream for the given file
Public method	GetFileStream(String, FileMode)	Returns new instance of file stream. (Overrides AbstractStorageProvider.GetFileStream(String, FileMode).)
Public method	GetFileStream(String, FileMode, FileAccess)	Returns new instance of file stream. (Overrides AbstractStorageProvider.GetFileStream(String, FileMode, FileAccess).)
Public method	GetFileStream(String, FileMode, FileAccess, FileShare)	Returns new instance of file stream. (Overrides AbstractStorageProvider.GetFileStream(String, FileMode, FileAccess, FileShare).)
Public method	GetFileStream(String, FileMode, FileAccess, FileShare, Int32)	Returns new instance of file stream. (Overrides AbstractStorageProvider.GetFileStream(String, FileMode, FileAccess, FileShare, Int32).)
Protected method	GetFullPath	Converts the external mapped path to the internal path of the provider (Inherited from AbstractStorageProvider.)
Protected method	GetInternalProvider	Gets the storage provider based on the given path. (Inherited from AbstractStorageProvider.)
Protected method	GetStorageProviderInternal	Gets the storage provider based on the given path. (Inherited from AbstractStorageProvider.)
Public method Static member	GetZipFileName	Gets the zip file name with the container brackets
Public method Static member	IsZipFile	Returns true if the given file path is a zip file
Public method Static member	IsZipFolderPath	Gets the zip file path from the given zip folder path. Returns null if the path isn't a zip folder path
Protected method	LoadContents	Loads the contents of the zip file
Public method	MapStoragePath	Maps the given storage path to a specific provider (Inherited from AbstractStorageProvider.)
Protected method	RemoveMappedProvider	Removes a mapped provider from the mapped collection (Inherited from AbstractStorageProvider.)
Public method	UnMapStoragePath	Removes the mapping to a storage provider (Inherited from AbstractStorageProvider.)

Remarks

Provider is read-only virtual file system, allowing to get files as ZipFileStream.