Procedure 2.1. Initialize Eviction

1. Add the Eviction Tag

   Add the <eviction> tag to your project's <cache> tags as follows:

   <eviction />

2. Set the Eviction Strategy

   Set the strategy value to set the eviction strategy employed. Possible values are LRU, UNORDERED and LIRS (or NONE if no eviction is required). The following is an example of this step:

   <eviction strategy="LRU" />

3. Set the Maximum Size to use for Eviction

   Set the maximum number of entries allowed in memory by defining the size element. The default value is -1 for unlimited entries. The following demonstrates this step:

   <eviction strategy="LRU" size="200" />

Procedure 4.1. Configure the Root Logger

1. Set the level Property

   The level property sets the maximum level of log message that the root logger records.

   <subsystem xmlns="urn:jboss:domain:logging:3.0">
      <root-logger>
         <level name="INFO"/>

2. List handlers

   handlers is a list of log handlers that are used by the root logger.

   <subsystem xmlns="urn:jboss:domain:logging:3.0">
        <root-logger>
           <level name="INFO"/>
           <handlers>
              <handler name="CONSOLE"/>
              <handler name="FILE"/>
           </handlers>
        </root-logger>
     </subsystem>

Procedure 4.2. Configure a Log Category

<subsystem xmlns="urn:jboss:domain:logging:3.0">
   <logger category="com.company.accounts.rec" use-parent-handlers="true">
      <level name="WARN"/>
      <handlers>
         <handler name="accounts-rec"/>
      </handlers>
   </logger>
</subsystem>

1. Use the category property to specify the log category from which log messages will be captured.
   The use-parent-handlers is set to "true" by default. When set to "true", this category will use the log handlers of the root logger in addition to any other assigned handlers.
2. Use the level property to set the maximum level of log message that the log category records.
3. The handlers element contains a list of log handlers.

Procedure 4.3. Configure the Console Log Handler

<subsystem xmlns="urn:jboss:domain:logging:3.0">
   <console-handler name="CONSOLE" autoflush="true">
      <level name="INFO"/>
      <encoding value="UTF-8"/>
      <target value="System.out"/>
      <filter-spec value="not(match(&quot;JBAS.*&quot;))"/>
      <formatter>
         <pattern-formatter pattern="%K{level}%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
      </formatter>
   </console-handler>
</subsystem>

1. Add the Log Handler Identifier Information

   The name property sets the unique identifier for this log handler.
   When autoflush is set to "true" the log messages will be sent to the handler's target immediately upon request.

2. Set the level Property

   The level property sets the maximum level of log messages recorded.

3. Set the encoding Output

   Use encoding to set the character encoding scheme to be used for the output.

4. Define the target Value

   The target property defines the system output stream where the output of the log handler goes. This can be System.err for the system error stream, or System.out for the standard out stream.

5. Define the filter-spec Property

   The filter-spec property is an expression value that defines a filter. The example provided defines a filter that does not match a pattern: not(match("JBAS.*")).

6. Specify the formatter

   Use formatter to list the log formatter used by the log handler.

Procedure 4.4. Configure the File Log Handler

<file-handler name="accounts-rec-trail" autoflush="true">
    <level name="INFO"/>
    <encoding value="UTF-8"/>
    <file relative-to="jboss.server.log.dir" path="accounts-rec-trail.log"/>
    <formatter>
        <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
    </formatter>
    <append value="true"/>
</file-handler>

1. Add the File Log Handler Identifier Information

   The name property sets the unique identifier for this log handler.
   When autoflush is set to "true" the log messages will be sent to the handler's target immediately upon request.

2. Set the level Property

   The level property sets the maximum level of log message that the root logger records.

3. Set the encoding Output

   Use encoding to set the character encoding scheme to be used for the output.

4. Set the file Object

   The file object represents the file where the output of this log handler is written to. It has two configuration properties: relative-to and path.
   The relative-to property is the directory where the log file is written to. JBoss Enterprise Application Platform 6 file path variables can be specified here. The jboss.server.log.dir variable points to the log/ directory of the server.
   The path property is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the relative-to property to determine the complete path.

5. Specify the formatter

   Use formatter to list the log formatter used by the log handler.

6. Set the append Property

   When the append property is set to "true", all messages written by this handler will be appended to an existing file. If set to "false" a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.

