Alachisoft NCache 4.1 - Online Documentation
NCache 4.1 Documentation
NCache
Introduction to NCache
What's New in NCache 4.1?
Self Healing Dynamic Clustering
Caching Topologies
Features Highlights
Support for .NET & ASP.NET Apps
Support for Java/J2EE & JSP Apps
Cache Server Backward Compatibility
Copyright ©
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 Installer
Evaluation Period Expiration & Extension
Activate NCache Purchased License
Command Line Activation
Java Installation Guide
Installation Guide for Windows
Getting Started
Command Line Install
Interactive Windows Installer
Evaluation Period Expiration & Extension
Activate NCache Purchased License
Installation Guide for Unix
Installing Java Client of NCache on Unix
Command Line Installation
What Gets Installed?
Evaluation Period Expiration & Extension
Activate NCache Purchased License
Getting Started
Getting Started for .NET
Getting Started Guide
Quickly use Cache API in .NET
Initialize Cache
Start Cache
Adding Items
Removing Items
Deleting Items
Finding Items
Dispose Cache
Stop 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 L2 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 with EntLib Caching Block
Step 1: Configure the Cache
Step 2: Register NCache with CAB
Step 3: Run your CAB based Application
Use with .Net 4.0 Cache
Step 1: Configure the Cache
Step 2: Configure .Net 4.0 Provider
Use Dynamic Compact Serialization
Step 1: Register Compact Types with NCache
Step 2: Run Your Application
Use App Fabric/Velocity Wrapper API
Step 1: Configure the Cache
Step 2: Using MS Velocity Wrapper API
Step 3: Run your Application with NCache based Distributed Caching
Using Regions through NCache Velocity Wrapper API
Getting Started for Java
Getting Started Guide
Quickly use Cache API in Java
Initialize Cache
Adding Items
Finding Items
Removing Items
Deleting Items
Dispose Cache
Quick Start Guide for Java
Store JSP Sessions
Step 1: Configure the Cache
Step 2: Adding Libraries
Step 3: Defining Filter
Step 4: Test your Application
Use Hibernate L2 Cache
Step 1: Configure the Cache
Step 2: Register NCache with Hibernate
Step 3: Run your Hibernate based Application
Use NCache with Spring
Step 1: Configure the Cache
Step 2: Register NCache with Spring
Step 3: Run your Spring Application
Use Dynamic Compact Serialization
Step 1: Register Compact Types with NCache
Step 2: Run Your Application
Configuring NCache
Configuration Files
Overview
Configuring Clients
Client Config
EFCaching Config
Server Side
Cache Config
Configuring Security
Configuring Bridge
Configuring with NCache Manager
GUI Tool Overview
What's stored in a Project?
Using NCache Manager from multiple locations
Clustered Cache Operations
Create New Clustered Cache
Add Existing Cluster Cache
Cluster Connectivity
Clear Contents
Apply Cluster Configuration
Add Server Node in a Cluster
View Cluster Statistics
Start NCache Service
Stop NCache Service
Restart NCache Service
Start/Stop a Cache Server
Start/Stop a Cache Cluster
Remove Server Node
Restart a Cluster
Remove Cluster
Refresh a Cluster
Select Network Interface Card
Balance Data Load
Make a node Active
Configure Clustered Cache
Remote Client Operations
Overview
Remote Client Node
Configure Remote Client
Client Cache Operations
Client Cache Overview
Create Client Cache
Clear Client Cache
Apply Configuration
Remove Client Cache
Configure Client Cache
Local Cache Operations
Create New Cache
Clear Contents
Apply Configuration
Hot Apply Configuration
Add Existing Cache
Remove Cache
Reset Configuration of Local Cache
Start/Stop a Local Cache
Statistics of a Local Cache
Configure Local Cache
Register Server Side Code
Bridge
Overview
Create New Bridge
Add Existing Bridge
Add Bridge Node
Add Caches
Start/Stop Bridge
Remove Bridge
Remove Bridge Node
Apply Configuration to Bridge
View Statistic
Configure Bridge
Security
Configuring Security
Admin Level Security
User Level Security
Browsing Domain Users
Configuration Options
InProc and OutProc
Heart Beat
Data Compression
Load Balancing
Auto Start Cache at Boot
Ports
Cluster Port and Port Range
Server Port
Operation Timeout
Client Request Timeout
Client/Server Connection Retry
Client/Server Connection Timeout
Nagling
Dual Socket
Error Logging
Maximum Size
Statistics Replication Interval
Eviction Policies
Least Frequently Used
Least Recently Used
Priority Based Eviction
Eviction Percentage
Clean Interval
Read-through and Write-through
Performance Counters
Event Notifications
Debugging Counters
Cache Server Configuration
Overview
Cache Server Configuration
Configuring with Command Line Tools
Clustered Cache Operations
Add Node
Start/Stop Cache
Remove Node
Create Cache
Clear Cache
Remote Client Operations
Add Client Node
Remove Client Node
Client Cache Operations
Remove Client Cache
Create Client Cache
Clear Cache
Local Cache Operations
Create Cache
Clear Cache
NCache Monitor for Cache Cluster
GUI Tool Overview
Server Dashboard
Client Dashboard
NCache Monitor Defining Dashboard
New Dashboard
NCache Monitor Cluster Selection
NCache Monitor Options
Command LineTools
createcache
addnode
removenode
addtestdata
dumpcache
configurenodesecurity
startcache
stopcache
listcaches
addclientnode
configureclient
configurecachesecurity
removeclientnode
getcachecount
createclientcache
removeclientcache
clearcache
upgradeconfiguration
stresstesttool
genmackeys
Keep Alive
Log Analyzer
Administrators-guide-forPowerShell
Alachisoft (R) NCache Utility Verify NCache License
Developing with NCache
.NET Programmer's Guide
Client Side API Programming
Overview
Initialize Cache
Add/Update
Finding Items
Delete Items
Get Cache Item
Dispose Cache
Access Multiple Caches in Single Application
Expiring Cached Items
Adding items with priority settings
Group/Subgroup
Tags
Named Tags
Locking Cached Items
Cache Item Version
Streaming API
Bulk Operations
Async Operations
Resync Expired Items
Performing Cache Operations in Secured Environment
Cache Dependency
Key Dependency
File Dependency
Aggregate Dependency
Custom Dependency
SQL Cache Dependency
Oracle Cache Dependency
DBCache Dependency
Enabling Notifications For SQL Server
Enabling Notifications For Oracle
Enabling Notifications For DB2
Enabling Database Cache Dependency in NHiberate
Database Dependencies with CAB
Clean Interval
Event Notifications
General purpose Notifications
Item Specific Events
Getting notified when an item is removed
Getting notified when an item is updated
Custom Notifications
Cache Generated Event
Member Joined Event
Member Left Event
Cache Stopped Event
Read-through and Write-through Caching
Enabling Read-through Cache Provider
Enabling Write-through Cache Provider
Queries & LINQ
Queries
Indexing Searchable Attributes in .NET
Object Query Language Syntax
NCache LINQ
Indexing Attributes for LINQ
Continuous Query
Indexing Searchable Attributes in .NET
Using Continuous Query
Server Side API Programming
Cache Startup Loader
Using Cache Startup Loader
Enabling Cache Startup Loader
Implementing ICacheLoader Interfaces
Read-through and Write-through Caching
Read-through Cache Provider
Enabling Read-through Cache Provider
Implementing IReadThruProvider
Write-through Cache Provider
Enabling Write-through Cache Provider
Implementing IWriteThruProvider
Dynamic Compact Serialization
Using Compact Types
Data Sharing
Using Data Sharing
Bridge Conflict Resolver
Using Bridge Conflict Resolver
Enabling Bridge Conflict Resolver
Implementing IBridgeConflictResolver Interface
Custom Dependency
Client Side ASP.NET Features
ASP.NET Sessions
Store ASP.NET 2.0+ Sessions
Session Locking in NCache Session Store Provider
Sessions in geographically separated web farms
NCache Session State Module
ASP.NET Output Cache
Content Optimization
View State Caching
Java Script Minification
View State Caching and Java Script Minification
Client Side Third Party Integrations
NHibernate
EntLib 4.1+ Caching Block
Entity Framework Caching Integration
Enabling NCache in Entity Framework application
Entity Framework Caching Integration Modes
Cache Provider for .Net 4.0
ChangeMonitor
JAVA Programmer's Guide
Client Side API Programming
Overview
Initialize & Dispose Cache
Access Multiple Caches in Single Application
Get Cache Item
Add/Update Item
Delete Items
Expiring Cached Items
Adding items with priority settings
Group/Subgroup
Tags
Named Tags
Locking Cached Items
Cache Item Version
Streaming API
Bulk Operations
Async Operations
Cache Dependency
Key Dependency
File Dependency
Aggregate Dependency
Cache Sync Dependency
SQL Cache Dependency
Oracle Cache Dependency
OLEDB Dependency
Enabling Notifications For SQL Server
Enabling Notifications For Oracle
Enabling Notifications For DB2
Use DB Dependency with Hibernate
Event Notifications
General Purpose Events
Getting notified when an item is removed
Getting notified when an item is updated
Custom Notifications
Cache Generated Events
Read-through, Write-through, Write-behind
Enabling Read-through Cache Provider
Enabling Write-through Cache Provider
Queries
Indexing Searchable Attributes in Java
Object Query Language Syntax
Continuous Query
Indexing Searchable Attributes in Java
Using Continuous Query
Server Side API Programming
Cache Startup Loader
Using Cache StartUp Loader
Enabling Cache Startup Loader
Implementing Cache Startup Loader
Read-Thru, Write-Thru/Write-Behind
Read-Thru Provider
Configuring Read-Thru Cache Provider
Implementing Read-Thru Provider Interface
Write-Thru Provider
Configuring Write-Thru Cache Provider
Implementing Write-Thru Provider Interface
Dynamic Compact Serialization
Using Compact Types
Data Sharing
Using Data Sharing
Bridge Conflict Resolver
Using Bridge Conflict Resolver
Enabling Bridge Conflict Resolver
Implementing BridgeConflictResolver Interface
Client Side JSP Features
NCache Java Session Module
NCache with Session Beans
Client Side Third Party Integrations
Enabling NCache in Hibernate Applications
Enabling NCache in Spring Framework Applications
Troubleshooting
Add Reference issue of Visual Studio 2010
Upgrade NCache without disturbing deployed environment
Troubleshooting Scripts
Viewing statistics of a remote server
Troubleshooting Counters
Diskperf Not Installed
No READ Access to Perflib Subkeys
Unable to Connect to Server Node (Windows XP/ Windows 7 Machine)
NCache API
GeneralFailureException
java.lang.NoClassDefFoundError
No server available to process request
SessionStoreProvider not found
Implementing Clusters
Compact Serialization exception
Disabled Netwrok Card
Maximum Size
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
Using Security
Alachisoft.NCache.Runtime.Exceptions.SecurityException
Cache Event IDs
How to's
How to do NCache Version Upgrades?
What is the Recommended Way to Apply Windows Patches on NCache Server?
To properly display this page you need a browser with JavaScript support.
< Previous page
Next page >
Server Side
This section will help you in configuring .Net and Java Servers. Three types of configuration files are present at server side, which are:
In This Section
Cache Config
Explains config.ncconf file that contains information regarding all registered caches/clusters.
Security Config
Helps enabling NCache security as well as to manage Node and API level security through security.ncconf file.
Bridge Config
Explains bridge.ncconf file that contains information regarding bridges.
Send comments on this topic.
Copyright © 2005-2012 Alachisoft. All rights reserved.