Class FileSharedDataSourceStorage

Represents a file-based definition storage to resolve SharedDataSource definitions from a local directory.

Inheritance
System.Object
ResourceStorageBase
ResourceStorage
FileDefinitionStorageBase
FileSharedDataSourceStorage
Inherited Members
Namespace: Telerik.WebReportDesigner.Services
Assembly: Telerik.WebReportDesigner.Services.dll

Syntax

public class FileSharedDataSourceStorage : FileDefinitionStorageBase, IHasBaseDir, ISharedDataSourceStorage, IResourceStorage, IAssetsStorage

Constructors

FileSharedDataSourceStorage(String)

Initializes a new instance of the FileSharedDataSourceStorage class.

Declaration
public FileSharedDataSourceStorage(string baseDir)
Parameters
System.String baseDir

The base directory where the SharedDataSource definitions are stored.

FileSharedDataSourceStorage(String, String[])

Initializes a new instance of the FileSharedDataSourceStorage class.

Declaration
public FileSharedDataSourceStorage(string baseDir, string[] definitionFolders)
Parameters
System.String baseDir

The base directory where the SharedDataSource subfolders are stored.
System.String[] definitionFolders

The folders where the SharedDataSource definitions are stored. Pass an empty string array to include all the folders.

FileSharedDataSourceStorage(String, String[], String[])

Initializes a new instance of the FileSharedDataSourceStorage class.

Declaration
public FileSharedDataSourceStorage(string baseDir, string[] definitionFolders, string[] excludedFolders)
Parameters
System.String baseDir

The base directory where the SharedDataSource definitions are stored.
System.String[] definitionFolders

The folders where the SharedDataSource definitions are stored. Pass an empty string array to include all the folders.
System.String[] excludedFolders

Relative folder paths to be excluded when retrieving folder contents. Wildcards are not supported.

Properties

FileExtensions

Gets an array with allowed file extensions.

Declaration
protected override string[] FileExtensions { get; }
Property Value
System.String[]

Overrides

Methods

GetModelAsync(String)

Finds a SharedDataSource resource by its uri and returns the information about it.

Declaration
public override Task<ResourceFileModel> GetModelAsync(string uri)
Parameters
System.String uri

The unique resource identifier (URI)
Returns
System.Threading.Tasks.Task<ResourceFileModel>

SharedDataSourceModel, containg the information about the resource.
Overrides
Implements

IsExtensionValid(String)

Determines if an asset extension is valid.

Declaration
protected override bool IsExtensionValid(string resourceExtension)
Parameters
System.String resourceExtension

Returns
System.Boolean

Overrides

Move(MoveResourceModel)

Moves the given SharedDataSource resource NewParentUri

Declaration
public override ResourceFileModel Move(MoveResourceModel model)
Parameters
MoveResourceModel model

The model containing the move operation data
Returns
ResourceFileModel

SharedDataSourceModel, containg the information about the folder
Overrides
Implements

Overwrite(OverwriteResourceModel, Byte[])

Overwrites existing SharedDataSource.

Declaration
public override ResourceFileModel Overwrite(OverwriteResourceModel model, byte[] resource)
Parameters
OverwriteResourceModel model

System.Byte[] resource

Returns
ResourceFileModel

SharedDataSourceModel, containg the information about the overwritten resource.
Overrides
Implements

RenameAsync(RenameResourceModel)

Renames a definition asset.

Declaration
public override Task<ResourceFileModel> RenameAsync(RenameResourceModel model)
Parameters
RenameResourceModel model

Returns
System.Threading.Tasks.Task<ResourceFileModel>

Overrides
Implements

SaveAsync(SaveResourceModel, Byte[])

Saves the new bytes of a SharedDataSource resource and returns the information about it. The path to the SharedDataSource resource will be created if it does not exists.

Declaration
public override Task<ResourceFileModel> SaveAsync(SaveResourceModel model, byte[] resource)
Parameters
SaveResourceModel model

The model containing the save operation data
System.Byte[] resource

The contents of the resource.
Returns
System.Threading.Tasks.Task<ResourceFileModel>

SharedDataSourceModel, containg the information about the resource.
Overrides
Implements
Exceptions
InvalidResourceNameException

ValidateDefinitionId(String)

Validates the provided definitionId.

Declaration
protected override void ValidateDefinitionId(string definitionId)
Parameters
System.String definitionId

Overrides

Explicit Interface Implementations

ISharedDataSourceStorage.GetModelAsync(String)

Returns the SharedDataSource model at uri or null if not found.

Declaration
Task<SharedDataSourceModel> ISharedDataSourceStorage.GetModelAsync(string uri)
Parameters
System.String uri

The unique resource identifier (URI) of the resource.
Returns
System.Threading.Tasks.Task<SharedDataSourceModel>

SharedDataSourceModel, containg the information about the resource.
Implements

ISharedDataSourceStorage.RenameAsync(RenameResourceModel)

Renames a SharedDataSource by its model.

Declaration
Task<SharedDataSourceModel> ISharedDataSourceStorage.RenameAsync(RenameResourceModel model)
Parameters
RenameResourceModel model

The model containing relevant data used to rename
Returns
System.Threading.Tasks.Task<SharedDataSourceModel>

SharedDataSourceModel, containg the information about the resource.
Implements

ISharedDataSourceStorage.SaveAsync(SaveResourceModel, Byte[])

Creates new or overwrites an existing SharedDataSource definition file with the provided definition bytes.

Declaration
Task<SharedDataSourceModel> ISharedDataSourceStorage.SaveAsync(SaveResourceModel model, byte[] resource)
Parameters
SaveResourceModel model

System.Byte[] resource

Returns
System.Threading.Tasks.Task<SharedDataSourceModel>

SharedDataSourceModel, containg the information about the resource.
Implements