Select a site

IMPORTANT: This version of Sitefinity CMS is out of support and the respective product documentation is no longer maintained and can be outdated. Use the version selector to view a supported product version.

Custom Products module: Implement the OpenAccess data provider

After Custom Products module: Create the base data provider class, you implement the OpenAccess provider that the Products module uses. The OpenAccess data provider must inherit and implement the abstract ProductsDataProvider class and the IOpenAccessDataProvider interface. To create an OpenAccess data provider:

  1. In the ProductsModule project, open the context menu of the Data folder » Implementation folder and click Add » Class.
  2. Name the class file OpenAccessProvider.cs and click Add.
  3. Open the OpenAccessProvider.cs file and add the following using statements:
    using System.Reflection;
    using ProductCatalogSample.Model;
    using Telerik.OpenAccess;
    using Telerik.OpenAccess.Metadata;
    using Telerik.Sitefinity.Data;
    using Telerik.Sitefinity.Data.Linq;
    using Telerik.Sitefinity.Data.OA;
    using Telerik.Sitefinity.Lifecycle;
    using Telerik.Sitefinity.Localization;
    using Telerik.Sitefinity.Model;
    using Telerik.Sitefinity.Model.ContentLinks;
    using Telerik.Sitefinity.Modules.GenericContent.Data;
    using Telerik.Sitefinity.Security;
    using Telerik.Sitefinity.Security.Model;
  4. Make the OpenAccessProvider class inherit the ProductsDataProvider class and implement the IOpenAccessDataProvider interface:
    public class OpenAccessProvider : ProductsDataProvider, IOpenAccessDataProvider
    {
    }
  5. Implement the ProductsDataProvider abstract class in the following way:
    public override ProductItem CreateProduct()
    {
        return this.CreateProduct(Guid.NewGuid());
    }
      
    public override ProductItem CreateProduct(Guid id)
    {
        var product = new ProductItem();
        product.Id = id;
        product.ApplicationName = this.ApplicationName;
        product.Owner = SecurityManager.GetCurrentUserId();
        var dateValue = DateTime.UtcNow;
        product.DateCreated = dateValue;
        product.PublicationDate = dateValue;
        ((IDataItem)product).Provider = this;
      
        // products permissions inherit form the security root
        var securityRoot = this.GetSecurityRoot();
        if (securityRoot != null)
        {
            this.providerDecorator.CreatePermissionInheritanceAssociation(securityRoot, product);
        }
        else
        {
            var msg = Res.Get<SecurityResources>().NoSecurityRoot;
            msg = string.Format(msg, typeof(ProductItem).AssemblyQualifiedName);
            throw new InvalidOperationException(msg);
        }
      
        // items with empty guid are used in the UI to get a "blank" data item
        // -> i.e. to fill a data item with default values
        // if this is the case, we leave the item out of the transaction
        if (id != Guid.Empty)
        {
            this.GetContext().Add(product);
        }
      
        return product;
    }
      
    public override ProductItem GetProduct(Guid id)
    {
        if (id == Guid.Empty)
        {
            throw new ArgumentException("Id cannot be Empty Guid");
        }
      
        // Always use this method. Do NOT change it to query. Catch the exception if the Id can be wrong.
        var newsItem = this.GetContext().GetItemById<ProductItem>(id.ToString());
        ((IDataItem)newsItem).Provider = this;
        return newsItem;
    }
      
    public override IQueryable<ProductItem> GetProducts()
    {
        var appName = this.ApplicationName;
      
        var query =
            SitefinityQuery
            .Get<ProductItem>(this, MethodBase.GetCurrentMethod())
            .Where(b => b.ApplicationName == appName);
      
        return query;
    }
      
    public override void DeleteProduct(ProductItem product)
    {
        var scope = this.GetContext();
     
        this.ClearContentLinks(product);
     
        this.providerDecorator.DeletePermissions(product);
        this.ClearLifecycle(product, this.GetProducts());
        if (scope != null)
        {
            scope.Remove(product);
        }
     
        this.DeleteItemComments(product.GetType(), product.Id);
    }
  6. Implement the IOpenAccessDataProvider members in the following way:
    public OpenAccessProviderContext Context
    {
        get;
        set;
    }
     
    public MetadataSource GetMetaDataSource(IDatabaseMappingContext context)
    {
        return new ProductsFluentMetadataSource(context);
    }

    In the code above, the GetMetaDataSource method returns an instance of the ContentBaseMetadataSource implementation that defines the fluent mappings for your module.

  7. Mark the OpenAccessProvider class with the ContentProviderDecorator attribute:
    [ContentProviderDecorator(typeof(OpenAccessContentDecorator))]
    public class OpenAccessProvider : ProductsDataProvider, IOpenAccessDataProvider
    {
    }
  8. Implement the following methods and properties:
    public TransactionMode TransactionConcurrency
    {
        get
        {
            return TransactionMode.PESSIMISTIC_EXPLICIT;
        }
    }
     
    public bool UseImplicitTransactions
    {
        get { return true; }
    }
     
    public Database Database
    {
        get;
        set;
    }
     
    private static Assembly[] peristentAssemblies;
     
    static OpenAccessProvider()
    {
        peristentAssemblies = new Assembly[] { typeof(ProductItem).Assembly };
    }
     
    public Assembly[] GetPersistentAssemblies()
    {
        return peristentAssemblies;
    }

Back To Top

Next: Custom Products module: Implement the fluent mappings