• Products
  • Solutions
  • Customers
  • Resources
  • Company
  • Pricing
  • Download
Try Playground
  • Server-side API Programming
  • Custom Dependency
  • Implement Extensible Dependency
Show / Hide Table of Contents
  • Programmer's Guide
  • Setting Up Development Environment
    • .NET
      • Client API Prerequisites
      • Server-side API Prerequisites
    • Java
      • Client API Prerequisites
      • Server-side API Prerequisites
    • Python
      • Client API Prerequisites
    • Node.js
      • Client API Prerequisites
  • Client Side API Programming
    • Error Handling
    • Troubleshooting
    • Cache Keys and Data
    • How to Connect to Cache
    • Basic Operations - An Overview
      • Add Data
      • Update/Insert Data
      • Retrieve Data
      • Remove Data
    • Groups
      • Overview
      • Add/Update Data with Groups
      • Retrieve Data with Groups
      • Remove Data with Group
      • Search Group Data Using SQL
      • Delete Group Data Using SQL
    • Tags
      • Overview
      • Add/Update Data with Tags
      • Retrieve Data with Tags
      • Remove Data with Tags
      • Search Tag Data Using SQL
      • Delete Tag Data Using SQL
    • Named Tags
      • Overview
      • Add/Update Data with Named Tags
      • Remove Data with Named Tags
      • Search Data with Named Tags Using SQL
      • Delete Data with Named Tags Using SQL
    • Expirations
      • Overview
      • Absolute Expiration
      • Sliding Expiration
    • Data Dependency
      • Key Dependency
      • Multi-Cache Dependency
    • Dependency on Database
      • SQL Server
      • Oracle
      • OleDB with Polling
      • CLR Procedures in SQL Server
    • Dependency on External Source
      • File Dependency
      • Custom Dependency
      • Aggregate Dependency
    • Locks
      • Types of Locking
      • Pessimistic Locking
      • Optimistic Locking
    • SQL Query
      • Overview
      • Define Indexes Programmatically
      • Query with ExecuteReader and ExecuteScalar
      • Delete Data with ExecuteNonQuery
      • SQL Reference
    • LINQ Query
      • Overview
      • LINQ Query for Objects
      • LINQ Reference
    • Data Structures
      • Overview
      • List
      • Queue
      • Set
      • Dictionary
      • Counter
      • Invalidation Attributes
      • Searchable Attributes
      • Query on Data Structures
      • Remove from Data Structure
    • Events
      • Cache Level Events
      • Item Level Events
      • Management Level Events
    • Pub/Sub Messaging
      • Overview
      • Topics
      • Publish Messages
      • Subscribe to a Topic
      • Pub/Sub Events
    • Continuous Query
      • Overview
      • Use Continuous Query
    • Stream Processing
      • Add/Update Stream Data
      • Retrieve Stream Data
    • JSON
      • Overview
      • Use JSON Objects
      • Query JSON Data
    • Security API
      • Login with Credentials
    • Management API
    • Clear Cache
    • Error Logging
    • Location Affinity
  • Server-side API Programming
    • Loader and Refresher
      • Overview
      • Implement Loader and Refresher
      • Components of Loader/Refresher
    • Data Source Providers
      • Read-through
        • Implement Read-through
        • Use Read-through
      • Write-through
        • Implement Write-through
        • Use Write-through
        • Use Write-behind
    • Custom Dependency
      • Implement Extensible Dependency
      • Implement Bulk Extensible Dependency
      • Implement Notify Extensible Dependency
    • Bridge Conflict Resolver
    • Entry Processor
      • Overview
      • Implement Entry Processor
    • MapReduce
      • Overview
      • Implement MapReduce
      • Use MapReduce
    • MapReduce Aggregator
      • Overview
      • Implement and Use Aggregator
    • Compact Serialization
  • Client Side Features
    • ASP.NET Core Caching
      • Session Storage
        • Session Provider
        • IDistributedCache
        • Sessions Usage
        • Multi-site Session Provider
        • Session Sharing with ASP.NET
      • SignalR
        • NCache Extension for SignalR Core
      • Response Caching
        • Configure and Use
        • Configure with IDistributedCache
      • Data Caching
        • NCache API
        • IDistributedCache API
      • Data Protection Provider
        • Configure
    • Java Web App Caching
      • Web Sessions
        • Overview
        • Configure App
          • Add Maven Dependencies
          • Deploy Application
        • Multi-site Sessions
    • Node.js App Caching
      • Web Sessions
    • ASP.NET Caching Benefits and Overview
      • ASP.NET Session State Provider Properties
      • Multi-region ASP.NET Session State Provider Configuration
      • Session Sharing between ASP.NET and ASP.NET Core
      • ASP.NET SignalR Backplane
        • NCache Extension for SignalR
      • ASP.NET View State Caching
        • View State Content Optimization Configuration
        • Group View State with Sessions
        • Limit View State Caching
        • Page Level Grouping
      • ASP.NET Output Cache
        • Output Caching Provider Overview
        • Output Cache with Custom Hooks
  • .NET Third Party Integrations
    • Entity Framework (EF) Core
      • Installation
      • Configure
      • EF Core Extension Methods
        • Extension Methods
        • Cache Handle
        • Caching Options
        • Query Deferred API
      • Logging in EF Core
    • Entity Framework EF 6
      • EF Second Level Cache
      • EF Caching Resync Provider
      • EF Caching Configuration File
    • NHibernate
      • Second Level Cache
      • Query Caching
      • Synchronize Database with Cache
    • Debug NCache Providers in Visual Studio
  • Java Third Party Integrations
    • Hibernate
      • Second Level Cache
      • Configure Cacheable Objects and Regions
      • Configure Application
      • Query Caching
    • Spring
      • Overview
      • Use NCache with Spring
        • Configure Generic Provider
        • Configure JCache Spring Caching Provider
        • Configure Caching Declaration
        • Configure Spring Sessions
    • JCache API
      • CRUD Operations
      • Expiration
      • Events
  • Third-Party Wrappers
    • AppFabric to NCache Migration
      • AppFabric API vs. NCache API
      • Configuration Differences Between AppFabric and NCache
      • Migrating from an AppFabric Application to NCache
    • Redis to NCache Migration
      • Redis to NCache Migration
    • Memcached Wrapper
      • Memcached Gateway Approach
      • Memcached Client Plugin for .NET

