NCache 4.4 - Online Documentation

Introduction to NCache

What's New in NCache 4.4?

Self Healing Dynamic Clustering

Caching Topologies

Features Highlights

Support for .NET & ASP.NET Apps

Support for Java/J2EE & JSP Apps

Cache Server Backward Compatibility

Caching Concepts

Cache Topologies

Replicated Cache

Partitioned Cache

Partitioned-Replica Cache

Data Load Balancing in Partitioned and Partitioned-Replica Topologies

Client Backward Compatibility

Runtime Data Sharing

Portable Data Types (.NET & Java)

Class Versioning (Same Platform)

Graceful Node Down

Installation Guide

.NET Installation Guide

Getting Started

Command Line Install

Network Install with PowerShell

Configuring PowerShell Environment

Remote Installation/Uninstallation

Activate NCache Purchased License

Interactive Windows Installation

Evaluation Period Expiration & Extension

Activate NCache Purchased License

Command Line Activation

Deactivate NCache Purchased License

NCache Java Client Installation Guide for UNIX

What is NCache Java Client?

Getting Started

Installation Steps for UNIX

Post Installation License Management for UNIX

Post Installation Client/Server Configuration for UNIX

Uninstall NCache Java Client from UNIX

Troubleshooting Common Install/Uninstall Problems

Getting Started

Quickly Configure and use NCache

Quickly use Cache API in .NET

Initialize Cache

Quick Start Guide for .NET

Store ASP .NET 1.1 Sessions

Step 1: Configure the Cache

Step 2: Edit web.config or machine.config

Step 3: Start/Restart ASP.NET Application

Store ASP .NET 2.0+ Sessions

Step 1: Configure the Cache

Step 2: Edit web.config or machine.config

Step 3: Start/Restart ASP.NET Application

Use as ASP.NET Output Cache

Step 1: Configure the Cache

Step 2: Edit Web.Config or Machine.Config

Step 3: Start/Restart ASP.NET Application

Use as NHibernate Second Level Cache

Step 1: Configure the Cache

Step 2: Register NCache with NHibernate

Step 3: Enable DBCacheDependency in NHibernate

Step 4: Run your NHibernate based Application

Use Dynamic Compact Serialization

Step 1: Register Compact Types with NCache

Step 2: Run Your Application

Administrator's Guide

Configuring Caches

Creating Caches

Creating Local Cache

Creating Cache Clusters

Creating a New Cache Cluster

Adding an Existing Cache Cluster

Adding Server Node in a Cache Cluster

Removing Server Node from Clustered Cache

Configuring Basic Cache Settings

Isolation Levels

Expiration Clean Up Interval

Configuring Cache Cluster Settings

Operation Timeout

Statistic Replication Interval

Connection Retries

Configuring Query Indexes

Registering Classes for Compact Serialization

Registering Non-Generic Classes

Registering Generic Classes

Registering Generic Classes using Generic Type Handler

Registering Classes for Portable Data Sharing

Import/Export Data Share Configuration

Configuring Data Source Providers

Read-Through Provider

Write-Through Provider

Write-Through Provider for Write-Behind Operations

Configuring Cache Start-Up Loader

Configuring Cache Level Events

Configuring Eviction Policy

Configuring Compression

Configuring Email Notifications

Binding Cluster and Client/Server with a Dedicated IP for Performance

Binding Cluster with a Dedicated IP

Binding Client/Server with a Dedicated IP

Configuring Heart Beat

Auto Start Cache at Boot

Configuration Files

EFCaching Config

Configuring Bridge

Configuring Security

Cache Server Configuration

Cache Server Configurations in Service Config File

Management Operations

Start Cache on all Server Nodes

Start Cache on a Particular Server Node

Stop Cache on all Server Nodes

Stop Cache on a Particular Server Node

Manage Cache Service on a Server Node

Start Cache Service on a Server Node

Stop Cache Service on a Server Node

Restart Cache Service on a Server Node

Apply Configuration

Hot Apply Configuration

Reset Configuration

Data Load Balancing

Configuring Cache Clients

Adding Client Node in a Cache Cluster

Configuring Client Node Settings

Creating Client Cache

Disable Client Cache on Client Nodes

Enable Client Cache on Client Nodes

Configuring Client Cache Settings

Synchronization Mode

Client Cache Size

Isolation Level

Configuring Security

Configuring Security for Cache Management

Configuring Security for Cache

Configuring Encryption for Cache

Configuring Bridge for WAN Replication

Overview of Bridge

Creating Clustered Bridge

Configuring Bridge Settings

Bridge Queue Size

Bridge Connection Settings

Enable the Queue Optimization

Performance Counters

Bulk Size for Operation Replications

Configuring Conflict Resolver

Changing Cache Synchronization Modes

Making Passive Cache as Active Cache

Making Active Cache as Passive Cache

Configuring Master Cache

Force State Transfer

Connect/Disconnect a Cache

Remove a Cache from Bridge

Bridge Management

Add a Bridge Node

Apply and Reset Configuration

Remove a Bridge Node

Stop Bridge Service

Start Bridge Service

Restart Bridge Service

Monitoring NCache

Performance Counters

Debugging Counters

Monitoring Caches using NCache Manager

Changing Management Port of a Cache Node

Configuring Counters to Display

Fetching the Statistics using Server IP or Server Name

Monitoring Cache Clusters using NCache Email Alerts

Monitoring Caches using NCache Monitor

Monitoring Cache Server Counters Using Built-In Dashboard

Monitoring Cache Client Counters Using Built-In Client Dashboard

Monitoring Cache Cluster Counters Using Custom Dashboard

Monitoring Perfmon Counters Using Custom Dashboard