Procedure 4.5. Configure the Periodic Log Handler

<periodic-rotating-file-handler name="FILE" autoflush="true">
   <level name="INFO"/>
   <encoding value="UTF-8"/>
   <formatter>
      <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
   </formatter>
   <file relative-to="jboss.server.log.dir" path="server.log"/>
   <suffix value=".yyyy-MM-dd"/>
   <append value="true"/>
</periodic-rotating-file-handler>

1. Add the Periodic Log Handler Identifier Information

   The name property sets the unique identifier for this log handler.
   When autoflush is set to "true" the log messages will be sent to the handler's target immediately upon request.

2. Set the level Property

   The level property sets the maximum level of log message that the root logger records.

3. Set the encoding Output

   Use encoding to set the character encoding scheme to be used for the output.

4. Specify the formatter

   Use formatter to list the log formatter used by the log handler.

5. Set the file Object

   The file object represents the file where the output of this log handler is written to. It has two configuration properties: relative-to and path.
   The relative-to property is the directory where the log file is written to. JBoss Enterprise Application Platform 6 file path variables can be specified here. The jboss.server.log.dir variable points to the log/ directory of the server.
   The path property is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the relative-to property to determine the complete path.

6. Set the suffix Value

   The suffix is appended to the filename of the rotated logs and is used to determine the frequency of rotation. The format of the suffix is a dot (.) followed by a date string, which is parsable by the java.text.SimpleDateFormat class. The log is rotated on the basis of the smallest time unit defined by the suffix. For example, yyyy-MM-dd will result in daily log rotation. See http://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html

7. Set the append Property

   When the append property is set to "true", all messages written by this handler will be appended to an existing file. If set to "false" a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.

Procedure 4.6. Configure the Size Log Handler

<size-rotating-file-handler name="accounts_debug" autoflush="false">
   <level name="DEBUG"/>
   <encoding value="UTF-8"/>
   <file relative-to="jboss.server.log.dir" path="accounts-debug.log"/>
   <rotate-size value="500k"/>
   <max-backup-index value="5"/>
   <formatter>
        <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
    </formatter>
   <append value="true"/>
</size-rotating-file-handler>

1. Add the Size Log Handler Identifier Information

   The name property sets the unique identifier for this log handler.
   When autoflush is set to "true" the log messages will be sent to the handler's target immediately upon request.

2. Set the level Property

   The level property sets the maximum level of log message that the root logger records.

3. Set the encoding Output

   Use encoding to set the character encoding scheme to be used for the output.

4. Set the file Object

   The file object represents the file where the output of this log handler is written to. It has two configuration properties: relative-to and path.
   The relative-to property is the directory where the log file is written to. JBoss Enterprise Application Platform 6 file path variables can be specified here. The jboss.server.log.dir variable points to the log/ directory of the server.
   The path property is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the relative-to property to determine the complete path.

5. Specify the rotate-size Value

   The maximum size that the log file can reach before it is rotated. A single character appended to the number indicates the size units: b for bytes, k for kilobytes, m for megabytes, g for gigabytes. For example: 50m for 50 megabytes.

6. Set the max-backup-index Number

   The maximum number of rotated logs that are kept. When this number is reached, the oldest log is reused.

7. Specify the formatter

   Use formatter to list the log formatter used by the log handler.

8. Set the append Property

   When the append property is set to "true", all messages written by this handler will be appended to an existing file. If set to "false" a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.

Procedure 4.7. Configure the Async Log Handler

<async-handler name="Async_NFS_handlers">
   <level name="INFO"/>
   <queue-length value="512"/>
   <overflow-action value="block"/>
   <subhandlers>
      <handler name="FILE"/>
      <handler name="accounts-record"/>
   </subhandlers>
</async-handler>

1. The name property sets the unique identifier for this log handler.
2. The level property sets the maximum level of log message that the root logger records.
3. The queue-length defines the maximum number of log messages that will be held by this handler while waiting for sub-handlers to respond.
4. The overflow-action defines how this handler responds when its queue length is exceeded. This can be set to BLOCK or DISCARD. BLOCK makes the logging application wait until there is available space in the queue. This is the same behavior as an non-async log handler. DISCARD allows the logging application to continue but the log message is deleted.
5. The subhandlers list is the list of log handlers to which this async handler passes its log messages.