Extensible Database Dependency Usage and Implementation [Deprecated]

In Extensible Database Dependency, the users can have their own dependency scenarios that invalidate an item when certain criteria are met. In this way, items can expire from the cache in several flexible ways where the expiration logic meets the users business requirements. To implement the Extensible Dependency in your application, NCache provides an abstract class, ExtensibleDependency. Follow the guide below to understand how to implement and use this class.

Tip

Refer to Custom Cache Dependencies to get acquainted with all cache dependency custom methods provided by NCache.

Prerequisites

  • .NET
  • Java
  • Legacy API
  • To learn about the standard prerequisites required to work with all NCache server-side features including Extensible Database Dependency, please refer to the given page on Server-Side API Prerequisites.
  • The project must be implemented as a Class Library (.dll) in Visual Studio. This will be deployed on the NCache cluster.
  • The Dependency class must be deployed on cache.
  • For API details, refer to: ICache, CacheItem, insert, ExecuteReader, CustomDependency, ExtensibleDependency, HasChanged, IDictionary, CommandText, CreateDependency, ICustomDependencyProvider.
  • To learn about the standard prerequisites required to work with all NCache server-side features including Extensible Database Dependency, please refer to the given page on Server-Side API Prerequisites.
  • The class must be implemented as a Class project in Java IDE. This will be deployed on the NCache cluster.
  • The Dependency class must be deployed on cache.
  • For API details, refer to: Cache, insert, CustomDependency, ExtensibleDependency, CacheItem, QueryCommand, Map, hasChanged, CustomDependencyProvider.
  • Create a new Console Application.
  • Make sure that the data being added is serializable.
  • Add NCache References by locating %NCHOME%\NCache\bin\assembly\4.0 and adding Alachisoft.NCache.Web and Alachisoft.NCache.Runtime as appropriate.
  • Include the Alachisoft.NCache.Runtime.Dependencies namespace in your application.

Step 1: Implement Extensible Database Dependency Class

The first step in introducing your own logic for Extensible Dependency is to inherit the ExtensibleDependency class.

Let's suppose there is a grocery store that has a large collection of products that customers often buy. These products can be cached from the database to check their units in stock. The following dependency implementation polls the Northwind database and expires all the Products for which units in stock are less than 100.

  • .NET
  • Java
  • Legacy API
[Serializable]
public class Dependency : ExtensibleDependency
{
    // Class parameters
    [NonSerialized]
    OleDbConnection connection;

    public Dependency(int productId, string connString)
    {
        connection =  new OleDbConnection(connString);
        connection.Open();
        productID = productId;
    }

    public bool HasChanged()
    {
        if (GetAvailableUnits(productID) < 100)
            return true;
        return false;
    }

