Class BaseRemoteStorageProvider

Base class that provides common functionality to work with files and folders.

Inheritance
System.Object
FolderProvider
BaseRemoteStorageProvider
AzureFolderProvider
Inherited Members
Namespace: DotNetNuke.Providers.FolderProviders.Components
Assembly: DotNetNuke.Providers.FolderProviders.dll
Syntax
public abstract class BaseRemoteStorageProvider : FolderProvider

Properties

| Improve this Doc View Source

FileNotFoundMessage

Base class that provides common functionality to work with files and folders.

Declaration
protected virtual string FileNotFoundMessage { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ListObjectsCacheKey

Base class that provides common functionality to work with files and folders.

Declaration
protected virtual string ListObjectsCacheKey { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ListObjectsCacheTimeout

Base class that provides common functionality to work with files and folders.

Declaration
protected virtual int ListObjectsCacheTimeout { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ObjectCacheKey

Base class that provides common functionality to work with files and folders.

Declaration
protected virtual string ObjectCacheKey { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ObjectCacheTimeout

Base class that provides common functionality to work with files and folders.

Declaration
protected virtual int ObjectCacheTimeout { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SupportsMappedPaths

Gets a value indicating whether indicates if the folder provider supports mapped paths when creating new folders.

Declaration
public override bool SupportsMappedPaths { get; }
Property Value
Type Description
System.Boolean
Overrides
Remarks

If this method is not overridden it returns false.

| Improve this Doc View Source

SupportsMoveFile

Gets a value indicating whether the provider supports the MoveFile(IFileInfo, IFolderInfo) method. If a provider supports the MoveFile(IFileInfo, IFolderInfo) method, the folder manager does not have to implement move by copying the file and then deleting the original.

Declaration
public override bool SupportsMoveFile { get; }
Property Value
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

SupportsMoveFolder

Gets a value indicating whether the provider supports the MoveFolder(String, String, FolderMappingInfo) method. If a provider supports the MoveFolder(String, String, FolderMappingInfo) method, the folder manager does not have to implement move by copying the folder and then deleting the original.

Declaration
public override bool SupportsMoveFolder { get; }
Property Value
Type Description
System.Boolean
Overrides

Methods

| Improve this Doc View Source

AddFile(IFolderInfo, String, Stream)

Base class that provides common functionality to work with files and folders.

Declaration
public override void AddFile(IFolderInfo folder, string fileName, Stream content)
Parameters
Type Name Description
IFolderInfo folder
System.String fileName
Stream content
| Improve this Doc View Source

AddFolder(String, FolderMappingInfo)

Adds a new folder to a specified parent folder.

Declaration
public override void AddFolder(string folderPath, FolderMappingInfo folderMapping)
Parameters
Type Name Description
System.String folderPath
FolderMappingInfo folderMapping
Overrides
| Improve this Doc View Source

ClearCache(Int32)

Base class that provides common functionality to work with files and folders.

Declaration
public virtual void ClearCache(int folderMappingId)
Parameters
Type Name Description
System.Int32 folderMappingId
| Improve this Doc View Source

CopyFile(String, String, String, FolderMappingInfo)

Copies the specified file to the destination folder.

Declaration
public override void CopyFile(string folderPath, string fileName, string newFolderPath, FolderMappingInfo folderMapping)
Parameters
Type Name Description
System.String folderPath
System.String fileName
System.String newFolderPath
FolderMappingInfo folderMapping
Overrides
| Improve this Doc View Source

CopyFileInternal(FolderMappingInfo, String, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected abstract void CopyFileInternal(FolderMappingInfo folderMapping, string sourceUri, string newUri)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String sourceUri
System.String newUri
| Improve this Doc View Source

DeleteFile(IFileInfo)

Deletes the specified file.

Declaration
public override void DeleteFile(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Overrides
| Improve this Doc View Source

DeleteFileInternal(FolderMappingInfo, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected abstract void DeleteFileInternal(FolderMappingInfo folderMapping, string uri)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String uri
| Improve this Doc View Source

DeleteFolder(IFolderInfo)

Deletes the specified folder.

Declaration
public override void DeleteFolder(IFolderInfo folder)
Parameters
Type Name Description
IFolderInfo folder
Overrides
Remarks

Azure Storage doesn't support folders, but we need to delete the file added while creating the folder.

| Improve this Doc View Source

DeleteFolderInternal(FolderMappingInfo, IFolderInfo)

Base class that provides common functionality to work with files and folders.

Declaration
protected abstract void DeleteFolderInternal(FolderMappingInfo folderMapping, IFolderInfo folder)
Parameters
Type Name Description
FolderMappingInfo folderMapping
IFolderInfo folder
| Improve this Doc View Source

FileExists(IFolderInfo, String)

Checks the existence of the specified file in the underlying system.

Declaration
public override bool FileExists(IFolderInfo folder, string fileName)
Parameters
Type Name Description
IFolderInfo folder
System.String fileName
Returns
Type Description
System.Boolean

true if the file exists, otherwise false.
Overrides
| Improve this Doc View Source

FolderExists(String, FolderMappingInfo)

Checks the existence of the specified folder in the underlying system.

Declaration
public override bool FolderExists(string folderPath, FolderMappingInfo folderMapping)
Parameters
Type Name Description
System.String folderPath
FolderMappingInfo folderMapping
Returns
Type Description
System.Boolean

true if the folder exists, otherwise false.
Overrides
| Improve this Doc View Source

GetBooleanSetting(FolderMappingInfo, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected static bool GetBooleanSetting(FolderMappingInfo folderMapping, string settingName)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String settingName
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetFileAttributes(IFileInfo)

Gets the file attributes of the specified file.

Declaration
public override FileAttributes? GetFileAttributes(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
System.Nullable<FileAttributes>

The file attributes or null.
Overrides
Remarks

Amazon doesn't support file attributes.

| Improve this Doc View Source

GetFiles(IFolderInfo)

Gets the list of file names contained in the specified folder.

Declaration
public override string[] GetFiles(IFolderInfo folder)
Parameters
Type Name Description
IFolderInfo folder
Returns
Type Description
System.String[]

An array of file names.
Overrides
| Improve this Doc View Source

GetFileSize(IFileInfo)

Gets the file length.

Declaration
public override long GetFileSize(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
System.Int64

The file size.
Overrides
| Improve this Doc View Source

GetFileStream(IFileInfo)

Gets a file Stream of the specified file.

Declaration
public override Stream GetFileStream(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
Stream

A of the file contents.
Overrides
| Improve this Doc View Source

GetFileStream(IFolderInfo, String)

Gets a file Stream of the specified file.

Declaration
public override Stream GetFileStream(IFolderInfo folder, string fileName)
Parameters
Type Name Description
IFolderInfo folder
System.String fileName
Returns
Type Description
Stream

A of the file contents.
Overrides
| Improve this Doc View Source

GetFileStreamInternal(FolderMappingInfo, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected abstract Stream GetFileStreamInternal(FolderMappingInfo folderMapping, string uri)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String uri
Returns
Type Description
Stream
| Improve this Doc View Source

GetHashCode(IFileInfo, Stream)

Base class that provides common functionality to work with files and folders.

Declaration
public override string GetHashCode(IFileInfo file, Stream fileContent)
Parameters
Type Name Description
IFileInfo file
Stream fileContent
Returns
Type Description
System.String
| Improve this Doc View Source

GetHashCode(IFileInfo)

Base class that provides common functionality to work with files and folders.

Declaration
public override string GetHashCode(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
System.String
Overrides
| Improve this Doc View Source

GetIntegerSetting(FolderMappingInfo, String, Int32)

Base class that provides common functionality to work with files and folders.

Declaration
protected static int GetIntegerSetting(FolderMappingInfo folderMapping, string settingName, int defaultValue)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String settingName
System.Int32 defaultValue
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetLastModificationTime(IFileInfo)

Gets the time when the specified file was last modified.

Declaration
public override DateTime GetLastModificationTime(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
DateTime

The last modified .
Overrides
| Improve this Doc View Source

GetObjectList(FolderMappingInfo, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected virtual IList<IRemoteStorageItem> GetObjectList(FolderMappingInfo folderMapping, string path)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String path
Returns
Type Description
IList<IRemoteStorageItem>
| Improve this Doc View Source

GetObjectList(FolderMappingInfo)

Base class that provides common functionality to work with files and folders.

Declaration
protected abstract IList<IRemoteStorageItem> GetObjectList(FolderMappingInfo folderMapping)
Parameters
Type Name Description
FolderMappingInfo folderMapping
Returns
Type Description
IList<IRemoteStorageItem>
| Improve this Doc View Source

GetSetting(FolderMappingInfo, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected static string GetSetting(FolderMappingInfo folderMapping, string settingName)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String settingName
Returns
Type Description
System.String
| Improve this Doc View Source

GetStorageItem(FolderMappingInfo, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected virtual IRemoteStorageItem GetStorageItem(FolderMappingInfo folderMapping, string key)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String key
Returns
Type Description
IRemoteStorageItem
| Improve this Doc View Source

GetSubFolders(String, FolderMappingInfo)

Gets the list of subfolders for the specified folder.

Declaration
public override IEnumerable<string> GetSubFolders(string folderPath, FolderMappingInfo folderMapping)
Parameters
Type Name Description
System.String folderPath
FolderMappingInfo folderMapping
Returns
Type Description
IEnumerable<System.String>

A sequence of relative sub-folder paths.
Overrides
| Improve this Doc View Source

IsInSync(IFileInfo)

Indicates if the specified file is synchronized.

Declaration
public override bool IsInSync(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
System.Boolean

true if the file is in sync, otherwise false.
Overrides
Remarks

For now, it returns false always until we find a better way to check if the file is synchronized.

| Improve this Doc View Source

MoveFileInternal(FolderMappingInfo, String, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected abstract void MoveFileInternal(FolderMappingInfo folderMapping, string sourceUri, string newUri)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String sourceUri
System.String newUri
| Improve this Doc View Source

MoveFolder(String, String, FolderMappingInfo)

Moves the folder and files at the specified folder path to the new folder path.

Declaration
public override void MoveFolder(string folderPath, string newFolderPath, FolderMappingInfo folderMapping)
Parameters
Type Name Description
System.String folderPath
System.String newFolderPath
FolderMappingInfo folderMapping
Overrides
| Improve this Doc View Source

MoveFolderInternal(FolderMappingInfo, String, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected abstract void MoveFolderInternal(FolderMappingInfo folderMapping, string sourceUri, string newUri)
Parameters
Type Name Description
FolderMappingInfo folderMapping
System.String sourceUri
System.String newUri
| Improve this Doc View Source

RenameFile(IFileInfo, String)

Renames the specified file using the new filename.

Declaration
public override void RenameFile(IFileInfo file, string newFileName)
Parameters
Type Name Description
IFileInfo file
System.String newFileName
Overrides
| Improve this Doc View Source

RenameFolder(IFolderInfo, String)

Renames the specified folder using the new newFolderName.

Declaration
public override void RenameFolder(IFolderInfo folder, string newFolderName)
Parameters
Type Name Description
IFolderInfo folder
System.String newFolderName
Overrides
| Improve this Doc View Source

SetFileAttributes(IFileInfo, FileAttributes)

Base class that provides common functionality to work with files and folders.

Declaration
public override void SetFileAttributes(IFileInfo file, FileAttributes fileAttributes)
Parameters
Type Name Description
IFileInfo file
FileAttributes fileAttributes
Remarks

No implementation needed because this provider doesn't support .

| Improve this Doc View Source

SupportsFileAttributes()

Gets a value indicating if the underlying system supports file attributes.

Declaration
public override bool SupportsFileAttributes()
Returns
Type Description
System.Boolean

true if the provider supports file attributes, otherwise false.
Overrides
Remarks

Amazon doesn't support file attributes.

| Improve this Doc View Source

UpdateFile(IFileInfo, Stream)

Base class that provides common functionality to work with files and folders.

Declaration
public override void UpdateFile(IFileInfo file, Stream content)
Parameters
Type Name Description
IFileInfo file
Stream content
| Improve this Doc View Source

UpdateFile(IFolderInfo, String, Stream)

Base class that provides common functionality to work with files and folders.

Declaration
public override void UpdateFile(IFolderInfo folder, string fileName, Stream content)
Parameters
Type Name Description
IFolderInfo folder
System.String fileName
Stream content
| Improve this Doc View Source

UpdateFileInternal(Stream, FolderMappingInfo, String)

Base class that provides common functionality to work with files and folders.

Declaration
protected abstract void UpdateFileInternal(Stream stream, FolderMappingInfo folderMapping, string uri)
Parameters
Type Name Description
Stream stream
FolderMappingInfo folderMapping
System.String uri

Extension Methods