Procedure 5.2. The local-cache Element

<cache-container name="local"
                 default-cache="default" 
                 statistics="true">
    <local-cache name="default"
        start="EAGER"
        batching="false"
        statistics="true">
        <!-- Additional configuration information here -->
    </local-cache>

1. The name parameter specifies the name of the local cache to use.
2. The start parameter indicates when the cache container starts, i.e. whether it will start lazily when requested or "eagerly" when the server starts up. Valid values for this parameter are EAGER and LAZY.
3. The batching parameter specifies whether batching is enabled for the local cache.
4. If statistics are enabled at the container level, per-cache statistics can be selectively disabled for caches that do not require monitoring by setting the statistics attribute to false.

Procedure 10.1. Register the Advanced Externalizer

<infinispan>
    <cache-container>
        <serialization>
            <advanced-externalizer class="Book$BookExternalizer" />
        </serialization>
    </cache-container>
</infinispan>

1. Add the serialization element to the cache-container element.
2. Add the advanced-externalizer element, defining the custom Externalizer with the class attribute. Replace the Book$BookExternalizer values as required.

Procedure 12.1. Configuring REST Connectors for Remote Client-Server Mode

<subsystem xmlns="urn:infinispan:server:endpoint:8.0">
   <rest-connector cache-container="local"
                   context-path="${CONTEXT_PATH}"/> 
</subsystem>

1. The cache-container parameter names the cache container used by the REST connector. This is a mandatory parameter.
2. The context-path parameter specifies the context path for the REST connector. The default value for this parameter is an empty string (""). This is an optional parameter.
3. The security-domain parameter specifies that the specified domain, declared in the security subsystem, should be used to authenticate access to the REST endpoint. This is an optional parameter. If this parameter is omitted, no authentication is performed.
4. The auth-method parameter specifies the method used to retrieve credentials for the end point. The default value for this parameter is BASIC. Supported alternate values include BASIC, DIGEST, and CLIENT-CERT. This is an optional parameter.
5. The security-mode parameter specifies whether authentication is required only for write operations (such as PUT, POST and DELETE) or for read operations (such as GET and HEAD) as well. Valid values for this parameter are WRITE for authenticating write operations only, or READ_WRITE to authenticate read and write operations. The default value for this parameter is READ_WRITE.

Procedure 13.1. Configuring the Memcached Connector in Remote Client-Server Mode

<subsystem xmlns="urn:infinispan:server:endpoint:8.0">
<memcached-connector socket-binding="memcached" 
                     cache-container="local" 
                     worker-threads="${VALUE}" 
                     idle-timeout="{VALUE}"
                     tcp-nodelay="{TRUE/FALSE}" 
                     send-buffer-size="{VALUE}" 
                     receive-buffer-size="${VALUE}" />
</subsystem>

1. The socket-binding parameter specifies the socket binding port used by the memcached connector. This is a mandatory parameter.
2. The cache-container parameter names the cache container used by the memcached connector. This is a mandatory parameter.
3. The worker-threads parameter specifies the number of worker threads available for the memcached connector. The default value for this parameter is 160. This is an optional parameter.
4. The idle-timeout parameter specifies the time (in milliseconds) the connector can remain idle before the connection times out. The default value for this parameter is -1, which means that no timeout period is set. This is an optional parameter.
5. The tcp-nodelay parameter specifies whether TCP packets will be delayed and sent out in batches. Valid values for this parameter are true and false. The default value for this parameter is true. This is an optional parameter.
6. The send-buffer-size parameter indicates the size of the send buffer for the memcached connector. The default value for this parameter is the size of the TCP stack buffer. This is an optional parameter.
7. The receive-buffer-size parameter indicates the size of the receive buffer for the memcached connector. The default value for this parameter is the size of the TCP stack buffer. This is an optional parameter.

Procedure 14.1. Configuring Hot Rod Connectors for Remote Client-Server Mode