    internal int GetAvailableUnits(int productID)
    {
        if (connection == null)
        {
            connection = new OleDbConnection(connString);
            connection.Open();
        }

        OleDbCommand command = connection.CreateCommand();
        command.CommandText = String.Format(CultureInfo.InvariantCulture,
            "Select UnitsInStock From Products" +
            " where ProductID = {0}", productID);

        int availableUnits = -1;
        OleDbDataReader reader = null;
        reader = command.ExecuteReader();
        if (reader.Read())
        {
            availableUnits = Convert.ToInt32(reader["UnitsInStock"].ToString());
        }
        reader.Close();
        return availableUnits;
    }
    protected void DependencyDispose()
    {
        // Dispose off all resources
    }
    // This class is to be deployed in NCache
}
public class Dependency extends ExtensibleDependency{
    // Class parameters
    Connection connection;

    public Dependency(int productID, String connString) {
        connection = DriverManager.getConnection(connString);
        connection.open();
        productId = productID;
    }

    public boolean hasChanged() {
        if (getAvailableUnits(productId) < 100) {
            return true;
        } else {
            return false;
        }
    }

    int getAvailableUnits(int productID) {
        int availableUnits = -1;
        ResultSet result = null;
        try {
            Statement statement = connection.createStatement();
            String query = "Select UnitsInStock FROM dbo.Products WHERE ProductID = " + "?";
            QueryCommand queryCommand = new QueryCommand(query);
            queryCommand.getParameters().put("ProductID", productID);
            result = statement.executeQuery(query);
            return Integer.valueOf(String.valueOf(result));
        } catch (Exception exception) {
            // Handle exceptions
        }
    }

    protected void dependencyDispose() {
        // Dispose off all resources
    }
    // This class is to be deployed in NCache
}
[Serializable]
public class CustomDependency : ExtensibleDependency
{
    private string _connString;
    private int _productID;

    public override bool Initialize()
    {
        return true;
    }

    public CustomDependency(int productID, string connString)
    {
        _connString = connString;
        _productID = productID;
    }

    internal bool DetermineExpiration()
    {
        if (GetAvailableUnits(_productID) < 100)
            return true;
        return false;
    }

    internal int GetAvailableUnits(int productID)
    {
        SqlDataReader reader = null;
        SqlConnection connection = new SqlConnection(_connString);
        connection.Open();

        int availableUnits = -1;
        SqlCommand cmd = connection.CreateCommand();
        cmd.CommandText = "Select UnitsInStockFrom Products where ProductID=" + productID;

        reader = cmd.ExecuteReader();

        if (reader.Read())
        {
            availableUnits = Convert.ToInt32(reader["UnitsInStock"].ToString());
        }

        reader.Close();
        return availableUnits;
    }

    public override bool HasChanged
    {
        get
        {
            return DetermineExpiration();
        }
    }
}

Step 2: Implement Custom Dependency Provider

A Custom Dependency Provider for Extensible Dependency implements the logic that you created in Step 1 on the server side. Here's how you can implement your own Extensible Dependency Provider:

This class implements the CustomDependencyProvider interface that is required to successfully create and deploy an Extensible Dependency Provider.

  • .NET
  • Java
public class ExtensibleDependencyProvider : ICustomDependencyProvider
{
    public void Init(IDictionary<string, string> parameters, string cacheName)
    {
        // Initialize cache and class parameters
    }

    public Dependency CreateDependency(string key, IDictionary<string, string> dependencyParameters)
    {
        int productId = 0;
        string connectionString = "";

        if (dependencyParameters != null)
        {
            if (dependencyParameters.ContainsKey("ProductID"))
                productId = Int32.Parse(dependencyParameters["ProductID"]);

            if (dependencyParameters.ContainsKey("ConnectionString"))
                connectionString = dependencyParameters["ConnectionString"];

            // Create extensible dependency
            Dependency dependency = new Dependency(productId, connectionString);
            return dependency;
        }
        else
        {
            // No parameters found
        }
    }

    public void Dispose ()
    {
        // Dispose off all resources
    }
}
public class ExtensibleDependencyProvider implements CustomDependencyProvider {
    public void init(Map<String, String> parameters, String cacheName) {
        // Initialize cache and class parameters
    }

    public Dependency createDependency(String key, Map<String, String> dependencyParameters) {
        int productId = 0;
        String connectionString = "";

        if (dependencyParameters != null) {
            if (dependencyParameters.containsKey("ProductID")) {
                productId = Integer.valueOf(dependencyParameters.get("ProductID"));
            }

            if (dependencyParameters.containsKey("ConnectionString")) {
                connectionString = dependencyParameters.get("ConnectionString");
            }

            // Create extensible dependency
            Dependency dependency = new Dependency(productId, connectionString);
            return dependency;
        } else {
            // No parameters found
        }
    }

