Jump To Close Expand all Collapse all Table of contents Administration and Configuration Guide I. Introduction Expand section "I. Introduction" Collapse section "I. Introduction" 1. Setting up Red Hat JBoss Data Grid Expand section "1. Setting up Red Hat JBoss Data Grid" Collapse section "1. Setting up Red Hat JBoss Data Grid" 1.1. Prerequisites 1.2. Steps to Set up Red Hat JBoss Data Grid II. Managing JVM Memory Expand section "II. Managing JVM Memory" Collapse section "II. Managing JVM Memory" 2. Eviction and Expiration Expand section "2. Eviction and Expiration" Collapse section "2. Eviction and Expiration" 2.1. Overview of Eviction and Expiration 2.2. Configuring Eviction Expand section "2.2. Configuring Eviction" Collapse section "2.2. Configuring Eviction" 2.2.1. Eviction Types 2.2.2. Storage Types 2.2.3. Adding the Memory Element 2.2.4. Specifying the Storage Type 2.2.5. Specifying the Eviction Type 2.2.6. Setting the Cache Size 2.2.7. Tuning the Off Heap Configuration 2.2.8. Setting the Eviction Strategy Expand section "2.2.8. Setting the Eviction Strategy" Collapse section "2.2.8. Setting the Eviction Strategy" 2.2.8.1. Eviction Strategies 2.2.9. Configuring Passivation 2.3. Configuring Expiration Expand section "2.3. Configuring Expiration" Collapse section "2.3. Configuring Expiration" 2.3.1. Expiration Parameters 2.3.2. Configuring Expiration 2.3.3. Expiration Behavior III. Monitoring Your Cache Expand section "III. Monitoring Your Cache" Collapse section "III. Monitoring Your Cache" 3. Set Up Logging Expand section "3. Set Up Logging" Collapse section "3. Set Up Logging" 3.1. About Logging 3.2. Supported Application Logging Frameworks Expand section "3.2. Supported Application Logging Frameworks" Collapse section "3.2. Supported Application Logging Frameworks" 3.2.1. Supported Application Logging Frameworks 3.2.2. About JBoss Logging 3.2.3. JBoss Logging Features 3.3. Boot Logging Expand section "3.3. Boot Logging" Collapse section "3.3. Boot Logging" 3.3.1. Boot Logging 3.3.2. Configure Boot Logging 3.3.3. Default Log File Locations 3.4. Logging Attributes Expand section "3.4. Logging Attributes" Collapse section "3.4. Logging Attributes" 3.4.1. About Log Levels 3.4.2. Supported Log Levels 3.4.3. About Log Categories 3.4.4. About the Root Logger 3.4.5. About Log Handlers 3.4.6. Log Handler Types 3.4.7. Selecting Log Handlers 3.4.8. About Log Formatters 3.5. Logging Sample Configurations Expand section "3.5. Logging Sample Configurations" Collapse section "3.5. Logging Sample Configurations" 3.5.1. Logging Sample Configuration Location 3.5.2. Sample XML Configuration for the Root Logger 3.5.3. Sample XML Configuration for a Log Category 3.5.4. Sample XML Configuration for a Console Log Handler 3.5.5. Sample XML Configuration for a File Log Handler 3.5.6. Sample XML Configuration for a Periodic Log Handler 3.5.7. Sample XML Configuration for a Size Log Handler 3.5.8. Sample XML Configuration for a Async Log Handler IV. Set Up Cache Modes Expand section "IV. Set Up Cache Modes" Collapse section "IV. Set Up Cache Modes" 4. Cache Modes Expand section "4. Cache Modes" Collapse section "4. Cache Modes" 4.1. Cache Modes 4.2. About Cache Containers 4.3. Local Mode Expand section "4.3. Local Mode" Collapse section "4.3. Local Mode" 4.3.1. Local Mode 4.3.2. Configure Local Mode 4.4. Clustered Modes Expand section "4.4. Clustered Modes" Collapse section "4.4. Clustered Modes" 4.4.1. Clustered Modes 4.4.2. Asynchronous and Synchronous Operations 4.4.3. About Asynchronous Communications 4.4.4. Cache Mode Troubleshooting Expand section "4.4.4. Cache Mode Troubleshooting" Collapse section "4.4.4. Cache Mode Troubleshooting" 4.4.4.1. Invalid Data in ReadExternal 4.4.4.2. Cluster Physical Address Retrieval 5. Set Up Distribution Mode Expand section "5. Set Up Distribution Mode" Collapse section "5. Set Up Distribution Mode" 5.1. About Distribution Mode 5.2. Consistent Hashing in Distribution Mode 5.3. Locating Entries in Distribution Mode 5.4. Return Values in Distribution Mode 5.5. Configure Distribution Mode 5.6. Synchronous and Asynchronous Distribution 6. Set Up Replication Mode Expand section "6. Set Up Replication Mode" Collapse section "6. Set Up Replication Mode" 6.1. About Replication Mode 6.2. Optimized Replication Mode Usage 6.3. Configure Replication Mode 6.4. Synchronous and Asynchronous Replication Expand section "6.4. Synchronous and Asynchronous Replication" Collapse section "6.4. Synchronous and Asynchronous Replication" 6.4.1. Synchronous and Asynchronous Replication 6.4.2. Troubleshooting Asynchronous Replication Behavior 6.5. The Replication Queue Expand section "6.5. The Replication Queue" Collapse section "6.5. The Replication Queue" 6.5.1. The Replication Queue 6.5.2. Replication Queue Usage 6.6. About Replication Guarantees 6.7. Replication Traffic on Internal Networks 7. Set Up Invalidation Mode Expand section "7. Set Up Invalidation Mode" Collapse section "7. Set Up Invalidation Mode" 7.1. About Invalidation Mode 7.2. Configure Invalidation Mode 7.3. Synchronous/Asynchronous Invalidation 7.4. The L1 Cache and Invalidation 8. State Transfer Expand section "8. State Transfer" Collapse section "8. State Transfer" 8.1. State Transfer 8.2. Non-Blocking State Transfer 8.3. Suppress State Transfer via JMX 8.4. The rebalancingEnabled Attribute V. Enabling APIs Expand section "V. Enabling APIs" Collapse section "V. Enabling APIs" 9. Enabling APIs Declaratively Expand section "9. Enabling APIs Declaratively" Collapse section "9. Enabling APIs Declaratively" 9.1. Enabling APIs Declaratively 9.2. Batching API 9.3. Grouping API 9.4. Externalizable API Expand section "9.4. Externalizable API" Collapse section "9.4. Externalizable API" 9.4.1. The Externalizable API 9.4.2. Register the Advanced Externalizer (Declaratively) 9.4.3. Configuring the Deserialization Whitelist 9.4.4. Custom Externalizer ID Values Expand section "9.4.4. Custom Externalizer ID Values" Collapse section "9.4.4. Custom Externalizer ID Values" 9.4.4.1. Custom Externalizer ID Values 9.4.4.2. Customize the Externalizer ID (Declaratively) 10. Set Up and Configure the Infinispan Query API Expand section "10. Set Up and Configure the Infinispan Query API" Collapse section "10. Set Up and Configure the Infinispan Query API" 10.1. Set Up Infinispan Query Expand section "10.1. Set Up Infinispan Query" Collapse section "10.1. Set Up Infinispan Query" 10.1.1. Infinispan Query Dependencies in Library Mode 10.2. Directory Providers Expand section "10.2. Directory Providers" Collapse section "10.2. Directory Providers" 10.2.1. Directory Providers 10.2.2. RAM Directory Provider 10.2.3. Filesystem Directory Provider 10.2.4. Infinispan Directory Provider 10.3. Configure Indexing Expand section "10.3. Configure Indexing" Collapse section "10.3. Configure Indexing" 10.3.1. Configure the Index in Remote Client-Server Mode 10.3.2. Automatic Indexing 10.3.3. Rebuilding the Index 10.4. Tuning the Index Expand section "10.4. Tuning the Index" Collapse section "10.4. Tuning the Index" 10.4.1. Near-Realtime Index Manager 10.4.2. Tuning Infinispan Directory 10.4.3. Per-Index Configuration 11. The Health Check API Expand section "11. The Health Check API" Collapse section "11. The Health Check API" 11.1. The Health Check API 11.2. Accessing the Health API using JMX 11.3. Accessing the Health Check API using the CLI 11.4. Accessing the Health Check API using the Management REST Interface VI. Remote Client-Server Mode Interfaces Expand section "VI. Remote Client-Server Mode Interfaces" Collapse section "VI. Remote Client-Server Mode Interfaces" 12. Remote Client-Server Mode Interfaces 13. The Hot Rod Interface Expand section "13. The Hot Rod Interface" Collapse section "13. The Hot Rod Interface" 13.1. About Hot Rod 13.2. The Benefits of Using Hot Rod over Memcached 13.3. Hot Rod Hash Functions 13.4. The Hot Rod Interface Connector Expand section "13.4. The Hot Rod Interface Connector" Collapse section "13.4. The Hot Rod Interface Connector" 13.4.1. The Hot Rod Interface Connector 13.4.2. Configure Hot Rod Connectors 14. The REST Interface Expand section "14. The REST Interface" Collapse section "14. The REST Interface" 14.1. The REST Interface 14.2. The REST Interface Connector Expand section "14.2. The REST Interface Connector" Collapse section "14.2. The REST Interface Connector" 14.2.1. The REST Interface Connector 14.2.2. Configure REST Connectors 15. The Memcached Interface Expand section "15. The Memcached Interface" Collapse section "15. The Memcached Interface" 15.1. The Memcached Interface 15.2. About Memcached Servers 15.3. Memcached Statistics 15.4. The Memcached Interface Connector Expand section "15.4. The Memcached Interface Connector" Collapse section "15.4. The Memcached Interface Connector" 15.4.1. The Memcached Interface Connector 15.4.2. Configure Memcached Connectors VII. Set Up Locking for the Cache Expand section "VII. Set Up Locking for the Cache" Collapse section "VII. Set Up Locking for the Cache" 16. Locking Expand section "16. Locking" Collapse section "16. Locking" 16.1. Locking 16.2. Configure Locking (Remote Client-Server Mode) 16.3. Configure Locking (Library Mode) 16.4. Locking Types Expand section "16.4. Locking Types" Collapse section "16.4. Locking Types" 16.4.1. About Optimistic Locking 16.4.2. About Pessimistic Locking 16.4.3. Pessimistic Locking Types 16.4.4. Explicit Pessimistic Locking Example 16.4.5. Implicit Pessimistic Locking Example 16.4.6. Configure Locking Mode (Remote Client-Server Mode) 16.4.7. Configure Locking Mode (Library Mode) 16.5. Locking Operations Expand section "16.5. Locking Operations" Collapse section "16.5. Locking Operations" 16.5.1. About the LockManager 16.5.2. About Lock Acquisition 16.5.3. About Concurrency Levels 17. Set Up Lock Striping Expand section "17. Set Up Lock Striping" Collapse section "17. Set Up Lock Striping" 17.1. About Lock Striping 17.2. Configure Lock Striping (Remote Client-Server Mode) 17.3. Configure Lock Striping (Library Mode) 18. Set Up Isolation Levels Expand section "18. Set Up Isolation Levels" Collapse section "18. Set Up Isolation Levels" 18.1. About Isolation Levels 18.2. About READ_COMMITTED 18.3. About REPEATABLE_READ VIII. Set Up and Configure a Cache Store Expand section "VIII. Set Up and Configure a Cache Store" Collapse section "VIII. Set Up and Configure a Cache Store" 19. Cache Stores Expand section "19. Cache Stores" Collapse section "19. Cache Stores" 19.1. Cache Stores 19.2. Cache Loaders and Cache Writers 19.3. Cache Store Configuration Expand section "19.3. Cache Store Configuration" Collapse section "19.3. Cache Store Configuration" 19.3.1. Configuring the Cache Store 19.3.2. Configure the Cache Store using XML (Library Mode) 19.3.3. About SKIP_CACHE_LOAD Flag 19.3.4. About the SKIP_CACHE_STORE Flag 19.3.5. About the SKIP_SHARED_CACHE_STORE Flag 19.4. Shared Cache Stores Expand section "19.4. Shared Cache Stores" Collapse section "19.4. Shared Cache Stores" 19.4.1. Shared Cache Stores 19.4.2. Invalidation Mode and Shared Cache Stores 19.4.3. The Cache Store and Cache Passivation 19.4.4. Application Cachestore Registration 19.5. Connection Factories Expand section "19.5. Connection Factories" Collapse section "19.5. Connection Factories" 19.5.1. Connection Factories 19.5.2. About ManagedConnectionFactory 19.5.3. About SimpleConnectionFactory 19.5.4. About PooledConnectionFactory 20. Cache Store Implementations Expand section "20. Cache Store Implementations" Collapse section "20. Cache Store Implementations" 20.1. Cache Stores 20.2. Cache Store Comparison 20.3. Cache Store Configuration Details (Library Mode) 20.4. Cache Store Configuration Details (Remote Client-Server Mode) 20.5. Single File Cache Store Expand section "20.5. Single File Cache Store" Collapse section "20.5. Single File Cache Store" 20.5.1. Single File Cache Store 20.5.2. Single File Store Configuration (Remote Client-Server Mode) 20.5.3. Single File Store Configuration (Library Mode) 20.5.4. Upgrade JBoss Data Grid Cache Stores 20.6. LevelDB Cache Store Expand section "20.6. LevelDB Cache Store" Collapse section "20.6. LevelDB Cache Store" 20.6.1. LevelDB Cache Store 20.6.2. Configuring LevelDB Cache Store (Remote Client-Server Mode) 20.6.3. LevelDB Cache Store Sample XML Configuration (Library Mode) 20.6.4. Configure a LevelDB Cache Store Using JBoss Operations Network 20.7. JDBC Based Cache Stores Expand section "20.7. JDBC Based Cache Stores" Collapse section "20.7. JDBC Based Cache Stores" 20.7.1. JDBC Based Cache Stores 20.7.2. JdbcBinaryStores Expand section "20.7.2. JdbcBinaryStores" Collapse section "20.7.2. JdbcBinaryStores" 20.7.2.1. JdbcBinaryStores 20.7.2.2. JdbcBinaryStore Configuration (Remote Client-Server Mode) 20.7.2.3. JdbcBinaryStore Configuration (Library Mode) 20.7.3. JdbcStringBasedStores Expand section "20.7.3. JdbcStringBasedStores" Collapse section "20.7.3. JdbcStringBasedStores" 20.7.3.1. JdbcStringBasedStores 20.7.3.2. JdbcStringBasedStore Configuration (Remote Client-Server Mode) 20.7.3.3. JdbcStringBasedStore Configuration (Library Mode) 20.7.3.4. JdbcStringBasedStore Multiple Node Configuration (Remote Client-Server Mode) 20.7.4. JdbcMixedStores Expand section "20.7.4. JdbcMixedStores" Collapse section "20.7.4. JdbcMixedStores" 20.7.4.1. JdbcMixedStores 20.7.4.2. JdbcMixedStore Configuration (Remote Client-Server Mode) 20.7.4.3. JdbcMixedStore Configuration (Library Mode) 20.7.5. Cache Store Troubleshooting Expand section "20.7.5. Cache Store Troubleshooting" Collapse section "20.7.5. Cache Store Troubleshooting" 20.7.5.1. IOExceptions with JdbcStringBasedStore 20.8. The Remote Cache Store Expand section "20.8. The Remote Cache Store" Collapse section "20.8. The Remote Cache Store" 20.8.1. Remote Cache Stores 20.8.2. Remote Cache Store Configuration (Remote Client-Server Mode) 20.8.3. Remote Cache Store Configuration (Library Mode) 20.8.4. Define the Outbound Socket for the Remote Cache Store 20.9. JPA Cache Store Expand section "20.9. JPA Cache Store" Collapse section "20.9. JPA Cache Store" 20.9.1. JPA Cache Stores 20.9.2. JPA Cache Store Sample XML Configuration (Library Mode) 20.9.3. Storing Metadata in the Database 20.9.4. Deploying JPA Cache Stores in Various Containers 20.10. Cassandra Cache Store Expand section "20.10. Cassandra Cache Store" Collapse section "20.10. Cassandra Cache Store" 20.10.1. Cassandra Cache Store 20.10.2. Enabling the Cassandra Cache Store 20.10.3. Cassandra Cache Store Sample XML Configuration (Remote Client-Server Mode) 20.10.4. Cassandra Cache Store Sample XML Configuration (Library Mode) 20.10.5. Cassandra Configuration Parameters 20.11. Custom Cache Stores Expand section "20.11. Custom Cache Stores" Collapse section "20.11. Custom Cache Stores" 20.11.1. Custom Cache Stores 20.11.2. Custom Cache Store Maven Archetype 20.11.3. Custom Cache Store Configuration (Remote Client-Server Mode) Expand section "20.11.3. Custom Cache Store Configuration (Remote Client-Server Mode)" Collapse section "20.11.3. Custom Cache Store Configuration (Remote Client-Server Mode)" 20.11.3.1. Custom Cache Store Configuration (Remote Client-Server Mode) 20.11.3.2. Option 1: Add Custom Cache Store using deployments (Remote Client-Server Mode) 20.11.3.3. Option 2: Add Custom Cache Store using the CLI (Remote Client-Server Mode) 20.11.3.4. Option 3: Add Custom Cache Store using JON (Remote Client-Server Mode) 20.11.4. Custom Cache Store Configuration (Library Mode) IX. Set Up Passivation Expand section "IX. Set Up Passivation" Collapse section "IX. Set Up Passivation" 21. Activation and Passivation Modes Expand section "21. Activation and Passivation Modes" Collapse section "21. Activation and Passivation Modes" 21.1. Activation and Passivation Modes 21.2. Passivation Mode Benefits 21.3. Configure Passivation 21.4. Evication and Passivation Expand section "21.4. Evication and Passivation" Collapse section "21.4. Evication and Passivation" 21.4.1. Eviction and Passivation 21.4.2. Eviction and Passivation Usage 21.4.3. Cache Loader Behavior with Passivation Disabled vs Enabled 21.4.4. Eviction Examples X. Set Up Cache Writing Expand section "X. Set Up Cache Writing" Collapse section "X. Set Up Cache Writing" 22. Cache Writing Modes Expand section "22. Cache Writing Modes" Collapse section "22. Cache Writing Modes" 22.1. Cache Writing Modes 22.2. Write-Through Caching Expand section "22.2. Write-Through Caching" Collapse section "22.2. Write-Through Caching" 22.2.1. Write-Through Caching 22.2.2. Write-Through Caching Benefits and Disadvantages 22.2.3. Write-Through Caching Configuration (Library Mode) 22.3. Write-Behind Caching Expand section "22.3. Write-Behind Caching" Collapse section "22.3. Write-Behind Caching" 22.3.1. Write-Behind Caching 22.3.2. About Unscheduled Write-Behind Strategy 22.3.3. Unscheduled Write-Behind Strategy Configuration (Remote Client-Server Mode) 22.3.4. Unscheduled Write-Behind Strategy Configuration (Library Mode) XI. Monitor Caches and Cache Managers Expand section "XI. Monitor Caches and Cache Managers" Collapse section "XI. Monitor Caches and Cache Managers" 23. Set Up Java Management Extensions (JMX) Expand section "23. Set Up Java Management Extensions (JMX)" Collapse section "23. Set Up Java Management Extensions (JMX)" 23.1. About Java Management Extensions (JMX) 23.2. Using JMX with Red Hat JBoss Data Grid 23.3. JMX Statistic Levels 23.4. Enabling JMX for Cache Instances 23.5. Enabling JMX for CacheManagers 23.6. Disabling the CacheStore via JMX When Using Rolling Upgrades 23.7. Multiple JMX Domains 23.8. MBeans Expand section "23.8. MBeans" Collapse section "23.8. MBeans" 23.8.1. MBeans 23.8.2. Understanding MBeans 23.8.3. Registering MBeans in Non-Default MBean Servers 24. Set Up JBoss Operations Network (JON) Expand section "24. Set Up JBoss Operations Network (JON)" Collapse section "24. Set Up JBoss Operations Network (JON)" 24.1. About JBoss Operations Network (JON) 24.2. Download JBoss Operations Network (JON) Expand section "24.2. Download JBoss Operations Network (JON)" Collapse section "24.2. Download JBoss Operations Network (JON)" 24.2.1. Prerequisites for Installing JBoss Operations Network (JON) 24.2.2. Download JBoss Operations Network 24.2.3. Remote JMX Port Values 24.2.4. Download JBoss Operations Network (JON) Plugin 24.3. JBoss Operations Network Server Installation 24.4. JBoss Operations Network Agent 24.5. JBoss Operations Network for Remote Client-Server Mode Expand section "24.5. JBoss Operations Network for Remote Client-Server Mode" Collapse section "24.5. JBoss Operations Network for Remote Client-Server Mode" 24.5.1. JBoss Operations Network for Remote Client-Server Mode 24.5.2. Installing the JBoss Operations Network Plug-in (Remote Client-Server Mode) 24.6. JBoss Operations Network Remote-Client Server Plugin Expand section "24.6. JBoss Operations Network Remote-Client Server Plugin" Collapse section "24.6. JBoss Operations Network Remote-Client Server Plugin" 24.6.1. JBoss Operations Network Plugin Metrics 24.6.2. JBoss Operations Network Plugin Operations 24.6.3. JBoss Operations Network Plugin Attributes 24.6.4. Create a New Cache Using JBoss Operations Network (JON) 24.7. JBoss Operations Network for Library Mode Expand section "24.7. JBoss Operations Network for Library Mode" Collapse section "24.7. JBoss Operations Network for Library Mode" 24.7.1. JBoss Operations Network for Library Mode 24.7.2. Installing the JBoss Operations Network Plug-in (Library Mode) 24.7.3. Monitoring of JBoss Data Grid Instances in Library Mode Expand section "24.7.3. Monitoring of JBoss Data Grid Instances in Library Mode" Collapse section "24.7.3. Monitoring of JBoss Data Grid Instances in Library Mode" 24.7.3.1. Prerequisites 24.7.3.2. Manually Adding JBoss Data Grid Instances in Library Mode 24.7.3.3. Monitor Custom Applications Using Library Mode Deployed On JBoss Enterprise Application Platform Expand section "24.7.3.3. Monitor Custom Applications Using Library Mode Deployed On JBoss Enterprise Application Platform" Collapse section "24.7.3.3. Monitor Custom Applications Using Library Mode Deployed On JBoss Enterprise Application Platform" 24.7.3.3.1. Monitor an Application Deployed in Standalone Mode 24.7.3.3.2. Monitor an Application Deployed in Domain Mode 24.8. JBoss Operations Network Plug-in Quickstart 24.9. Other Management Tools and Operations Expand section "24.9. Other Management Tools and Operations" Collapse section "24.9. Other Management Tools and Operations" 24.9.1. Other Management Tools and Operations 24.9.2. Accessing Data via URLs 24.9.3. Limitations of Map Methods XII. Red Hat JBoss Data Grid Web Administration Expand section "XII. Red Hat JBoss Data Grid Web Administration" Collapse section "XII. Red Hat JBoss Data Grid Web Administration" 25. Red Hat JBoss Data Grid Administration Console Expand section "25. Red Hat JBoss Data Grid Administration Console" Collapse section "25. Red Hat JBoss Data Grid Administration Console" 25.1. About JBoss Data Grid Administration Console 25.2. Red Hat JBoss Data Grid Administration Console Prerequisites 25.3. Red Hat JBoss Data Grid Administation Console Getting Started Expand section "25.3. Red Hat JBoss Data Grid Administation Console Getting Started" Collapse section "25.3. Red Hat JBoss Data Grid Administation Console Getting Started" 25.3.1. Red Hat JBoss Data Grid Administration Console Getting Started 25.3.2. Adding Management User 25.3.3. Logging in the JBoss Data Grid Administration Console 25.4. Dashboard View Expand section "25.4. Dashboard View" Collapse section "25.4. Dashboard View" 25.4.1. Dashboard View 25.4.2. Cache Containers View 25.4.3. Clusters View 25.4.4. Status Events View 25.5. Cache Administration Expand section "25.5. Cache Administration" Collapse section "25.5. Cache Administration" 25.5.1. Adding a New Cache 25.5.2. Editing Cache Configuration 25.5.3. Cache Statistics and Properties View 25.5.4. Enable and Disable Caches 25.5.5. Cache Flush and Clear 25.5.6. Server Tasks Execution 25.5.7. Server Tasks Expand section "25.5.7. Server Tasks" Collapse section "25.5.7. Server Tasks" 25.5.7.1. New Server Task 25.5.7.2. Server Tasks View 25.6. Cache Container Configuration Expand section "25.6. Cache Container Configuration" Collapse section "25.6. Cache Container Configuration" 25.6.1. Cache Container Configuration 25.6.2. Defining Protocol Buffer Schema 25.6.3. Transport Setting 25.6.4. Defining Thread Pools 25.6.5. Adding New Security Role 25.6.6. Creating Cache Configuration Template 25.7. Cluster Administration Expand section "25.7. Cluster Administration" Collapse section "25.7. Cluster Administration" 25.7.1. Cluster Nodes View 25.7.2. Cluster Nodes Mismatch 25.7.3. Cluster Rebalancing 25.7.4. Cluster Partition Handling 25.7.5. Cluster Events 25.7.6. Adding Nodes 25.7.7. Node Statistics and Properties View 25.7.8. Node Performance Metrics View 25.7.9. Disabling a Node 25.7.10. Cluster Shutdown and Restart Expand section "25.7.10. Cluster Shutdown and Restart" Collapse section "25.7.10. Cluster Shutdown and Restart" 25.7.10.1. Cluster Shutdown 25.7.10.2. Cluster Start XIII. Securing Data in Red Hat JBoss Data Grid Expand section "XIII. Securing Data in Red Hat JBoss Data Grid" Collapse section "XIII. Securing Data in Red Hat JBoss Data Grid" 26. Introduction Expand section "26. Introduction" Collapse section "26. Introduction" 26.1. Securing Data in Red Hat JBoss Data Grid 27. Red Hat JBoss Data Grid Security: Authorization and Authentication Expand section "27. Red Hat JBoss Data Grid Security: Authorization and Authentication" Collapse section "27. Red Hat JBoss Data Grid Security: Authorization and Authentication" 27.1. Red Hat JBoss Data Grid Security: Authorization and Authentication 27.2. Permissions 27.3. Role Mapping 27.4. Configuring Authentication and Role Mapping using Login Modules 27.5. Configuring Red Hat JBoss Data Grid for Authorization 27.6. Authorization Using a SecurityManager 27.7. SecurityManager in Java Expand section "27.7. SecurityManager in Java" Collapse section "27.7. SecurityManager in Java" 27.7.1. About the Java Security Manager 27.7.2. About Java Security Manager Policies 27.7.3. Write a Java Security Manager Policy 27.7.4. Run Red Hat JBoss Data Grid Server Within the Java Security Manager 27.8. Data Security for Remote Client Server Mode Expand section "27.8. Data Security for Remote Client Server Mode" Collapse section "27.8. Data Security for Remote Client Server Mode" 27.8.1. About Security Realms 27.8.2. Add a New Security Realm 27.8.3. Add a User to a Security Realm 27.8.4. Configuring Security Realms Declaratively 27.8.5. Loading Roles from LDAP for Authorization (Remote Client-Server Mode) 27.9. Securing Interfaces Expand section "27.9. Securing Interfaces" Collapse section "27.9. Securing Interfaces" 27.9.1. Hot Rod Interface Security Expand section "27.9.1. Hot Rod Interface Security" Collapse section "27.9.1. Hot Rod Interface Security" 27.9.1.1. Publish Hot Rod Endpoints as a Public Interface 27.9.1.2. Encryption of communication between Hot Rod Server and Hot Rod client 27.9.1.3. Securing Hot Rod to LDAP Server using SSL 27.9.1.4. User Authentication over Hot Rod Using SASL Expand section "27.9.1.4. User Authentication over Hot Rod Using SASL" Collapse section "27.9.1.4. User Authentication over Hot Rod Using SASL" 27.9.1.4.1. User Authentication over Hot Rod Using SASL 27.9.1.4.2. Configure Hot Rod Authentication (GSSAPI/Kerberos) 27.9.1.4.3. Configure Hot Rod Authentication (MD5) 27.9.1.4.4. Configure Hot Rod Using LDAP/Active Directory 27.9.1.4.5. Configure Hot Rod Authentication (X.509) 27.9.2. REST Interface Security Expand section "27.9.2. REST Interface Security" Collapse section "27.9.2. REST Interface Security" 27.9.2.1. Publish REST Endpoints as a Public Interface 27.9.2.2. Enable Security for the REST Endpoint 27.9.3. Memcached Interface Security Expand section "27.9.3. Memcached Interface Security" Collapse section "27.9.3. Memcached Interface Security" 27.9.3.1. Publish Memcached Endpoints as a Public Interface 27.10. Active Directory Authentication (Non-Kerberos) 27.11. Active Directory Authentication Using Kerberos (GSSAPI) 27.12. The Security Audit Logger Expand section "27.12. The Security Audit Logger" Collapse section "27.12. The Security Audit Logger" 27.12.1. The Security Audit Logger 27.12.2. Configure the Security Audit Logger (Library Mode) 27.12.3. Configure the Security Audit Logger (Remote Client-Server Mode) 27.12.4. Custom Audit Loggers 28. Security for Cluster Traffic Expand section "28. Security for Cluster Traffic" Collapse section "28. Security for Cluster Traffic" 28.1. Node Authentication and Authorization (Remote Client-Server Mode) Expand section "28.1. Node Authentication and Authorization (Remote Client-Server Mode)" Collapse section "28.1. Node Authentication and Authorization (Remote Client-Server Mode)" 28.1.1. Node Authentication and Authorization (Remote Client-Server Mode) 28.1.2. Configure Node Authentication for Cluster Security (DIGEST-MD5) 28.1.3. Configure Node Authentication for Cluster Security (GSSAPI/Kerberos) 28.2. Configure Node Security in Library Mode Expand section "28.2. Configure Node Security in Library Mode" Collapse section "28.2. Configure Node Security in Library Mode" 28.2.1. Configure Node Security in Library Mode 28.2.2. Simple Authorizing Callback Handler 28.2.3. Configure Node Authentication for Library Mode (DIGEST-MD5) 28.2.4. Configure Node Authentication for Library Mode (GSSAPI) 28.3. JGroups Encryption Expand section "28.3. JGroups Encryption" Collapse section "28.3. JGroups Encryption" 28.3.1. JGroups Encryption 28.3.2. Configuring JGroups Encryption Protocols 28.3.3. SYM_ENCRYPT: Using a Key Store 28.3.4. ASYM_ENCRYPT: Configured with Algorithms and Key Sizes 28.3.5. JGroups Encryption Configuration Parameters XIV. Command Line Tools Expand section "XIV. Command Line Tools" Collapse section "XIV. Command Line Tools" 29. Introduction Expand section "29. Introduction" Collapse section "29. Introduction" 29.1. Command Line Tools 30. Red Hat JBoss Data Grid CLIs Expand section "30. Red Hat JBoss Data Grid CLIs" Collapse section "30. Red Hat JBoss Data Grid CLIs" 30.1. JBoss Data Grid CLIs 30.2. Red Hat JBoss Data Grid Library Mode CLI Expand section "30.2. Red Hat JBoss Data Grid Library Mode CLI" Collapse section "30.2. Red Hat JBoss Data Grid Library Mode CLI" 30.2.1. Red Hat JBoss Data Grid Library Mode CLI 30.2.2. Start the Library Mode CLI (Server) 30.2.3. Start the Library Mode CLI (Client) 30.2.4. CLI Client Switches for the Command Line 30.2.5. Connect to the Application 30.3. Red Hat JBoss Data Grid Server CLI Expand section "30.3. Red Hat JBoss Data Grid Server CLI" Collapse section "30.3. Red Hat JBoss Data Grid Server CLI" 30.3.1. Red Hat Data Grid Server Mode CLI 30.3.2. Start the Server Mode CLI 30.4. CLI Commands Expand section "30.4. CLI Commands" Collapse section "30.4. CLI Commands" 30.4.1. CLI Commands 30.4.2. The abort Command 30.4.3. The begin Command 30.4.4. The cache Command 30.4.5. The clearcache Command 30.4.6. The commit Command 30.4.7. The container Command 30.4.8. The create Command 30.4.9. The deny Command 30.4.10. The disconnect Command 30.4.11. The encoding Command 30.4.12. The end Command 30.4.13. The evict Command 30.4.14. The get Command 30.4.15. The grant Command 30.4.16. The info Command 30.4.17. The locate Command 30.4.18. The put Command 30.4.19. The replace Command 30.4.20. The roles command 30.4.21. The rollback Command 30.4.22. The site Command 30.4.23. The start Command 30.4.24. The stats Command 30.4.25. The upgrade Command 30.4.26. The version Command XV. Other Red Hat JBoss Data Grid Functions Expand section "XV. Other Red Hat JBoss Data Grid Functions" Collapse section "XV. Other Red Hat JBoss Data Grid Functions" 31. Set Up the L1 Cache Expand section "31. Set Up the L1 Cache" Collapse section "31. Set Up the L1 Cache" 31.1. About the L1 Cache 31.2. L1 Cache Configuration Expand section "31.2. L1 Cache Configuration" Collapse section "31.2. L1 Cache Configuration" 31.2.1. L1 Cache Configuration (Library Mode) 31.2.2. L1 Cache Configuration (Remote Client-Server Mode) 32. Set Up Transactions Expand section "32. Set Up Transactions" Collapse section "32. Set Up Transactions" 32.1. About Transactions Expand section "32.1. About Transactions" Collapse section "32.1. About Transactions" 32.1.1. About Transactions 32.1.2. About the Transaction Manager 32.1.3. XA Resources and Synchronizations 32.1.4. Optimistic and Pessimistic Transactions 32.1.5. Write Skew Checks 32.1.6. Transactions Spanning Multiple Cache Instances 32.2. Configure Transactions Expand section "32.2. Configure Transactions" Collapse section "32.2. Configure Transactions" 32.2.1. Configure Transactions (Library Mode) 32.2.2. Configure Transactions (Remote Client-Server Mode) 32.3. Transaction Recovery Expand section "32.3. Transaction Recovery" Collapse section "32.3. Transaction Recovery" 32.3.1. Transaction Recovery 32.3.2. Transaction Recovery Process 32.3.3. Transaction Recovery Example 32.4. Deadlock Detection Expand section "32.4. Deadlock Detection" Collapse section "32.4. Deadlock Detection" 32.4.1. Deadlock Detection 32.4.2. Enable Deadlock Detection 33. Configure JGroups Expand section "33. Configure JGroups" Collapse section "33. Configure JGroups" 33.1. About JGroups 33.2. Configure Red Hat JBoss Data Grid Interface Binding (Remote Client-Server Mode) Expand section "33.2. Configure Red Hat JBoss Data Grid Interface Binding (Remote Client-Server Mode)" Collapse section "33.2. Configure Red Hat JBoss Data Grid Interface Binding (Remote Client-Server Mode)" 33.2.1. Interfaces 33.2.2. Binding Sockets Expand section "33.2.2. Binding Sockets" Collapse section "33.2.2. Binding Sockets" 33.2.2.1. Binding Sockets 33.2.2.2. Binding a Single Socket Example 33.2.2.3. Binding a Group of Sockets Example 33.2.3. Configure JGroups Socket Binding 33.3. Configure JGroups (Library Mode) Expand section "33.3. Configure JGroups (Library Mode)" Collapse section "33.3. Configure JGroups (Library Mode)" 33.3.1. Configure JGroups for Clustered Modes 33.3.2. JGroups Transport Protocols Expand section "33.3.2. JGroups Transport Protocols" Collapse section "33.3.2. JGroups Transport Protocols" 33.3.2.1. JGroups Transport Protocols 33.3.2.2. The UDP Transport Protocol 33.3.2.3. The TCP Transport Protocol 33.3.2.4. Using the TCPPing Protocol 33.3.3. Pre-Configured JGroups Files Expand section "33.3.3. Pre-Configured JGroups Files" Collapse section "33.3.3. Pre-Configured JGroups Files" 33.3.3.1. Pre-Configured JGroups Files 33.3.3.2. default-jgroups-udp.xml 33.3.3.3. default-jgroups-tcp.xml 33.3.3.4. default-jgroups-ec2.xml 33.3.3.5. default-jgroups-google.xml 33.3.3.6. default-jgroups-kubernetes.xml 33.4. Test Multicast Using JGroups Expand section "33.4. Test Multicast Using JGroups" Collapse section "33.4. Test Multicast Using JGroups" 33.4.1. Test Multicast Using JGroups 33.4.2. Testing With Different Red Hat JBoss Data Grid Versions 33.4.3. Testing Multicast Using JGroups 34. Use Red Hat JBoss Data Grid with Amazon Web Services Expand section "34. Use Red Hat JBoss Data Grid with Amazon Web Services" Collapse section "34. Use Red Hat JBoss Data Grid with Amazon Web Services" 34.1. The S3_PING JGroups Discovery Protocol 34.2. S3_PING Configuration Options Expand section "34.2. S3_PING Configuration Options" Collapse section "34.2. S3_PING Configuration Options" 34.2.1. S3_PING Configuration Options 34.2.2. Using Private S3 Buckets 34.2.3. Using Pre-Signed URLs Expand section "34.2.3. Using Pre-Signed URLs" Collapse section "34.2.3. Using Pre-Signed URLs" 34.2.3.1. Using Pre-Signed URLs 34.2.3.2. Generating Pre-Signed URLs 34.2.3.3. Set Pre-Signed URLs Using the Command Line 34.2.4. Using Public S3 Buckets 34.3. Utilizing an Elastic IP Address 35. Use Red Hat JBoss Data Grid with Google Compute Engine Expand section "35. Use Red Hat JBoss Data Grid with Google Compute Engine" Collapse section "35. Use Red Hat JBoss Data Grid with Google Compute Engine" 35.1. The GOOGLE_PING Protocol 35.2. GOOGLE_PING Configuration Expand section "35.2. GOOGLE_PING Configuration" Collapse section "35.2. GOOGLE_PING Configuration" 35.2.1. GOOGLE_PING Configuration 35.2.2. Starting the Server in Google Compute Engine 35.3. Utilizing a Static IP Address 36. High Availability Using Server Hinting Expand section "36. High Availability Using Server Hinting" Collapse section "36. High Availability Using Server Hinting" 36.1. Server Hinting 36.2. Establishing Server Hinting with JGroups 36.3. Configuring Server Hinting 37. Set Up Cross-Datacenter Replication Expand section "37. Set Up Cross-Datacenter Replication" Collapse section "37. Set Up Cross-Datacenter Replication" 37.1. Cross-Datacenter Replication 37.2. Cross-Datacenter Replication Operations 37.3. Configure Cross-Datacenter Replication Expand section "37.3. Configure Cross-Datacenter Replication" Collapse section "37.3. Configure Cross-Datacenter Replication" 37.3.1. Configure Cross-Datacenter Replication (Remote Client-Server Mode) 37.3.2. Configure Cross-Datacenter Replication (Library Mode) Expand section "37.3.2. Configure Cross-Datacenter Replication (Library Mode)" Collapse section "37.3.2. Configure Cross-Datacenter Replication (Library Mode)" 37.3.2.1. Configure Cross-Datacenter Replication Declaratively 37.4. Taking a Site Offline Expand section "37.4. Taking a Site Offline" Collapse section "37.4. Taking a Site Offline" 37.4.1. Taking a Site Offline 37.4.2. Taking a Site Offline 37.4.3. Taking a Site Offline via JBoss Operations Network (JON) 37.4.4. Taking a Site Offline via the CLI 37.4.5. Bring a Site Back Online 37.5. State Transfer Between Sites Expand section "37.5. State Transfer Between Sites" Collapse section "37.5. State Transfer Between Sites" 37.5.1. State Transfer Between Sites 37.5.2. Active-Passive State Transfer 37.5.3. Active-Active State Transfer 37.5.4. State Transfer Configuration 37.6. Configure Multiple Site Masters Expand section "37.6. Configure Multiple Site Masters" Collapse section "37.6. Configure Multiple Site Masters" 37.6.1. Configure Multiple Site Masters 37.6.2. Multiple Site Master Operations 37.6.3. Configure Multiple Site Masters (Remote Client-Server Mode) 37.6.4. Configure Multiple Site Masters (Library Mode) 37.7. Cross-Datacenter Replication Concerns 38. Rolling Upgrades Expand section "38. Rolling Upgrades" Collapse section "38. Rolling Upgrades" 38.1. Performing Rolling Upgrades Expand section "38.1. Performing Rolling Upgrades" Collapse section "38.1. Performing Rolling Upgrades" 38.1.1. Setting Up the Target Cluster 38.1.2. Migrating Data to the Target Cluster 38.1.3. Finalizing Rolling Upgrades 39. Externalize Sessions Expand section "39. Externalize Sessions" Collapse section "39. Externalize Sessions" 39.1. Externalize Sessions 39.2. Externalize HTTP Session from JBoss EAP to JBoss Data Grid 39.3. Externalize HTTP Sessions from JBoss Web Server (JWS) to JBoss Data Grid Expand section "39.3. Externalize HTTP Sessions from JBoss Web Server (JWS) to JBoss Data Grid" Collapse section "39.3. Externalize HTTP Sessions from JBoss Web Server (JWS) to JBoss Data Grid" 39.3.1. Externalize HTTP Session from JBoss Web Server (JWS) to JBoss Data Grid 39.3.2. Prerequisites 39.3.3. Installation 39.3.4. Session Management Details 39.3.5. Configure the JBoss Web Server Session Manager 40. Handling Network Partitions (Split Brain) Expand section "40. Handling Network Partitions (Split Brain)" Collapse section "40. Handling Network Partitions (Split Brain)" 40.1. Network Partition Recovery 40.2. Detecting and Recovering from a Split-Brain Problem 40.3. Partition Handling Strategies Expand section "40.3. Partition Handling Strategies" Collapse section "40.3. Partition Handling Strategies" 40.3.1. ALLOW_READ_WRITES 40.3.2. DENY_READ_WRITES Expand section "40.3.2. DENY_READ_WRITES" Collapse section "40.3.2. DENY_READ_WRITES" 40.3.2.1. Partition Recovery Example with DENY_READ_WRITE 40.3.3. ALLOW_READS 40.4. Detecting and Recovering from Successive Node Failures 40.5. Conflict Manager Expand section "40.5. Conflict Manager" Collapse section "40.5. Conflict Manager" 40.5.1. Detecting Conflicts 40.5.2. Merge Policies 40.6. Split Brain Timing: Detecting a Split 40.7. Split Brain Timing: Recovering From a Split Expand section "40.7. Split Brain Timing: Recovering From a Split" Collapse section "40.7. Split Brain Timing: Recovering From a Split" 40.7.1. Considerations with Garbage Collection 40.8. Configuring Partition Handling Expand section "40.8. Configuring Partition Handling" Collapse section "40.8. Configuring Partition Handling" 40.8.1. Example Configurations 40.8.2. Configuration of Partition Handling Between Releases Expand section "40.8.2. Configuration of Partition Handling Between Releases" Collapse section "40.8.2. Configuration of Partition Handling Between Releases" 40.8.2.1. No Partition Handling Configuration or Partition Handling Disabled 40.8.2.2. Partition Handling Enabled 40.9. Creating Custom Merge Policies Expand section "40.9. Creating Custom Merge Policies" Collapse section "40.9. Creating Custom Merge Policies" 40.9.1. Specifying Custom Merge Policies A. Recommended JGroups Values for JBoss Data Grid Expand section "A. Recommended JGroups Values for JBoss Data Grid" Collapse section "A. Recommended JGroups Values for JBoss Data Grid" A.1. Supported JGroups Protocols A.2. TCP Default and Recommended Values A.3. UDP Default and Recommended Values A.4. The TCPGOSSIP JGroups Protocol A.5. TCPGOSSIP Configuration Options A.6. JBoss Data Grid JGroups Configuration Files B. Hotrod.Properties Expand section "B. Hotrod.Properties" Collapse section "B. Hotrod.Properties" B.1. Hotrod.Properties C. Connecting with JConsole Expand section "C. Connecting with JConsole" Collapse section "C. Connecting with JConsole" C.1. Connect to JDG via JConsole D. JMX MBeans in Red Hat JBoss Data Grid Expand section "D. JMX MBeans in Red Hat JBoss Data Grid" Collapse section "D. JMX MBeans in Red Hat JBoss Data Grid" D.1. Activation D.2. Cache D.3. CacheContainerStats D.4. CacheLoader D.5. CacheManager D.6. CacheStore D.7. ClusterCacheStats D.8. ClusterContainerStats D.9. DeadlockDetectingLockManager D.10. DistributionManager D.11. Interpreter D.12. Invalidation D.13. LockManager D.14. LocalTopologyManager D.15. MassIndexer D.16. Passivation D.17. RecoveryAdmin D.18. RollingUpgradeManager D.19. RpcManager D.20. StateTransferManager D.21. Statistics D.22. Transactions D.23. Transport D.24. XSiteAdmin E. Configuration Recommendations Expand section "E. Configuration Recommendations" Collapse section "E. Configuration Recommendations" E.1. Timeout Values F. Performance Recommendations Expand section "F. Performance Recommendations" Collapse section "F. Performance Recommendations" F.1. Concurrent Startup for Large Clusters G. References Expand section "G. References" Collapse section "G. References" G.1. About Consistency G.2. About Consistency Guarantee G.3. About JBoss Cache G.4. About RELAY2 G.5. About Return Values G.6. About Runnable Interfaces G.7. About Two Phase Commit (2PC) G.8. About Key-Value Pairs G.9. Requesting a Full Byte Array 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 II. Managing JVM Memory Previous Next