<subsystem xmlns="urn:infinispan:server:endpoint:8.0">
	<hotrod-connector socket-binding="hotrod" 
			  cache-container="local" 
			  worker-threads="${VALUE}" 
			  idle-timeout="${VALUE}"
			  tcp-nodelay="${TRUE/FALSE}"
			  send-buffer-size="${VALUE}"
			  receive-buffer-size="${VALUE}" >
		<topology-state-transfer lock-timeout"="${MILLISECONDS}"
				 replication-timeout="${MILLISECONDS}"
				 external-host="${HOSTNAME}"
				 external-port="${PORT}"
				 lazy-retrieval="${TRUE/FALSE}"  /> 
	</hotrod-connector>
</subsystem>

1. The hotrod-connector element defines the configuration elements for use with Hot Rod.
   1. The socket-binding parameter specifies the socket binding port used by the Hot Rod connector. This is a mandatory parameter.
   2. The cache-container parameter names the cache container used by the Hot Rod connector. This is a mandatory parameter.
   3. The worker-threads parameter specifies the number of worker threads available for the Hot Rod connector. The default value for this parameter is 160. This is an optional parameter.
   4. The idle-timeout parameter specifies the time (in milliseconds) the connector can remain idle before the connection times out. The default value for this parameter is -1, which means that no timeout period is set. This is an optional parameter.
   5. The tcp-nodelay parameter specifies whether TCP packets will be delayed and sent out in batches. Valid values for this parameter are true and false. The default value for this parameter is true. This is an optional parameter.
   6. The send-buffer-size parameter indicates the size of the send buffer for the Hot Rod connector. The default value for this parameter is the size of the TCP stack buffer. This is an optional parameter.
   7. The receive-buffer-size parameter indicates the size of the receive buffer for the Hot Rod connector. The default value for this parameter is the size of the TCP stack buffer. This is an optional parameter.
2. The topology-state-transfer element specifies the topology state transfer configurations for the Hot Rod connector. This element can only occur once within a hotrod-connector element.
   1. The lock-timeout parameter specifies the time (in milliseconds) after which the operation attempting to obtain a lock times out. The default value for this parameter is 10 seconds. This is an optional parameter.
   2. The replication-timeout parameter specifies the time (in milliseconds) after which the replication operation times out. The default value for this parameter is 10 seconds. This is an optional parameter.
   3. The external-host parameter specifies the hostname sent by the Hot Rod server to clients listed in the topology information. The default value for this parameter is the host address. This is an optional parameter.
   4. The external-port parameter specifies the port sent by the Hot Rod server to clients listed in the topology information. The default value for this parameter is the configured port. This is an optional parameter.
   5. The lazy-retrieval parameter indicates whether the Hot Rod connector will carry out retrieval operations lazily. The default value for this parameter is true. This is an optional parameter.

Procedure 15.3. Transaction with Explicit Pessimistic Locking

tx.begin()
cache.lock(K)           
cache.put(K,V5)         
tx.commit()

1. When the line cache.lock(K) executes, a cluster-wide lock is acquired on K.
2. When the line cache.put(K,V5) executes, it guarantees success.
3. When the line tx.commit() executes, the locks held for this process are released.

Procedure 15.4. Transaction with Implicit Pessimistic locking

tx.begin()
cache.put(K,V)
cache.put(K2,V2)
cache.put(K,V5)
tx.commit()

1. When the line cache.put(K,V) executes, a cluster-wide lock is acquired on K.
2. When the line cache.put(K2,V2) executes, a cluster-wide lock is acquired on K2.
3. When the line cache.put(K,V5) executes, the lock acquisition is non operational because a cluster-wide lock for K has been previously acquired. The put operation will still occur.
4. When the line tx.commit() executes, all locks held for this transaction are released.

Procedure 19.1. To configure LevelDB Cache Store:

• Add the following elements to a cache definition in standalone.xml to configure the database:

  <leveldb-store path="/path/to/leveldb/data"
      	       passivation="false"
      	       purge="false" >
      <leveldb-expiration path="/path/to/leveldb/expires/data" />
      <implementation type="JNI" />
  </leveldb-store>

  Note

  Directories will be automatically created if they do not exist.

Procedure 19.2. 

1. Ensure that Red Hat JBoss Operations Network 3.2 or higher is installed and started.
2. Install the Red Hat JBoss Data Grid Plugin Pack for JBoss Operations Network 3.2.0.
3. Ensure that JBoss Data Grid is installed and started.
4. Import JBoss Data Grid server into the inventory.
5. Configure the JBoss Data Grid connection settings.
6. Create a new LevelDB cache store as follows:
   

   Figure 19.1. Create a new LevelDB Cache Store

   1. Right-click the default cache.
   2. In the menu, mouse over the Create Child option.
   3. In the submenu, click LevelDB Store.
