Jump To Close Expand all Collapse all Table of contents Developer 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 I. Programmable APIs Expand section "I. Programmable APIs" Collapse section "I. Programmable APIs" 2. The Cache API Expand section "2. The Cache API" Collapse section "2. The Cache API" 2.1. About the Cache API 2.2. Using the ConfigurationBuilder API to Configure the Cache API 2.3. Per-Invocation Flags Expand section "2.3. Per-Invocation Flags" Collapse section "2.3. Per-Invocation Flags" 2.3.1. About Per-Invocation Flags 2.3.2. Per-Invocation Flag Functions 2.3.3. Configure Per-Invocation Flags 2.3.4. Per-Invocation Flags Example 2.4. The AdvancedCache Interface Expand section "2.4. The AdvancedCache Interface" Collapse section "2.4. The AdvancedCache Interface" 2.4.1. About the AdvancedCache Interface 2.4.2. Flag Usage with the AdvancedCache Interface 2.4.3. Custom Interceptors and the AdvancedCache Interface 2.4.4. Custom Interceptors 3. The Batching API Expand section "3. The Batching API" Collapse section "3. The Batching API" 3.1. About the Batching API 3.2. About Java Transaction API Transactions 3.3. Batching and the Java Transaction API (JTA) 3.4. Using the Batching API Expand section "3.4. Using the Batching API" Collapse section "3.4. Using the Batching API" 3.4.1. Enable the Batching API 3.4.2. Configure the Batching API 3.4.3. Use the Batching API 3.4.4. Batching API Usage Example 4. The Grouping API Expand section "4. The Grouping API" Collapse section "4. The Grouping API" 4.1. About the Grouping API 4.2. Grouping API Operations 4.3. Grouping API Configuration 5. The CacheStore and ConfigurationBuilder APIs Expand section "5. The CacheStore and ConfigurationBuilder APIs" Collapse section "5. The CacheStore and ConfigurationBuilder APIs" 5.1. About the CacheStore API 5.2. The ConfigurationBuilder API Expand section "5.2. The ConfigurationBuilder API" Collapse section "5.2. The ConfigurationBuilder API" 5.2.1. About the ConfigurationBuilder API 5.2.2. Using the ConfigurationBuilder API 6. The Externalizable API Expand section "6. The Externalizable API" Collapse section "6. The Externalizable API" 6.1. About Externalizer 6.2. About the Externalizable API 6.3. Using the Externalizable API Expand section "6.3. Using the Externalizable API" Collapse section "6.3. Using the Externalizable API" 6.3.1. The Externalizable API Usage 6.3.2. The Externalizable API Configuration Example 6.3.3. Linking Externalizers with Marshaller Classes 6.4. The AdvancedExternalizer Expand section "6.4. The AdvancedExternalizer" Collapse section "6.4. The AdvancedExternalizer" 6.4.1. About the AdvancedExternalizer 6.4.2. AdvancedExternalizer Example Configuration 6.4.3. Externalizer Identifiers 6.4.4. Registering Advanced Externalizers 6.4.5. Register Multiple Externalizers Programmatically 6.5. Internal Externalizer Implementation Access Expand section "6.5. Internal Externalizer Implementation Access" Collapse section "6.5. Internal Externalizer Implementation Access" 6.5.1. Internal Externalizer Implementation Access 7. The Notification/Listener API Expand section "7. The Notification/Listener API" Collapse section "7. The Notification/Listener API" 7.1. About the Listener API 7.2. Listener Example 7.3. Cache Entry Modified Listener Configuration 7.4. Notifications Expand section "7.4. Notifications" Collapse section "7.4. Notifications" 7.4.1. About Listener Notifications 7.4.2. About Cache-level Notifications 7.4.3. Cache Manager-level Notifications 7.4.4. About Synchronous and Asynchronous Notifications 7.5. Notifying Futures Expand section "7.5. Notifying Futures" Collapse section "7.5. Notifying Futures" 7.5.1. About NotifyingFutures 7.5.2. NotifyingFutures Example II. Remote Client-Server Mode Interfaces Expand section "II. Remote Client-Server Mode Interfaces" Collapse section "II. Remote Client-Server Mode Interfaces" 8. The Asynchronous API Expand section "8. The Asynchronous API" Collapse section "8. The Asynchronous API" 8.1. About the Asynchronous API 8.2. Asynchronous API Benefits 8.3. About Asynchronous Processes 8.4. Return Values and the Asynchronous API 9. The REST Interface Expand section "9. The REST Interface" Collapse section "9. The REST Interface" 9.1. About the REST Interface in JBoss Data Grid 9.2. Ruby Client Code 9.3. Using JSON with Ruby Example 9.4. Python Client Code 9.5. Java Client Code 9.6. Configure the REST Interface Expand section "9.6. Configure the REST Interface" Collapse section "9.6. Configure the REST Interface" 9.6.1. About JBoss Data Grid Connectors 9.6.2. Configure REST Connectors 9.6.3. REST Connector Attributes 9.7. Using the REST Interface Expand section "9.7. Using the REST Interface" Collapse section "9.7. Using the REST Interface" 9.7.1. REST Interface Operations 9.7.2. Adding Data 9.7.3. Retrieving Data 9.7.4. Removing Data 9.7.5. REST Interface Operation Headers 9.8. REST Interface Security Expand section "9.8. REST Interface Security" Collapse section "9.8. REST Interface Security" 9.8.1. Enable Security for the REST Endpoint 10. The Memcached Interface Expand section "10. The Memcached Interface" Collapse section "10. The Memcached Interface" 10.1. About the Memcached Protocol 10.2. About Memcached Servers in JBoss Data Grid 10.3. Using the Memcached Interface Expand section "10.3. Using the Memcached Interface" Collapse section "10.3. Using the Memcached Interface" 10.3.1. Memcached Statistics 10.4. Configure the Memcached Interface Expand section "10.4. Configure the Memcached Interface" Collapse section "10.4. Configure the Memcached Interface" 10.4.1. About JBoss Data Grid Connectors 10.4.2. Configure Memcached Connectors 10.4.3. Memcached Connector Attributes 11. The Hot Rod Interface Expand section "11. The Hot Rod Interface" Collapse section "11. The Hot Rod Interface" 11.1. About Hot Rod 11.2. The Benefits of Using Hot Rod over Memcached 11.3. About Hot Rod Servers in JBoss Data Grid 11.4. Hot Rod Hash Functions 11.5. Hot Rod Server Nodes Expand section "11.5. Hot Rod Server Nodes" Collapse section "11.5. Hot Rod Server Nodes" 11.5.1. About Consistent Hashing Algorithms 11.5.2. The hotrod.properties File 11.6. Hot Rod Headers Expand section "11.6. Hot Rod Headers" Collapse section "11.6. Hot Rod Headers" 11.6.1. Hot Rod Header Data Types 11.6.2. Request Header 11.6.3. Response Header 11.6.4. Topology Change Headers 11.7. Hot Rod Operations Expand section "11.7. Hot Rod Operations" Collapse section "11.7. Hot Rod Operations" 11.7.1. Hot Rod Operations 11.7.2. Hot Rod Get Operation 11.7.3. Hot Rod BulkGet Operation 11.7.4. Hot Rod GetWithVersion Operation 11.7.5. Hot Rod Put Operation 11.7.6. Hot Rod PutIfAbsent Operation 11.7.7. Hot Rod Remove Operation 11.7.8. Hot Rod RemoveIfUnmodified Operation 11.7.9. Hot Rod Replace Operation 11.7.10. Hot Rod ReplaceIfUnmodified Operation 11.7.11. Hot Rod Clear Operation 11.7.12. Hot Rod ContainsKey Operation 11.7.13. Hot Rod Ping Operation 11.7.14. Hot Rod Stats Operation 11.7.15. Hot Rod Operation Values 11.8. Examples Expand section "11.8. Examples" Collapse section "11.8. Examples" 11.8.1. Put Request Example 11.9. Configure the Hot Rod Interface Expand section "11.9. Configure the Hot Rod Interface" Collapse section "11.9. Configure the Hot Rod Interface" 11.9.1. About JBoss Data Grid Connectors 11.9.2. Configure Hot Rod Connectors 11.9.3. Hot Rod Connector Attributes 12. The RemoteCache Interface Expand section "12. The RemoteCache Interface" Collapse section "12. The RemoteCache Interface" 12.1. About the RemoteCache Interface 12.2. Create a New RemoteCacheManager III. Rolling Upgrades Expand section "III. Rolling Upgrades" Collapse section "III. Rolling Upgrades" 13. Rolling Upgrades in JBoss Data Grid Expand section "13. Rolling Upgrades in JBoss Data Grid" Collapse section "13. Rolling Upgrades in JBoss Data Grid" 13.1. About Rolling Upgrades 13.2. Rolling Upgrades Using Hot Rod (Remote Client-Server Mode) 13.3. RollingUpgradeManager Operations IV. The Infinispan CDI Module Expand section "IV. The Infinispan CDI Module" Collapse section "IV. The Infinispan CDI Module" 14. The Infinispan CDI Module Expand section "14. The Infinispan CDI Module" Collapse section "14. The Infinispan CDI Module" 14.1. About Infinspan CDI 14.2. Using Infinispan CDI Expand section "14.2. Using Infinispan CDI" Collapse section "14.2. Using Infinispan CDI" 14.2.1. Infinispan CDI Prerequisites 14.2.2. Set the CDI Maven Dependency 14.3. Using the Infinispan CDI Module Expand section "14.3. Using the Infinispan CDI Module" Collapse section "14.3. Using the Infinispan CDI Module" 14.3.1. Using the Infinispan CDI Module 14.3.2. Configure and Inject Infinispan Caches 14.3.3. Configure Cache Managers 14.3.4. Storage and Retrieval Using CDI Annotations 14.3.5. Cache Operations V. Querying in JBoss Data Grid Expand section "V. Querying in JBoss Data Grid" Collapse section "V. Querying in JBoss Data Grid" 15. The Query Module Expand section "15. The Query Module" Collapse section "15. The Query Module" 15.1. About the Query Module 15.2. Apache Lucene and Infinispan Query 15.3. About Lucene Directory 15.4. Infinispan Query Expand section "15.4. Infinispan Query" Collapse section "15.4. Infinispan Query" 15.4.1. Infinispan Query in JBoss Data Grid 15.4.2. Infinispan Query Dependencies for JBoss Data Grid 15.4.3. Configuring Infinispan Query for JBoss Data Grid 15.5. Configuring the Query Module Expand section "15.5. Configuring the Query Module" Collapse section "15.5. Configuring the Query Module" 15.5.1. Configure the Query Module 15.5.2. Configure Indexing using XML 15.5.3. Configure Indexing Programmatically 15.5.4. Rebuilding the Index 15.6. Annotating Objects and Storing Indexes Expand section "15.6. Annotating Objects and Storing Indexes" Collapse section "15.6. Annotating Objects and Storing Indexes" 15.6.1. Annotating Objects for Infinispan Query 15.6.2. Registering a Transformer via Annotations 15.7. Cache Modes and Storing Indexes Expand section "15.7. Cache Modes and Storing Indexes" Collapse section "15.7. Cache Modes and Storing Indexes" 15.7.1. Storing Lucene Indexes 15.7.2. The Infinispan Directory 15.7.3. Cache Modes and Managing Indexes 15.7.4. Storing Global Indexes Locally 15.7.5. Sharing the Global Index 15.8. Querying Example Expand section "15.8. Querying Example" Collapse section "15.8. Querying Example" 15.8.1. The Query Module Example VI. MapReduce and Distributed Tasks Expand section "VI. MapReduce and Distributed Tasks" Collapse section "VI. MapReduce and Distributed Tasks" 16. MapReduce Expand section "16. MapReduce" Collapse section "16. MapReduce" 16.1. About MapReduce 16.2. The MapReduce API Expand section "16.2. The MapReduce API" Collapse section "16.2. The MapReduce API" 16.2.1. The MapReduce API 16.2.2. MapReduceTask 16.2.3. Mapper and CDI 16.3. MapReduceTask Distributed Execution Expand section "16.3. MapReduceTask Distributed Execution" Collapse section "16.3. MapReduceTask Distributed Execution" 16.3.1. MapReduceTask Distributed Execution 16.4. Map Reduce Example 17. Distributed Execution Expand section "17. Distributed Execution" Collapse section "17. Distributed Execution" 17.1. About Distributed Execution 17.2. DistributedCallable API 17.3. Callable and CDI 17.4. Distributed Task Failover 17.5. Distributed Task Execution Policy 17.6. Distributed Execution Example VII. Marshalling in JBoss Data Grid Expand section "VII. Marshalling in JBoss Data Grid" Collapse section "VII. Marshalling in JBoss Data Grid" 18. Marshalling Expand section "18. Marshalling" Collapse section "18. Marshalling" 18.1. About Marshalling 18.2. Marshalling Benefits 18.3. About Marshalling Framework 18.4. Support for Non-Serializable Objects 18.5. Hot Rod and Marshalling 18.6. Configuring the Marshaller using the RemoteCacheManager 18.7. Troubleshooting Expand section "18.7. Troubleshooting" Collapse section "18.7. Troubleshooting" 18.7.1. Marshalling Troubleshooting 18.7.2. State Receiver EOFExceptions VIII. Transactions Expand section "VIII. Transactions" Collapse section "VIII. Transactions" 19. Transactions Expand section "19. Transactions" Collapse section "19. Transactions" 19.1. About Java Transaction API Transactions 19.2. Transactions Spanning Multiple Cache Instances 19.3. Transaction/Batching and Invalidation Messages 20. The Transaction Manager Expand section "20. The Transaction Manager" Collapse section "20. The Transaction Manager" 20.1. About JTA Transaction Manager Lookup Classes 20.2. Obtain the Transaction Manager From the Cache 20.3. Transaction Manager and XAResources 20.4. Obtain a XAResource Reference 20.5. Default Distributed Transaction Behavior 20.6. Transaction Synchronization Expand section "20.6. Transaction Synchronization" Collapse section "20.6. Transaction Synchronization" 20.6.1. About Transaction Synchronizations 21. Deadlock Detection Expand section "21. Deadlock Detection" Collapse section "21. Deadlock Detection" 21.1. About Deadlock Detection 21.2. Enable Deadlock Detection IX. Listeners and Notifications Expand section "IX. Listeners and Notifications" Collapse section "IX. Listeners and Notifications" 22. Listeners and Notifications Expand section "22. Listeners and Notifications" Collapse section "22. Listeners and Notifications" 22.1. About the Listener API 22.2. Listener Example 22.3. Cache Entry Modified Listener Configuration 22.4. Notifications Expand section "22.4. Notifications" Collapse section "22.4. Notifications" 22.4.1. About Listener Notifications 22.4.2. About Cache-level Notifications 22.4.3. Cache Manager-level Notifications 22.4.4. About Synchronous and Asynchronous Notifications 22.5. Notifying Futures Expand section "22.5. Notifying Futures" Collapse section "22.5. Notifying Futures" 22.5.1. About NotifyingFutures 22.5.2. NotifyingFutures Example X. The Infinispan CLI Expand section "X. The Infinispan CLI" Collapse section "X. The Infinispan CLI" 23. The Infinispan CLI Expand section "23. The Infinispan CLI" Collapse section "23. The Infinispan CLI" 23.1. About the Infinispan CLI 23.2. Start the CLI (Server) 23.3. Start the CLI (Client) 23.4. CLI Client Switches for the Command Line 23.5. Connect to the Application 23.6. CLI Commands Expand section "23.6. CLI Commands" Collapse section "23.6. CLI Commands" 23.6.1. The abort Command 23.6.2. The begin Command 23.6.3. The cache Command 23.6.4. The clear Command 23.6.5. The commit Command 23.6.6. The container Command 23.6.7. The create Command 23.6.8. The disconnect Command 23.6.9. The encoding Command 23.6.10. The end Command 23.6.11. The evict Command 23.6.12. The get Command 23.6.13. The info Command 23.6.14. The locate Command 23.6.15. The put Command 23.6.16. The replace Command 23.6.17. The rollback Command 23.6.18. The site Command 23.6.19. The start Command 23.6.20. The stats Command 23.6.21. The upgrade Command 23.6.22. The version Command A. 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 Part I. Programmable APIs Previous Next