JBoss.org Community Documentation

POJO Cache

User Documentation

Ben Wang

Jason Greene

Release 3.0.0

November 2008

Preface
1. Terminology
1.1. Overview
2. Introduction
2.1. Overview
2.2. Features
2.3. Usage
2.4. Requirements
3. Architecture
3.1. POJO Cache interceptor stack
3.2. Field interception
3.3. Object relationship management
3.4. Object Inheritance
3.5. Physical object cache mapping model
3.6. Collection Mapping
3.6.1. Limitations
3.7. Array Mapping
4. API Overview
4.1. PojoCacheFactory Class
4.2. PojoCache Interface
4.2.1. Attachment
4.2.2. Detachment
4.2.3. Query
5. Configuration and Deployment
5.1. Cache configuration xml file
5.2. Passivation
5.3. AOP Configuration
5.4. Deployment Options
5.4.1. Programatic Deployment
5.4.2. JMX-Based Deployment in JBoss AS (JBoss AS 5.x and 4.x)
5.4.3. Via JBoss Microcontainer (JBoss AS 5.x)
5.5. POJO Cache MBeans
5.6. Registering the PojoCacheJmxWrapper
5.6.1. Programatic Registration
5.6.2. JMX-Based Deployment in JBoss AS (JBoss AS 4.x and 5.x)
5.6.3. Via JBoss Microcontainer (JBoss AS 5.x)
5.7. Runtime Statistics and JMX Notifications
6. Instrumentation
6.1. Load-time instrumentation
6.2. Compile-time instrumentation
6.3. Understanding the provided AOP descriptor
6.4. Annotation
6.4.1. POJO annotation for instrumentation
6.4.2. JDK5.0 field level annotations
6.5. Weaving
6.5.1. Ant target for running load-time instrumentation using specialized class loader
6.5.2. Ant target for aopc
7. TroubleShooting
8. Appendix
8.1. Example POJO
8.2. Sample Cache configuration xml
8.3. PojoCache configuration xml