7. Name the new LevelDB cache store as follows:
   

   Figure 19.2. Name the new LevelDB Cache Store

   1. In the Resource Create Wizard that appears, add a name for the new LevelDB Cache Store.
   2. Click Next to continue.
8. Configure the LevelDB Cache Store settings as follows:
   

   Figure 19.3. Configure the LevelDB Cache Store Settings

   1. Use the options in the configuration window to configure a new LevelDB cache store.
   2. Click Finish to complete the configuration.
9. Schedule a restart operation as follows:
   

   Figure 19.4. Schedule a Restart Operation

   1. In the screen's left panel, expand the JBossAS7 Standalone Servers entry, if it is not currently expanded.
   2. Click JDG (0.0.0.0:9990) from the expanded menu items.
   3. In the screen's right panel, details about the selected server display. Click the Operations tab.
   4. In the Operation drop-down box, select the Restart operation.
   5. Select the radio button for the Now entry.
   6. Click Schedule to restart the server immediately.
10. Discover the new LevelDB cache store as follows:
    

    Figure 19.5. Discover the New LevelDB Cache Store

    1. In the screen's left panel, select each of the following items in the specified order to expand them: JBossAS7 Standalong Servers → JDG (0.0.0.0:9990) → infinispan → Cache Containers → local → Caches → default → LevelDB Stores
    2. Click the name of your new LevelDB Cache Store to view its configuration information in the right panel.

Procedure 19.3. Configure persistence.xml for Metadata Entities

1. Using Hibernate as the JPA implementation allows automatic creation of these tables using the property hibernate.hbm2ddl.auto in persistence.xml as follows:

   <property name="hibernate.hbm2ddl.auto" value="update"/>

2. Declare the metadata entity class to the JPA provider by adding the following to persistence.xml:

   <class>org.infinispan.persistence.jpa.impl.MetadataEntity</class>

Procedure 19.4. Deploy JPA Cache Stores in JBoss EAP 6.3.x and earlier

• To add dependencies from the JBoss Data Grid modules to the application's classpath, provide the JBoss EAP deployer a list of dependencies in one of the following ways:
  1. Add a dependency configuration to the MANIFEST.MF file:

     Manifest-Version: 1.0
     Dependencies: org.infinispan:jdg-7.0 services, org.infinispan.persistence.jpa:jdg-7.0 services

  2. Add a dependency configuration to the jboss-deployment-structure.xml file:

     <jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
         <deployment>
             <dependencies>
                 <module name="org.infinispan.persistence.jpa" slot="jdg-7.0" services="export"/>
                 <module name="org.infinispan" slot="jdg-7.0" services="export"/>
             </dependencies>
         </deployment>
     </jboss-deployment-structure>

Procedure 19.5. Deploy JPA Cache Stores in JBoss EAP 6.4 and later

1. Add the following property in persistence.xml:

   <persistence-unit>
     [...]
     <properties>
       <property name="jboss.as.jpa.providerModule" value="application" />
     </properties>
   </persistence-unit>

2. Add the following dependencies to the jboss-deployment-structure.xml:

   <jboss-deployment-structure>
       <deployment>
           <dependencies>
               <module name="org.infinispan" slot="jdg-7.0"/>
               <module name="org.jgroups" slot="jdg-7.0"/>
               <module name="org.infinispan.persistence.jpa" slot="jdg-7.0" services="export"/>
               <module name="org.hibernate"/>
           </dependencies>
       </deployment>
   </jboss-deployment-structure>

3. Add any additional dependencies, such as additional JDG modules, are in use add these to the dependencies section in jboss-deployment-structure.xml.

Procedure 19.7. Generate a Maven Archetype

