JBoss Cache TreeCache - A Structured, Replicated, Transactional Cache

User Documentation

Bela Ban

Manik Surtani

Brian Stansberry

Daniel Huang

Release 1.4.0 "Jalapeno"

July 2006


Table of Contents

Preface
1. Introduction
1.1. What is a TreeCache?
1.2. TreeCache Basics
2. Architecture
3. Basic API
4. Clustered Caches
4.1. Local Cache
4.2. Clustered Cache - Using Replication
4.2.1. Buddy Replication
4.2.1.1. Selecting Buddies
4.2.1.2. BuddyPools
4.2.1.3. Failover
4.2.1.4. Implementation
4.2.1.5. Configuration
4.3. Clustered Cache - Using Invalidation
5. Transactions and Concurrency
5.1. Concurrent Access
5.1.1. Locks
5.1.2. Pessimistic locking
5.1.2.1. Isolation levels
5.1.3. Optimistic locking
5.1.3.1. Architecture
5.1.3.2. Configuration
5.2. Transactional Support
5.2.1. Example
6. Eviction Policies
6.1. Eviction Policy Plugin
6.2. TreeCache Eviction Policy Configuration
6.3. TreeCache LRU eviction policy implementation
6.4. TreeCache FIFO eviction policy implementation
6.5. TreeCache MRU eviction policy implementation
6.6. TreeCache LFU eviction policy implementation
7. Cache Loaders
7.1. The CacheLoader Interface
7.2. Configuration via XML
7.3. Cache passivation
7.4. CacheLoader use cases
7.4.1. Local cache with store
7.4.2. Replicated caches with all nodes sharing the same store
7.4.3. Replicated caches with only one node having a store
7.4.4. Replicated caches with each node having its own store
7.4.5. Hierarchical caches
7.4.6. TcpDelegatingCacheLoader
7.4.7. RmiDelegatingCacheLoader
7.5. JDBC-based CacheLoader
7.5.1. JDBCCacheLoader configuration
7.5.1.1. Table configuration
7.5.1.2. DataSource
7.5.1.3. JDBC driver
7.5.1.4. Configuration example
8. TreeCacheMarshaller
8.1. Basic Usage
8.2. Region Activation/Inactivation
8.2.1. Example usage of Region Activation/Inactivation
8.3. Region Activation/Inactivation with a CacheLoader
8.4. Performance over Java serialization
8.5. Backward compatibility
9. State Transfer
9.1. Types of State Transfer
9.2. When State Transfer Occurs
10. Version Compatibility and Interoperability
11. Configuration
11.1. Sample XML-Based Configuration
11.2. Definition of XML attributes
11.3. Overriding options
12. Management Information
12.1. JBoss Cache MBeans
12.2. JBoss Cache Statistics
12.3. Receiving Cache Notifications
12.4. Accessing Cache MBeans in a Standalone Environment
13. Running JBoss Cache within JBoss Application Server
13.1. Running as an MBean