Monitoring Cache Event Logs Using Custom Dashboard

Monitoring Client Process of a Cache Cluster Using Custom Dashboard

ASP.NET Session Monitoring Using Custom Dashboard

Monitoring Bridge Using NCache Manager

Configuring Bridge Counters to Display

Browse Bridge Statistics

Monitoring NCache Using Windows Perfmon Tool

Monitoring Cache Server Counters Using Perfmon Tool

Monitoring Cache Client Counters Using Perfmon Tool

Monitoring Bridge Counters Using Perfmon Tool

NCache Monitor Logging

Performance Counters Logging

Windows Event Logging

Email Notifications on NCache Events

Cache Server Logging

Client Side API Logging

Programmer's Guide

Client Side API Programming

Setting Up Development Environment

Using Basic Cache Operations

Initialize Cache

Add/Update Data to Cache

Fetch Data from Cache

Remove Data from Cache

Bulk Operations

Using Bulk Operations

Asynchronous Operations

Using Asynchronous Operations

Grouping Cached Data

Tagging Cached Data

Using Named Tags

Data Invalidation Strategies

Using Expirations

Cache Dependencies

Using Cache Dependencies

Adding Data with File and Key Dependencies

Synchronizing Cache with Relational Database

Using SQL Dependency

Using Oracle Dependency

Using Polling Based Dependency

Using CLR Procedures to Call NCache

Synchronizing Cache with Custom Data Sources

Synchronize Data across Multiple Caches

Add Dependency to the Existing Cached Item

Aggregate Cache Dependency

Locking Items in Cache

Using Cache Item Versioning

Object Query Language (OQL) in NCache

Object Query Language (OQL) Syntax

NCache Language Integrated Query (LINQ)

Querying Data in NCache

Event Notifications

NCache Event Notifications

Cache Level Data Event Notifications

Item Level Data Event Notifications

Custom Events Notifications

Continuous Query

Using Continuous Query

Security and Encryption

Data Compression

NCache Management API

Server Side API Programming

Cache Startup Loader

Using Cache Startup Loader

Data Source Provider (Backing Source)

Read-Through Caching

Write-Through Caching

Configuring Read-Through Provider

Configuring Write-Through Provider

Dynamic Compact Serialization

Using Compact Serialization

WAN Replication Through Bridge

Bridge Configurations

Bridge Conflict Resolver

Custom Dependency

Client Side ASP.NET Features

ASP.NET Sessions

Using NCache Session State Store Provider

View State Caching

Using NCache View State Caching

ASP.NET Output Cache

Using ASP.NET Output Cache

Client Side Third Party Integrations

Using NCache as NHibernate Second Level Cache

Entity Framework Caching Integration

Using NCache as Entity Framework Second Level Cache

NCache Memcached Gateway Approach

Memcached Client Plug-in for .NET

Troubleshooting

Add Reference issue of Visual Studio 2010

Upgrade NCache without disturbing deployed environment

Troubleshooting Scripts

Viewing Statistics of a Remote Server Node

Troubleshooting Counters

Diskperf Not Installed

No READ Access to Perflib Subkeys

Unable to Connect to Server Node (Windows XP/ Windows 7 Machine)

GeneralFailureException

java.lang.NoClassDefFoundError

No server available to process request

SessionStoreProvider not found

IndexNotDefinedException

Implementing Clusters

Compact Serialization Exception

Disabled Netwrok Card

Out of Memory Problem

Multiple Network Cards

Nodes not Joining

Blocked Node Communication due to Firewall

Two Active Nodes Situation

Installing NCache

NCache Activation Error

Error 1721: A Required Program could not be Run

Upgrade NCache without Disturbing Deployed Environment

Installation Ended Prematurely

Removing NCache assemblies from GAC

NCache Installation Error 1606

Installation Roll Backs on Windows Vista

Alachisoft.NCache.Runtime.Exceptions.SecurityException

Cache Event IDs

Troubleshooting Client Socket Deadlock

How to do NCache Version Upgrades?

What is the Recommended Way to Apply Windows Patches on NCache Server?

How to Debug Providers?

How to Configure and Use NCache Manager for Visual Studio

Creating Clustered Cache

Creating Local Cache

Adding/Removing Server Node to/from Existing Clustered Cache

Adding Server Node

Removing Server Node

Adding/Removing Client Node to/from Existing Clustered Cache

Adding Client Node

Removing Client Node

Configuring Basic Cache Settings

Management Operations

Start/Stop Service on a Server Node

Configuring Statistics Counters to Display Management Port

Viewing Statistics of a Cache

What is NCache Java Client?

NCache Java Client is an NCache client written in Java that makes sharing and managing data in a cluster as simple as on a single server. It accomplishes this by coordinating updates to the data using cluster-wide concurrency control, and replicating and distributing data modifications across the cluster using the highest performing clustered protocol available. The primary purpose of NCache Java Client is to help improve performance of Java/J2EE & JSP applications that would

otherwise make expensive trips to database systems, web services, mainframes, or other systems across the network.

Connecting with NCache Java Clients

Accessing NCache Java Client Resources: You can subscribe to a variety of NCache Java Client resources including newsletters, webinars etc. Please visit Alachisoft Website.

Accessing NCache Java Client Documentation: You can access all NCache Java Client documentation at

Online Documentation.

Contacting NCache Java Client Support: For comments/feedback and any problems related to NCache Java Client or this manual you can contact NCache support. Simply send an email to support@alachisoft.com or visit Alachisoft Support Page.

See Also

Getting Started | Installation Steps for UNIXl | Post Installation License Management for UNIX | Post Installation Client/Server Configuration UNIX | Uninstall NCache Java Client from UNIX

Send comments on this topic.