1. Ensure the JBoss Data Grid Maven repository has been installed by following the instructions in the Red Hat JBoss Data Grid Getting Started Guide.
2. Open a command prompt and execute the following command to generate an archetype in the current directory:

   mvn -Dmaven.repo.local="path/to/unzipped/jboss-datagrid-7.0.0-maven-repository/" 
     archetype:generate 
     -DarchetypeGroupId=org.infinispan 
     -DarchetypeArtifactId=custom-cache-store-archetype 
     -DarchetypeVersion=8.3.0.Final-redhat-1

   Note

   The above command has been broken into multiple lines for readability; however, when executed this command and all arguments must be on a single line.

Procedure 21.1. Configure a Write-Through Local File Cache Store

<local-cache name="persistentCache">
		<persistence>
		    <file-store fetch-state="true" 
			    purge="false"
			    shared="false"
			    location="${java.io.tmpdir}"/>
		</persistence>
</local-cache>

1. The name parameter specifies the name of the local-cache to use.
2. The fetch-state parameter determines whether the persistent state is fetched when joining a cluster. Set this to true if using a replication and invalidation in a clustered environment. Additionally, if multiple cache stores are chained, only one cache store can have this property enabled. If a shared cache store is used, the cache does not allow a persistent state transfer despite this property being set to true. The fetch-state parameter is false by default.
3. The purge parameter specifies whether the cache is purged when initially started.
4. The shared parameter is used when multiple cache instances share a cache store and is now defined at the cache store level. This parameter can be set to prevent multiple cache instances writing the same modification multiple times. Valid values for this parameter are true and false.

Procedure 21.2. The write-behind Element

<file-store passivation="false" 
            path="${PATH}" 
            purge="true" 
            shared="false">
    <write-behind modification-queue-size="1024" 
                  shutdown-timeout="25000"  
                  flush-lock-timeout="15000" 
                  thread-pool-size="5" />
</file-store>

1. The modification-queue-size parameter sets the modification queue size for the asynchronous store. If updates occur faster than the cache store can process the queue, the asynchronous store behaves like a synchronous store. The store behavior remains synchronous and blocks elements until the queue is able to accept them, after which the store behavior becomes asynchronous again.
2. The shutdown-timeout parameter specifies the time in milliseconds after which the cache store is shut down. When the store is stopped some modifications may still need to be applied. Setting a large timeout value will reduce the chance of data loss. The default value for this parameter is 25000.
3. The flush-lock-timeout parameter specifies the time (in milliseconds) to acquire the lock that guards the state to be periodically flushed. The default value for this parameter is 15000.
4. The thread-pool-size parameter specifies the size of the thread pool. The threads in this thread pool apply modifications to the cache store. The default value for this parameter is 5.

Procedure 21.3. The async Element

<persistence>
    <singleFile location="${LOCATION}">
        <async enabled="true" 
                    modificationQueueSize="1024" 
                    shutdownTimeout="25000" 
                    flushLockTimeout="15000" 
                    threadPoolSize="5"/>
    </singleFile>
</persistence>

1. The modificationQueueSize parameter sets the modification queue size for the asynchronous store. If updates occur faster than the cache store can process the queue, the asynchronous store behaves like a synchronous store. The store behavior remains synchronous and blocks elements until the queue is able to accept them, after which the store behavior becomes asynchronous again.
2. The shutdownTimeout parameter specifies the time in milliseconds after which the cache store is shut down. This provides time for the asynchronous writer to flush data to the store when a cache is shut down. The default value for this parameter is 25000.
3. The flushLockTimeout parameter specifies the time (in milliseconds) to acquire the lock that guards the state to be periodically flushed. The default value for this parameter is 15000.
4. The threadPoolSize parameter specifies the number of threads that concurrently apply modifications to the store. The default value for this parameter is 5.

Procedure 23.1. Download JBoss Operations Network

1. To access the Red Hat Customer Portal, navigate to https://access.redhat.com/home in a browser.
2. Click Downloads.
3. In the section labeled JBoss Development and Management, click Red Hat JBoss Data Grid.
4. Enter the relevant credentials in the Red Hat Login and Password fields and click Log In.
5. Select the appropriate version in the Version drop down menu list.
6. Click the Download button next to the desired download file.

Procedure 23.2. Download Installation Files

1. Open http://access.redhat.com in a web browser.
2. Click Downloads in the menu across the top of the page.
3. Click Red Hat JBoss Operations Network in the list under JBoss Development and Management.
4. Enter your login information.
   You are taken to the Software Downloads page.

