4.5. Configure Expiration

Procedure 4.1. Configure Expiration in Library Mode

1. Add the Expiration Tag

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

   <expiration />

2. Set the Expiration Lifespan

   Set the lifespan value to set the period of time (in milliseconds) an entry can remain in memory. The following is an example of this step:

   <expiration lifespan="1000" />

3. Set the Maximum Idle Time

   Set the time that entries are allowed to remain idle (unused) after which they are removed (in milliseconds). The default value is -1 for unlimited time.

   <expiration lifespan="1000" maxIdle="1000" />

4. Set the Background Reaper Thread

   Enable or disable the background reaper thread to test entries for expiration. Regardless of whether a reaper is used, entries are tested for expiration lazily when they are touched. The default value is true.

   <expiration lifespan="1000" maxIdle="1000" reaperEnabled="true" />

5. Set the Expiration Interval

   Set the interval (in milliseconds) between subsequent runs to purge expired entries from memory and any associated cache stores. To disable the periodic eviction process set the interval to -1. The default value is 1000.

   <expiration lifespan="1000" maxIdle="1000" reaperEnabled="true" wakeUpInterval="5000" />

Procedure 4.2. Configuration Expiration in Remote Client-Server Mode

1. Set the Expiration Lifespan

   Set the lifespan value to set the period of time (in milliseconds) an entry can remain in memory. The following is an example of this step:

   <expiration lifespan="1000" />

2. Set the Maximum Idle Time

   Set the time that entries are allowed to remain idle (unused) after which they are removed (in milliseconds). The default value is -1 for unlimited time.

   <expiration lifespan="1000" max-idle="1000" />

3. Set the Expiration Interval

   Set the interval (in milliseconds) between subsequent runs to purge expired entries from memory and any associated cache stores. To disable the periodic eviction process set the interval to -1. The default value is 5000.

   <expiration lifespan="1000" max-idle="1000" interval="10000" />

4. Reaper Thread in Remote Client-Server Mode

   In Remote Client-Server Mode the background reaper thread is only enabled if interval is greater than 0. As interval defaults to 5000 the background reaper thread is automatically enabled if expiration is configured.