Jump To Close Expand all Collapse all Table of contents Administration and Configuration Guide Preface 1. JBoss Data Grid Expand section "1. JBoss Data Grid" Collapse section "1. JBoss Data Grid" 1.1. About JBoss Data Grid 1.2. JBoss Data Grid Supported Configurations 1.3. JBoss Data Grid Usage Modes Expand section "1.3. JBoss Data Grid Usage Modes" Collapse section "1.3. JBoss Data Grid Usage Modes" 1.3.1. JBoss Data Grid Usage Modes 1.3.2. Remote Client-Server Mode 1.3.3. Library Mode 1.4. JBoss Data Grid Benefits 1.5. JBoss Data Grid Prerequisites 1.6. JBoss Data Grid Version Information 1.7. JBoss Data Grid Cache Architecture 1.8. JBoss Data Grid APIs Expand section "1.8. JBoss Data Grid APIs" Collapse section "1.8. JBoss Data Grid APIs" 1.8.1. JBoss Data Grid APIs 1.8.2. About the Asynchronous API 1.8.3. About the Batching API 1.8.4. About the Cache API 1.8.5. About the RemoteCache Interface 1.9. Tools and Operations Expand section "1.9. Tools and Operations" Collapse section "1.9. Tools and Operations" 1.9.1. About Management Tools 1.9.2. Accessing Data via URLs 1.9.3. Limitations of Map Methods 2. Logging in JBoss Data Grid Expand section "2. Logging in JBoss Data Grid" Collapse section "2. Logging in JBoss Data Grid" 2.1. About Logging 2.2. Supported Application Logging Frameworks Expand section "2.2. Supported Application Logging Frameworks" Collapse section "2.2. Supported Application Logging Frameworks" 2.2.1. Supported Application Logging Frameworks 2.2.2. About JBoss Logging 2.2.3. JBoss Logging Features 2.3. Configure Logging Expand section "2.3. Configure Logging" Collapse section "2.3. Configure Logging" 2.3.1. About Boot Logging 2.3.2. Configure Boot Logging 2.3.3. Default Log File Locations 2.4. Logging Attributes Expand section "2.4. Logging Attributes" Collapse section "2.4. Logging Attributes" 2.4.1. About Log Levels 2.4.2. Supported Log Levels 2.4.3. About Log Categories 2.4.4. About the Root Logger 2.4.5. About Log Handlers 2.4.6. Log Handler Types 2.4.7. Selecting Log Handlers 2.4.8. About Log Formatters 2.5. Logging Configuration Properties Expand section "2.5. Logging Configuration Properties" Collapse section "2.5. Logging Configuration Properties" 2.5.1. Root Logger Properties 2.5.2. Log Category Properties 2.5.3. Console Log Handler Properties 2.5.4. File Log Handler Properties 2.5.5. Periodic Log Handler Properties 2.5.6. Size Log Handler Properties 2.5.7. Async Log Handler Properties 2.6. Logging Sample Configurations Expand section "2.6. Logging Sample Configurations" Collapse section "2.6. Logging Sample Configurations" 2.6.1. Sample XML Configuration for the Root Logger 2.6.2. Sample XML Configuration for a Log Category 2.6.3. Sample XML Configuration for a Console Log Handler 2.6.4. Sample XML Configuration for a File Log Handler 2.6.5. Sample XML Configuration for a Periodic Log Handler 2.6.6. Sample XML Configuration for a Size Log Handler 2.6.7. Sample XML Configuration for a Async Log Handler 3. State Transfer and High Availability Using Server Hinting Expand section "3. State Transfer and High Availability Using Server Hinting" Collapse section "3. State Transfer and High Availability Using Server Hinting" 3.1. State Transfer Expand section "3.1. State Transfer" Collapse section "3.1. State Transfer" 3.1.1. About State Transfer 3.1.2. Non-Blocking State Transfer 3.2. High Availability Using Server Hinting Expand section "3.2. High Availability Using Server Hinting" Collapse section "3.2. High Availability Using Server Hinting" 3.2.1. About Server Hinting 3.2.2. Establishing Server Hinting with JGroups 3.2.3. Configure Server Hinting (Remote Client-Server Mode) 3.2.4. Configure Server Hinting (Library Mode) 3.2.5. ConsistentHashFactory 4. Cache Modes Expand section "4. Cache Modes" Collapse section "4. Cache Modes" 4.1. About Cache Modes 4.2. About Cache Containers 4.3. About Local Mode Expand section "4.3. About Local Mode" Collapse section "4.3. About Local Mode" 4.3.1. Local Mode Operations 4.3.2. Configure Local Mode (Remote Client-Server Mode) 4.3.3. Configure Local Mode (Library Mode) 4.4. About Clustered Modes Expand section "4.4. About Clustered Modes" Collapse section "4.4. About Clustered Modes" 4.4.1. Clustered Mode Operations 4.4.2. Asynchronous and Synchronous Operations 4.4.3. Cache Mode Troubleshooting 5. Distribution Mode Expand section "5. Distribution Mode" Collapse section "5. Distribution Mode" 5.1. About Distribution Mode 5.2. Distribution Mode's Consistent Hash Algorithm 5.3. Locating Entries in Distribution Mode 5.4. Return Values in Distribution Mode 5.5. Configure Distribution Mode (Remote Client-Server Mode) 5.6. Configure Distribution Mode (Library Mode) 5.7. Synchronous and Asynchronous Distribution Expand section "5.7. Synchronous and Asynchronous Distribution" Collapse section "5.7. Synchronous and Asynchronous Distribution" 5.7.1. About Synchronous and Asynchronous Distribution 5.8. GET and PUT Usage in Distribution Mode Expand section "5.8. GET and PUT Usage in Distribution Mode" Collapse section "5.8. GET and PUT Usage in Distribution Mode" 5.8.1. About GET and PUT Operations in Distribution Mode 5.8.2. Distributed GET and PUT Operation Resource Usage 6. Replication Mode Expand section "6. Replication Mode" Collapse section "6. Replication Mode" 6.1. About Replication Mode 6.2. Optimized Replication Mode Usage 6.3. Return Values in Replication Mode 6.4. Configure Replication Mode (Remote Client-Server Mode) 6.5. Configure Replication Mode (Library Mode) 6.6. Synchronous and Asynchronous Replication Expand section "6.6. Synchronous and Asynchronous Replication" Collapse section "6.6. Synchronous and Asynchronous Replication" 6.6.1. Synchronous and Asynchronous Replication 6.6.2. Troubleshooting Asynchronous Replication Behavior 6.7. The Replication Queue Expand section "6.7. The Replication Queue" Collapse section "6.7. The Replication Queue" 6.7.1. Replication Queue 6.7.2. Replication Queue Operations 6.7.3. Replication Queue Usage 6.8. Frequently Asked Questions Expand section "6.8. Frequently Asked Questions" Collapse section "6.8. Frequently Asked Questions" 6.8.1. About Replication Guarantees 6.8.2. Replication Traffic on Internal Networks 7. Invalidation Mode Expand section "7. Invalidation Mode" Collapse section "7. Invalidation Mode" 7.1. About Invalidation Mode 7.2. Using Invalidation Mode 7.3. Configure Invalidation Mode (Remote Client-Server Mode) 7.4. Configure Invalidation Mode (Library Mode) 7.5. Synchronous/Asynchronous Invalidation 7.6. The L1 Cache Invalidation Expand section "7.6. The L1 Cache Invalidation" Collapse section "7.6. The L1 Cache Invalidation" 7.6.1. The L1 Cache and Invalidation 8. Cache Writing Modes Expand section "8. Cache Writing Modes" Collapse section "8. Cache Writing Modes" 8.1. Write-Through and Write-Behind Caching 8.2. Write-Through Caching Expand section "8.2. Write-Through Caching" Collapse section "8.2. Write-Through Caching" 8.2.1. About Write-Through Caching 8.2.2. Write-Through Caching Benefits 8.2.3. Write-Through Caching Configuration (Library Mode) 8.3. Write-Behind Caching Expand section "8.3. Write-Behind Caching" Collapse section "8.3. Write-Behind Caching" 8.3.1. About Write-Behind Caching 8.3.2. About Unscheduled Write-Behind Strategy 8.3.3. Unscheduled Write-Behind Strategy Configuration (Remote Client-Server Mode) 8.3.4. Unscheduled Write-Behind Strategy Configuration (Library Mode) 9. Locking Expand section "9. Locking" Collapse section "9. Locking" 9.1. About Locking 9.2. Configure Locking (Remote Client-Server Mode) 9.3. Configure Locking (Library Mode) 9.4. Locking Types Expand section "9.4. Locking Types" Collapse section "9.4. Locking Types" 9.4.1. About Optimistic Locking 9.4.2. About Pessimistic Locking 9.4.3. Pessimistic Locking Types 9.4.4. Explicit Pessimistic Locking Example 9.4.5. Implicit Pessimistic Locking Example 9.4.6. Configure Locking Mode (Remote Client-Server Mode) 9.4.7. Configure Locking Mode (Library Mode) 9.5. Locking Operations Expand section "9.5. Locking Operations" Collapse section "9.5. Locking Operations" 9.5.1. About the LockManager 9.5.2. About Lock Acquisition 9.5.3. About Concurrency Levels 10. Lock Striping Expand section "10. Lock Striping" Collapse section "10. Lock Striping" 10.1. About Lock Striping 10.2. Configure Lock Striping (Remote Client-Server Mode) 10.3. Configure Lock Striping (Library Mode) 11. Isolation Levels Expand section "11. Isolation Levels" Collapse section "11. Isolation Levels" 11.1. About Isolation Levels 11.2. About READ_COMMITTED 11.3. About REPEATABLE_READ 12. Cache Stores Expand section "12. Cache Stores" Collapse section "12. Cache Stores" 12.1. About Cache Stores 12.2. File Cache Stores Expand section "12.2. File Cache Stores" Collapse section "12.2. File Cache Stores" 12.2.1. About File System Based Cache Stores 12.2.2. File Cache Store Configuration (Remote Client-Server Mode) 12.2.3. File Cache Store Configuration (Library Mode) 12.3. Remote Cache Stores Expand section "12.3. Remote Cache Stores" Collapse section "12.3. Remote Cache Stores" 12.3.1. About Remote Cache Stores 12.3.2. Remote Cache Store Configuration (Remote Client-Server Mode) 12.3.3. Remote Cache Store Configuration (Library Mode) 12.3.4. The hotrod.properties File 12.3.5. Define the Outbound Socket for the Remote Cache Store 12.4. JDBC Based Cache Stores Expand section "12.4. JDBC Based Cache Stores" Collapse section "12.4. JDBC Based Cache Stores" 12.4.1. About JDBC Based Cache Stores 12.4.2. JdbcBinaryCacheStores 12.4.3. JdbcStringBasedCacheStores 12.4.4. JdbcMixedCacheStore 12.4.5. Custom Cache Stores 12.5. Frequently Asked Questions Expand section "12.5. Frequently Asked Questions" Collapse section "12.5. Frequently Asked Questions" 12.5.1. About Asynchronous Cache Store Modifications 12.6. Cache Store Troubleshooting Expand section "12.6. Cache Store Troubleshooting" Collapse section "12.6. Cache Store Troubleshooting" 12.6.1. IOExceptions with JdbcStringBasedCacheStore 13. Cache Loaders Expand section "13. Cache Loaders" Collapse section "13. Cache Loaders" 13.1. About Cache Loaders 13.2. Cache Loaders and Cache Stores 13.3. Shared Cache Loaders Expand section "13.3. Shared Cache Loaders" Collapse section "13.3. Shared Cache Loaders" 13.3.1. About Shared Cache Loaders 13.3.2. Enable Shared Cache Loaders 13.3.3. Invalidation Mode and Shared Cache Loaders 13.3.4. The Cache Loader and Cache Passivation 13.3.5. Application Cacheloader Registration 13.4. Connection Factories Expand section "13.4. Connection Factories" Collapse section "13.4. Connection Factories" 13.4.1. About Connection Factories 13.4.2. About ManagedConnectionFactory 13.4.3. About SimpleConnectionFactory 14. Cache Managers Expand section "14. Cache Managers" Collapse section "14. Cache Managers" 14.1. About Cache Managers 14.2. Multiple Cache Managers Expand section "14.2. Multiple Cache Managers" Collapse section "14.2. Multiple Cache Managers" 14.2.1. Create Multiple Caches with a Single Cache Manager 14.2.2. Using Multiple Cache Managers 15. Eviction Expand section "15. Eviction" Collapse section "15. Eviction" 15.1. About Eviction 15.2. Eviction Operations 15.3. Eviction Usage 15.4. Eviction Strategies Expand section "15.4. Eviction Strategies" Collapse section "15.4. Eviction Strategies" 15.4.1. About Eviction Strategies 15.4.2. LRU Eviction Algorithm Limitations 15.5. Using Eviction Expand section "15.5. Using Eviction" Collapse section "15.5. Using Eviction" 15.5.1. Initialize Eviction 15.5.2. Default Eviction Configuration 15.5.3. Eviction Configuration Examples 15.5.4. Eviction Configuration Troubleshooting 15.6. Eviction and Passivation Expand section "15.6. Eviction and Passivation" Collapse section "15.6. Eviction and Passivation" 15.6.1. About Eviction and Passivation 16. Expiration Expand section "16. Expiration" Collapse section "16. Expiration" 16.1. About Expiration 16.2. Expiration Operations 16.3. Eviction and Expiration Comparison 16.4. Cache Entry Expiration Notifications 16.5. Configure Expiration 16.6. Mortal and Immortal Data Expand section "16.6. Mortal and Immortal Data" Collapse section "16.6. Mortal and Immortal Data" 16.6.1. About Data Mortality 16.6.2. Default Data Mortality 16.6.3. Configure Data Mortality 16.7. Troubleshooting Expand section "16.7. Troubleshooting" Collapse section "16.7. Troubleshooting" 16.7.1. Expiration Troubleshooting 17. The L1 Cache Expand section "17. The L1 Cache" Collapse section "17. The L1 Cache" 17.1. About the L1 Cache 17.2. L1 Cache Entries Expand section "17.2. L1 Cache Entries" Collapse section "17.2. L1 Cache Entries" 17.2.1. L1 Cache Entries 17.2.2. L1 Cache Configuration (Library Mode) 17.2.3. L1 Cache Configuration (Remote Client-Server Mode) 17.3. L1 Cache Operations Expand section "17.3. L1 Cache Operations" Collapse section "17.3. L1 Cache Operations" 17.3.1. The L1 Cache and Invalidation 17.3.2. Using the L1 Cache with GET Operations 18. Activation and Passivation Modes Expand section "18. Activation and Passivation Modes" Collapse section "18. Activation and Passivation Modes" 18.1. About Activation and Passivation 18.2. Passivation Mode Benefits 18.3. Configure Passivation 18.4. Eviction and Passivation Expand section "18.4. Eviction and Passivation" Collapse section "18.4. Eviction and Passivation" 18.4.1. About Eviction and Passivation 18.4.2. Eviction and Passivation Usage 18.4.3. Eviction Example when Passivation is Disabled 18.4.4. Eviction Example when Passivation is Enabled 19. Transactions Expand section "19. Transactions" Collapse section "19. Transactions" 19.1. About Transactions 19.2. About Transaction Synchronizations 19.3. About the Transaction Manager 19.4. Transaction Recovery Expand section "19.4. Transaction Recovery" Collapse section "19.4. Transaction Recovery" 19.4.1. About Transaction Recovery 19.4.2. Obtain the Transaction Manager From the Cache 19.4.3. Transaction Manager and XAResources 19.4.4. Obtain a XAResource Reference 19.5. Configure Transactions Expand section "19.5. Configure Transactions" Collapse section "19.5. Configure Transactions" 19.5.1. Configure Transactions (Library Mode) 19.5.2. Configure Transactions (Remote Client-Server Mode) 19.6. Transaction Behavior Expand section "19.6. Transaction Behavior" Collapse section "19.6. Transaction Behavior" 19.6.1. Transaction Recovery Process 19.6.2. Transaction Recovery Example 19.6.3. Default Distributed Transaction Behavior 19.6.4. Transaction/Batching and Invalidation Messages 19.6.5. Transaction Memory and JMX Support 19.6.6. Forced Commit and Rollback Operations 19.6.7. Transactions and Exceptions 19.6.8. Transactions Spanning Multiple Cache Instances 19.7. Transaction Synchronization Expand section "19.7. Transaction Synchronization" Collapse section "19.7. Transaction Synchronization" 19.7.1. About Transaction Synchronizations 19.8. Deadlock Detection Expand section "19.8. Deadlock Detection" Collapse section "19.8. Deadlock Detection" 19.8.1. About Deadlock Detection 19.8.2. Enable Deadlock Detection 20. JGroups Interfaces Expand section "20. JGroups Interfaces" Collapse section "20. JGroups Interfaces" 20.1. About JGroups Interfaces 20.2. Configure JGroups Interfaces 20.3. About Binding Sockets Expand section "20.3. About Binding Sockets" Collapse section "20.3. About Binding Sockets" 20.3.1. About Group and Individual Socket Binding 20.3.2. Binding a Single Socket Example 20.3.3. Binding a Group of Sockets Example 20.4. JGroups for Clustered Modes Expand section "20.4. JGroups for Clustered Modes" Collapse section "20.4. JGroups for Clustered Modes" 20.4.1. Configure JGroups for Clustered Modes 20.4.2. Pre-Configured JGroups Files 21. Management Tools in JBoss Data Grid Expand section "21. Management Tools in JBoss Data Grid" Collapse section "21. Management Tools in JBoss Data Grid" 21.1. Java Management Extensions (JMX) Expand section "21.1. Java Management Extensions (JMX)" Collapse section "21.1. Java Management Extensions (JMX)" 21.1.1. About Java Management Extensions (JMX) 21.1.2. Using JMX with JBoss Data Grid 21.1.3. JMX Statistic Levels 21.1.4. Enable JMX for Cache Instances 21.1.5. Enable JMX for CacheManagers 21.1.6. Disabling the CacheStore via JMX 21.1.7. Multiple JMX Domains 21.1.8. About MBeans 21.1.9. Understanding MBeans 21.1.10. Registering MBeans in Non-Default MBean Servers 22. JBoss Operations Network (JON) Expand section "22. JBoss Operations Network (JON)" Collapse section "22. JBoss Operations Network (JON)" 22.1. About JBoss Operations Network (JON) 22.2. Download JBoss Operations Network (JON) Expand section "22.2. Download JBoss Operations Network (JON)" Collapse section "22.2. Download JBoss Operations Network (JON)" 22.2.1. Prerequisites for Installing JBoss Operations Network (JON) 22.2.2. Download JBoss Operations Network 22.2.3. Remote JMX Port Values 22.2.4. Download JBoss Operations Network (JON) Plugin for JBoss Data Grid 22.3. JBoss Operations Network Server Installation Expand section "22.3. JBoss Operations Network Server Installation" Collapse section "22.3. JBoss Operations Network Server Installation" 22.3.1. Installing JBoss Operations Network Server Prerequisites 22.3.2. Installing the JBoss Operations Network Server on Linux 22.3.3. Installing the JBoss Operations Network Server on Windows 22.4. JBoss Operations Network Agent Expand section "22.4. JBoss Operations Network Agent" Collapse section "22.4. JBoss Operations Network Agent" 22.4.1. About the JBoss Operations Network Agent 22.4.2. JBoss Operations Network Agent Installation Prerequisites 22.4.3. Installing the JBoss Operations Network Agent 22.4.4. Configure the JBoss Operations Network Agent 22.4.5. Tools and Operations 22.5. JBoss Operations Network for Remote Client-Server Mode Expand section "22.5. JBoss Operations Network for Remote Client-Server Mode" Collapse section "22.5. JBoss Operations Network for Remote Client-Server Mode" 22.5.1. JBoss Operations Network in Remote Client-Server Mode 22.5.2. Installing the JBoss Operations Network Plug-in (Remote Client-Server Mode) 22.6. JBoss Operations Network for Library Mode Expand section "22.6. JBoss Operations Network for Library Mode" Collapse section "22.6. JBoss Operations Network for Library Mode" 22.6.1. JBoss Operations Network in Library Mode 22.6.2. Installing the JBoss Operations Network Plug-in (Library Mode) 22.6.3. Manually Adding JBoss Data Grid Instances in Library Mode 22.7. JBoss Operations Network Remote-Client Server Plugin Expand section "22.7. JBoss Operations Network Remote-Client Server Plugin" Collapse section "22.7. JBoss Operations Network Remote-Client Server Plugin" 22.7.1. JBoss Operations Network Plugin Metrics 22.7.2. JBoss Operations Network Plugin Operations 22.7.3. JBoss Operations Network Plugin Attributes 22.8. Monitor JBoss Enterprise Application Platform 6 Applications Using Library Mode Expand section "22.8. Monitor JBoss Enterprise Application Platform 6 Applications Using Library Mode" Collapse section "22.8. Monitor JBoss Enterprise Application Platform 6 Applications Using Library Mode" 22.8.1. Prerequisites 22.8.2. Monitor an Application Deployed in Standalone Mode 22.8.3. Monitor an Application Deployed in Domain Mode 22.9. JBoss Operations Network Plug-in Quickstart 23. Cross-Datacenter Replication Expand section "23. Cross-Datacenter Replication" Collapse section "23. Cross-Datacenter Replication" 23.1. About Cross-Datacenter Replication 23.2. Cross-Datacenter Replication Operations 23.3. Configure Cross Datacentre Replication Expand section "23.3. Configure Cross Datacentre Replication" Collapse section "23.3. Configure Cross Datacentre Replication" 23.3.1. Configure Cross-Datacentre Replication (Remote Client-Server Mode) 23.3.2. Configure Cross-Datacentre Replication (Library Mode) 23.3.3. Configure Cross-Datacentre Replication Programmatically 23.4. Taking a Site Offline Expand section "23.4. Taking a Site Offline" Collapse section "23.4. Taking a Site Offline" 23.4.1. About Taking Sites Offline 23.4.2. Taking a Site Offline (Remote Client-Server Mode) 23.4.3. Taking a Site Offline (Library Mode) 23.4.4. Taking a Site Offline (Programmatically) 23.4.5. Taking a Site Offline via JBoss Operations Network (JON) 23.4.6. Taking a Site Offline via the CLI 23.4.7. Bring a Site Back Online A. List of JMX MBeans in JBoss Data Grid Expand section "A. List of JMX MBeans in JBoss Data Grid" Collapse section "A. List of JMX MBeans in JBoss Data Grid" A.1. Activation A.2. Cache A.3. CacheLoader A.4. CacheManager A.5. CacheStore A.6. DeadlockDetectingLockManager A.7. DistributionManager A.8. Interpreter A.9. Invalidation A.10. JmxStatsCommandInterceptor A.11. LockManager A.12. MassIndexer A.13. Passivation A.14. RecoveryAdmin A.15. RollingUpgradeManager A.16. RpcManager A.17. StateTransferManager A.18. Statistics A.19. Transactions A.20. Transport A.21. XSiteAdmin B. References Expand section "B. References" Collapse section "B. References" B.1. About Consistency B.2. About Consistency Guarantee B.3. About Java Management Extensions (JMX) B.4. About JBoss Cache B.5. About JSON B.6. About Lucene Directory B.7. About RELAY2 B.8. About Return Values B.9. About Runnable Interfaces B.10. About Two Phase Commit (2PC) B.11. About Key-Value Pairs B.12. The Externalizer Expand section "B.12. The Externalizer" Collapse section "B.12. The Externalizer" B.12.1. About Externalizer B.12.2. Internal Externalizer Implementation Access B.13. Hash Space Allocation Expand section "B.13. Hash Space Allocation" Collapse section "B.13. Hash Space Allocation" B.13.1. About Hash Space Allocation B.13.2. Locating a Key in the Hash Space B.13.3. Requesting a Full Byte Array C. Revision History Legal Notice Settings Close Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Preface Previous Next