5. Download the JBoss Operations Network Plugin

   If you intend to use the JBoss Operations Network plugin for JBoss Data Grid, select JBoss ON for Data Grid from either the Product drop-down box, or the menu on the left.
   1. Click the Red Hat JBoss Operations Network VERSION Base Distribution Download button.
   2. Repeat the steps to download the Data Grid Management Plugin Pack for JBoss ON VERSION

1. Install the plug-ins

   • Copy the JBoss Data Grid server rhq plug-in to $JON_SERVER_HOME/plugins.
   • Copy the JBoss Enterprise Application Platform plug-in to $JON_SERVER_HOME/plugins.
   The server will automatically discover plug-ins here and deploy them. The plug-ins will be removed from the plug-ins directory after successful deployment.

2. Obtain plug-ins

   Obtain all available plug-ins from the JBoss Operations Network server. To do this, type the following into the agent's console:

   plugins update

3. List installed plug-ins

   Ensure the JBoss Enterprise Application Platform plug-in and the JBoss Data Grid server rhq plug-in are installed correctly using the following:

   plugins info

Procedure 23.3. Creating a new cache in Remote Client-Server mode

1. Log into the JBoss Operations Network Console.
   1. From the JBoss Operations Network console, click Inventory.
   2. Select Servers from the Resources list on the left of the console.
2. Select the specific Red Hat JBoss Data Grid server from the servers list.
   1. Below the server name, click infinispan and then Cache Containers.
3. Select the desired cache container that will be parent for the newly created cache.
   1. Right-click the selected cache container. For example, clustered.
   2. In the context menu, navigate to Create Child and select Cache.
4. Create a new cache in the resource create wizard.
   1. Enter the new cache name and click Next.
   2. Set the cache attributes in the Deployment Options and click Finish.

Procedure 23.4. Install JBoss Operations Network Library Mode Plug-in

1. Open the JBoss Operations Network Console

   1. From the JBoss Operations Network console, select Administration.
   2. Select Agent Plugins from the Configuration options on the left side of the console.
   

   Figure 23.1. JBoss Operations Network Console for JBoss Data Grid

2. Upload the Library Mode Plug-in

   1. Click Browse, locate the InfinispanPlugin on your local file system.
   2. Click Upload to add the plug-in to the JBoss Operations Network Server.
   

   Figure 23.2. Upload the InfinispanPlugin.

3. Scan for Updates

   1. Once the file has successfully uploaded, click Scan For Updates at the bottom of the screen.
   2. The InfinispanPlugin will now appear in the list of installed plug-ins.
   

   Figure 23.3. Scan for Updated Plug-ins.

Procedure 24.1. Adding a Management User

1. Run the add-user script within the bin folder as follows:

   ./add-user.sh

2. Select the option for the type of user to be added. For management user, select option a.
3. Set the Username and password as per the listed recommendations.
4. Enter the name of the group or groups in which the user has to be added. Leave blank for no group.

   Note

   See the Download and Install JBoss Data Grid section in the Red Hat JBoss Data Grid Getting Started Guide for download and installation details.
5. Confirm if you need the user to be used for Apache Spark process connection.

   Note

   Before proceeding, make sure $JBOSS_HOME is not set to a different installation. Otherwise, you may get unpredictable results.

Procedure 24.2. Adding a New Cache

1. In the Cache Containers view, click on the name of the cache container.
   

   Figure 24.5. Cache Containers View

2. The Caches view is displayed listing all the configured caches. Click Add Cache to add and configure a new cache. The new cache creation window is opened.
   

   Figure 24.6. Add Cache

3. Enter the new cache name, select the base configuration template from the drop-down menu and click Next.
   

   Figure 24.7. Cache Properties

4. The cache configuration screen is displayed. Enter the cache parameters and click Create.
   

   Figure 24.8. Cache Configuration

5. A confirmation screen is displayed. Click Create to create the cache.
   

   Figure 24.9. Cache Confirmation

Procedure 24.3. Editing Cache Configuration

1. Log into the JBoss Data Grid Administration Console and click on the cache container name.
   

   Figure 24.10. Cache Containers

2. In the Caches view, click on the cache name.
   

   Figure 24.11. Caches View

3. The cache statistics and properties page is displayed. On the right hand side, click the Configuration tab.
   

   Figure 24.12. Cache Configuration Button