    public void dispose () {
        // Dispose off all resources
    }
}

Step 3: Deploy Implementation on Cache

Deploy this class and all dependent assemblies on NCache by referring to Deploy Providers in the Administrator’s Guide for help.

Step 4: Use Extensible Dependency

Once the Extensible Dependency class has been implemented and deployed, it is ready to be used in your application.

The following code shows how to add data into the cache using the Insert method with Extensible Dependency enabled.

  • .NET
  • Java
  • Legacy API
// Specify the connection string
string connectionString = ConfigurationManager.AppSettings["connectionstring"];

// Fetch the product to be added to the cache
Product product = FetchProductFromDB(productId);

// Specify the unique key of the item
string key = $"Product:{product.ProductID}";

// Create a cacheItem
var cacheItem = new CacheItem(product);

// Create dictionary for dependency parameters
IDictionary<string, string> param = new Dictionary<string, string>();
param.Add("ProductID", product.Id.ToString());
param.Add("ConnectionString", connectionString);

// Create Extensible Dependency using Provider and Add it to Cache Item
CustomDependency customDependency = new CustomDependency(ConfigurationManager.AppSettings["ProviderName"], param);
cacheItem.Dependency = customDependency;

// Add cacheItem to the cache with dependency
cache.Insert(key, cacheItem);
// Specify the connection string
String connectionString = "";

// Fetch the products to be added in the cache
Product product = fetchProductByProductID(productId);

// Specify unique key for this product
String key = "Product:" + product.productID;

// Create a cache item
CacheItem cacheItem = new CacheItem(product);

// Create map and add parameters in it
Map<String, String> map = new HashMap<String, String>();
map.put("ProductID", String.valueOf(product.productID));
map.put("ConnectionString", connectionString);

// Create Extensible Dependency using Provider and add it to cache item
CustomDependency customDependency = new CustomDependency(providerName, map);
cacheItem.setDependency(customDependency);

// Add cacheItem to the cache with dependency
cache.insert(key, cacheItem);
string connString = "Provider=SQLOLEDB.1; Data Source=localhost; User ID=sa; password=; Initial Catalog=Northwind";

// Creating custom dependency
CustomDependency customDependency = new CustomDependency(123, connString);

Product product = new Product();
product.ProductID = 1001;
product.ProductName = "Chai";

string key = "Product:" + product.ProductID;
// Adding data with custom dependency
cache.Insert(key, product, new CacheDependency(customDependency), Cache.NoAbsoluteExpiration, Cache.NoSlidingExpiration, CacheItemPriority.Default);

Additional Resources

NCache provides a sample application for Extensible Dependency on GitHub.

See Also

How to Configure Custom Dependency
Cache Data Dependency on External Source
WAN Replication across Multi Datacenters through Bridge

In This Article
  • Step 1: Implement Extensible Database Dependency Class
  • Step 2: Implement Custom Dependency Provider
  • Step 3: Deploy Implementation on Cache
  • Step 4: Use Extensible Dependency
  • Additional Resources
  • See Also

Contact Us

PHONE

+1 (214) 764-6933   (US)

+44 20 7993 8327   (UK)

 
EMAIL

sales@alachisoft.com

support@alachisoft.com

NCache
  • NCache Enterprise
  • NCache Professional
  • Edition Comparison
  • NCache Architecture
  • Benchmarks
Download
Pricing
Try Playground

Deployments
  • Cloud (SaaS & Software)
  • On-Premises
  • Kubernetes
  • Docker
Technical Use Cases
  • ASP.NET Sessions
  • ASP.NET Core Sessions
  • Pub/Sub Messaging
  • Real-Time ASP.NET SignalR
  • Internet of Things (IoT)
  • NoSQL Database
  • Stream Processing
  • Microservices
Resources
  • Magazine Articles
  • Third-Party Articles
  • Articles
  • Videos
  • Whitepapers
  • Shows
  • Talks
  • Blogs
  • Docs
Customer Case Studies
  • Testimonials
  • Customers
Support
  • Schedule a Demo
  • Forum (Google Groups)
  • Tips
Company
  • Leadership
  • Partners
  • News
  • Events
  • Careers
Contact Us

  • EnglishChinese (Simplified)FrenchGermanItalianJapaneseKoreanPortugueseSpanish

  • Contact Us
  •  
  • Sitemap
  •  
  • Terms of Use
  •  
  • Privacy Policy
© Copyright Alachisoft 2002 - 2025. All rights reserved. NCache is a registered trademark of Diyatech Corp.
Back to top