Migrating your Applications from AppFabric
This section elaborates on the migration options provided by NCache to migrate from AppFabric and how to implement them seamlessly via a series of simple steps.
Migration Options from AppFabric
The two migration options NCache offers are discussed below.
Important
Choose one approach for each part of your migration.
NCache AppFabric Wrapper Approach: This approach requires minimal code changes and is, thus, the easiest option. Here, you can continue to use the AppFabric API, which is redirected to the relevant NCache API. You can find the complete wrapper implementation on GitHub.
NCache Direct APIs Approach: This requires code change but gives you more control and flexibility. It also enables you to use NCache features beyond the AppFabric compatibility API.
Implementing the AppFabric Wrapper
To migrate from your AppFabric application to NCache using the wrapper, follow these steps and make the appropriate changes in your application code:
Remove the
Microsoft.ApplicationServer.Caching.ClientNuGet package or references to the following AppFabric libraries from your application's source code:- Microsoft.ApplicationServer.Caching.Client.dll
- Microsoft.ApplicationServer.Caching.Core.dll
Remove the following namespaces from your project:
Microsoft.ApplicationServer.CachingMicrosoft.ApplicationServer.Caching.ClientMicrosoft.ApplicationServer.Caching.Core
Install the NCache AppFabric Wrapper NuGet package in your application and add the
Alachisoft.NCache.Data.Cachingnamespace in your project.Specify your Cache Configurations as detailed below.
Your application should appear as follows:
using Alachisoft.NCache.Data.Caching;
using System;
using System.Configuration;
namespace NCacheAppFabricConsoleUI
{
class Program
{
static DataCacheFactory myCacheFactory;
internal static string myObjectForCaching = "This is my Object";
internal static DataCache myDefaultCache;
static void Main(string[] args)
{
try
{
PrepareClient();
RunSampleTest();
}
catch (Exception exp)
{
Console.WriteLine(exp.ToString());
}
Console.ReadLine();
}
}
} ...
Implementing the Direct APIs Approach
As mentioned above, this approach requires certain code changes, i.e., you will be required to implement NCache APIs to let your application use them. You can learn more about the differences between NCache and AppFabric API by further exploring our documentation.
Note
Configure server endpoints in the ncache section of your application configuration. When using the direct API, you can alternatively supply endpoints through ConnectionOptions. See Connecting to Cache.
Install the Alachisoft.NCache.SDK in your application.
Add the
Alachisoft.NCache.Clientnamespace in your project.Specify your Cache Configurations using in-line coding or using cache configurations as detailed below.
Implement NCache APIs.
Note
To learn more about implementing NCache APIs, please refer to our Developer's Guide.
Your application should appear as follows:
using System;
using System.Configuration;
using Alachisoft.NCache.Client;
namespace NCacheAppFabricConsoleUI
{
class Program
{
internal static ICache cache;
internal static string myObjectForCaching = "This is my Object";
static void Main(string[] args)
{
try
{
PrepareClient();
RunSampleTest();
}
catch (Exception exp)
{
Console.WriteLine(exp.ToString());
}
Console.ReadLine();
}
}
}
...
Specify Cache Configurations
- After you have installed the NuGet package and edited the namespaces, you need to configure the appSettings section of your App.config. Add the following keys and values to the appSettings:
<add key="Default" value="name-of-the-default-cache-here"/>
WhereDefaultis the ID of the default cache to use. This property is required if your application is calling the default cache.<add key="Expirable" value="True"/>
WhereExpirableis a boolean value flag that determines whether the cached objects should have an expiry set on them. By default, this tag is set to True. If you do not want to set an expiry on your cached items, then set this flag to False.<add key="TTL" value="hh:mm:ss"/>
WhereTTLis the expiration time set on cached items.
The appSettings section of your App.config file should contain the following:
<appSettings>
<add key="Default" value="myDefaultCache"/>
<add key="Expirable" value="True"/>
<add key="TTL" value="00:15:00"/>
</appSettings>
Note
- The
TTLwill not affect the cached items if theExpirabletag is False. - If the
Expirableis set to True and noTTLis given, then the default expiration time of 10 minutes will be used on all cached items. - Ensure that the application configuration contains the server endpoints for the cache name passed to the wrapper. The
Defaultsetting supplies the cache name used byGetDefaultCache.
Additional Resources
NCache provides an AppFabric wrapper application and a sample application on GitHub.
See Also
.NET: Alachisoft.NCache.Client namespace.
Java: com.alachisoft.ncache.client namespace.
Node.js: Cache class.
Python: ncache.client module.