4. The edit cache configuration interface is opened. The editable cache properties are found in the cache properties menu at the left hand side.
   

   Figure 24.13. Editing Cache Configuration Interface

5. Select the cache configuration property to be edited from the cache properties menu. To get a description on the cache configuration parameters, hover the cursor over the information icon. The parameter description is presented in form of a tooltip.
   

   Figure 24.14. Cache configuration paramaters

6. For example, the General property is selected by default. Edit the required values in the given parameter input field. Scroll down and click Apply changes.
7. A confirmation dialog box will appear. Click Update.
   

   Figure 24.15. 

8. The restart dialogue box appears. Click Restart Now to apply the changes.
   

   Figure 24.16. Restart Dialogue Box

   Note

   Click Restart Later to continue editing the cache properties.

Procedure 24.4. Viewing Cache Statistics

1. Navigate to the list of caches by clicking on the name of the cache container in the Cache Container view.
2. Click on the name of the cache from the list of caches. Optionally you can use the cache filter on the left side to filter caches. The caches can be filtered by a keyword, substring or by selecting the type and the trait.
   

   Figure 24.17. Caches View

3. The next page displays the comprehensive cache statistics under the headings: Cache content, Operations performance and Caching Activity.
   

   Figure 24.18. Cache Statistics

4. Additional cache statistics are displayed under the headings: Entries Lifecycle, Cache Loader and Locking
   

   Figure 24.19. Cache Statistics

5. To view cache properties, click on Configuration at the right hand side.
   

   Figure 24.20. Configuration Button

6. The cache properties menu is displayed at the left hand side.
   

   Figure 24.21. Cache Properties Menu

Procedure 24.5. Disabling a Cache

1. Navigate to the caches view by clicking on the name of the cache container in the Cache Container view. Click on the name of the cache to be disabled.
   

   Figure 24.24. Caches View

2. The cache statistics will be displayed. On the right hand side of the interface, click on the Actions tab and then click Disable.
   

   Figure 24.25. Cache Disable

3. A confirmation dialogue box will appear. Click Disable to disable the cache.
   

   Figure 24.26. Cache Disable Confirmation

4. A subsequent dialogue box appears. Click Ok.
   

   Figure 24.27. Confirmation Box

5. The selected cache is disabled successfully with a visual indicator Disabled next to the cache name label.
   

   Figure 24.28. Disabled Cache

Procedure 24.6. Enabling a Cache

1. To enable a cache, click on the specific disabled cache from the Cache view.
   

   Figure 24.29. Caches View

2. On the right hand side of the interface, click on the Actions tab.
   

   Figure 24.30. 

3. From the Actions tab, click Enable
   

   Figure 24.31. Actions Menu

4. A confirmation dialogue box appears. Click Enable.
   

   Figure 24.32. Confirmation Box

5. A subsequent dialogue box appears. Click Ok
   

   Figure 24.33. Information Box

6. The selected cache is enabled successfully with a visual indicator Enabled next to the cache name label.
   

   Figure 24.34. Cache Enabled

Procedure 24.7. Flushing a Cache

1. In the Cache Containers view, click on the name of the cache container.
2. The Caches view is displayed. Click on the cache to be cleared.
   

   Figure 24.35. Caches View

3. The cache statistics page is displayed. At the right hand side, click Actions.
   

   Figure 24.36. Actions Button

4. From the Actions menu, click Flush.
   

   Figure 24.37. Actions Menu

5. A confirmation dialogue box appears. Click Flush.
   

   Figure 24.38. Cache Flush Confirmation Box

6. The cache is successfully flushed. Click Ok.
   

   Figure 24.39. Cache Flush Information Box

Procedure 24.8. Clearing a Cache

1. In the Cache Containers view, click on the name of the cache container.
2. The Caches view is displayed. Click on the cache to be cleared.
   

   Figure 24.40. Caches View

3. On the cache statistics page, at the right hand side, click Actions.
   

   Figure 24.41. 

4. From the Actions menu, click Clear.
   

   Figure 24.42. Clear Button

5. A confirmation dialogue box appears. Click Clear.
   

   Figure 24.43. Confirmation Box

6. The cache is successfully flushed. Click Ok.
   

   Figure 24.44. Information Box